Class AnalyticsAdminServiceClientImpl

AnalyticsAdminService client wrapper implementation, for convenient use.

Inheritance
object
AnalyticsAdminServiceClient
AnalyticsAdminServiceClientImpl
Inherited Members
Namespace: Google.Analytics.Admin.V1Beta
Assembly: Google.Analytics.Admin.V1Beta.dll
Syntax
public sealed class AnalyticsAdminServiceClientImpl : AnalyticsAdminServiceClient
Remarks

Service Interface for the Analytics Admin API (GA4).

Constructors

AnalyticsAdminServiceClientImpl(AnalyticsAdminServiceClient, AnalyticsAdminServiceSettings, ILogger)

Constructs a client wrapper for the AnalyticsAdminService service, with the specified gRPC client and settings.

Declaration
public AnalyticsAdminServiceClientImpl(AnalyticsAdminService.AnalyticsAdminServiceClient grpcClient, AnalyticsAdminServiceSettings settings, ILogger logger)
Parameters
Type Name Description
AnalyticsAdminService.AnalyticsAdminServiceClient grpcClient

The underlying gRPC client.
AnalyticsAdminServiceSettings settings

The base AnalyticsAdminServiceSettings used within this client.
ILogger logger

Optional ILogger to use within this client.

Properties

GrpcClient

The underlying gRPC AnalyticsAdminService client

Declaration
public override AnalyticsAdminService.AnalyticsAdminServiceClient GrpcClient { get; }
Property Value
Type Description
AnalyticsAdminService.AnalyticsAdminServiceClient
Overrides

Methods

AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest, CallSettings)

Acknowledges the terms of user data collection for the specified property.

This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.

Declaration
public override AcknowledgeUserDataCollectionResponse AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
AcknowledgeUserDataCollectionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AcknowledgeUserDataCollectionResponse

The RPC response.
Overrides

AcknowledgeUserDataCollectionAsync(AcknowledgeUserDataCollectionRequest, CallSettings)

Acknowledges the terms of user data collection for the specified property.

This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.

Declaration
public override Task<AcknowledgeUserDataCollectionResponse> AcknowledgeUserDataCollectionAsync(AcknowledgeUserDataCollectionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
AcknowledgeUserDataCollectionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<AcknowledgeUserDataCollectionResponse>

A Task containing the RPC response.
Overrides

ArchiveCustomDimension(ArchiveCustomDimensionRequest, CallSettings)

Archives a CustomDimension on a property.

Declaration
public override void ArchiveCustomDimension(ArchiveCustomDimensionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ArchiveCustomDimensionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

ArchiveCustomDimensionAsync(ArchiveCustomDimensionRequest, CallSettings)

Archives a CustomDimension on a property.

Declaration
public override Task ArchiveCustomDimensionAsync(ArchiveCustomDimensionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ArchiveCustomDimensionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

ArchiveCustomMetric(ArchiveCustomMetricRequest, CallSettings)

Archives a CustomMetric on a property.

Declaration
public override void ArchiveCustomMetric(ArchiveCustomMetricRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ArchiveCustomMetricRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

ArchiveCustomMetricAsync(ArchiveCustomMetricRequest, CallSettings)

Archives a CustomMetric on a property.

Declaration
public override Task ArchiveCustomMetricAsync(ArchiveCustomMetricRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ArchiveCustomMetricRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

CreateConversionEvent(CreateConversionEventRequest, CallSettings)

Deprecated: Use CreateKeyEvent instead. Creates a conversion event with the specified attributes.

Declaration
[Obsolete]
public override ConversionEvent CreateConversionEvent(CreateConversionEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateConversionEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ConversionEvent

The RPC response.
Overrides

CreateConversionEventAsync(CreateConversionEventRequest, CallSettings)

Deprecated: Use CreateKeyEvent instead. Creates a conversion event with the specified attributes.

Declaration
[Obsolete]
public override Task<ConversionEvent> CreateConversionEventAsync(CreateConversionEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateConversionEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<ConversionEvent>

A Task containing the RPC response.
Overrides

CreateCustomDimension(CreateCustomDimensionRequest, CallSettings)

Creates a CustomDimension.

Declaration
public override CustomDimension CreateCustomDimension(CreateCustomDimensionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateCustomDimensionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CustomDimension

The RPC response.
Overrides

CreateCustomDimensionAsync(CreateCustomDimensionRequest, CallSettings)

Creates a CustomDimension.

Declaration
public override Task<CustomDimension> CreateCustomDimensionAsync(CreateCustomDimensionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateCustomDimensionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<CustomDimension>

A Task containing the RPC response.
Overrides

CreateCustomMetric(CreateCustomMetricRequest, CallSettings)

Creates a CustomMetric.

Declaration
public override CustomMetric CreateCustomMetric(CreateCustomMetricRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateCustomMetricRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CustomMetric

The RPC response.
Overrides

CreateCustomMetricAsync(CreateCustomMetricRequest, CallSettings)

Creates a CustomMetric.

Declaration
public override Task<CustomMetric> CreateCustomMetricAsync(CreateCustomMetricRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateCustomMetricRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<CustomMetric>

A Task containing the RPC response.
Overrides

CreateDataStream(CreateDataStreamRequest, CallSettings)

Creates a DataStream.

Declaration
public override DataStream CreateDataStream(CreateDataStreamRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateDataStreamRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataStream

The RPC response.
Overrides

CreateDataStreamAsync(CreateDataStreamRequest, CallSettings)

Creates a DataStream.

Declaration
public override Task<DataStream> CreateDataStreamAsync(CreateDataStreamRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateDataStreamRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<DataStream>

A Task containing the RPC response.
Overrides

CreateFirebaseLink(CreateFirebaseLinkRequest, CallSettings)

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Declaration
public override FirebaseLink CreateFirebaseLink(CreateFirebaseLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateFirebaseLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FirebaseLink

The RPC response.
Overrides

CreateFirebaseLinkAsync(CreateFirebaseLinkRequest, CallSettings)

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Declaration
public override Task<FirebaseLink> CreateFirebaseLinkAsync(CreateFirebaseLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateFirebaseLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<FirebaseLink>

A Task containing the RPC response.
Overrides

CreateGoogleAdsLink(CreateGoogleAdsLinkRequest, CallSettings)

Creates a GoogleAdsLink.

Declaration
public override GoogleAdsLink CreateGoogleAdsLink(CreateGoogleAdsLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateGoogleAdsLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GoogleAdsLink

The RPC response.
Overrides

CreateGoogleAdsLinkAsync(CreateGoogleAdsLinkRequest, CallSettings)

Creates a GoogleAdsLink.

Declaration
public override Task<GoogleAdsLink> CreateGoogleAdsLinkAsync(CreateGoogleAdsLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateGoogleAdsLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<GoogleAdsLink>

A Task containing the RPC response.
Overrides

CreateKeyEvent(CreateKeyEventRequest, CallSettings)

Creates a Key Event.

Declaration
public override KeyEvent CreateKeyEvent(CreateKeyEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateKeyEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
KeyEvent

The RPC response.
Overrides

CreateKeyEventAsync(CreateKeyEventRequest, CallSettings)

Creates a Key Event.

Declaration
public override Task<KeyEvent> CreateKeyEventAsync(CreateKeyEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateKeyEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<KeyEvent>

A Task containing the RPC response.
Overrides

CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest, CallSettings)

Creates a measurement protocol secret.

Declaration
public override MeasurementProtocolSecret CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateMeasurementProtocolSecretRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
MeasurementProtocolSecret

The RPC response.
Overrides

CreateMeasurementProtocolSecretAsync(CreateMeasurementProtocolSecretRequest, CallSettings)

Creates a measurement protocol secret.

Declaration
public override Task<MeasurementProtocolSecret> CreateMeasurementProtocolSecretAsync(CreateMeasurementProtocolSecretRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateMeasurementProtocolSecretRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<MeasurementProtocolSecret>

A Task containing the RPC response.
Overrides

CreateProperty(CreatePropertyRequest, CallSettings)

Creates an "GA4" property with the specified location and attributes.

Declaration
public override Property CreateProperty(CreatePropertyRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreatePropertyRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Property

The RPC response.
Overrides

CreatePropertyAsync(CreatePropertyRequest, CallSettings)

Creates an "GA4" property with the specified location and attributes.

Declaration
public override Task<Property> CreatePropertyAsync(CreatePropertyRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreatePropertyRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Property>

A Task containing the RPC response.
Overrides

DeleteAccount(DeleteAccountRequest, CallSettings)

Marks target Account as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.

If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found.

Declaration
public override void DeleteAccount(DeleteAccountRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteAccountRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteAccountAsync(DeleteAccountRequest, CallSettings)

Marks target Account as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.

If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found.

Declaration
public override Task DeleteAccountAsync(DeleteAccountRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteAccountRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteConversionEvent(DeleteConversionEventRequest, CallSettings)

Deprecated: Use DeleteKeyEvent instead. Deletes a conversion event in a property.

Declaration
[Obsolete]
public override void DeleteConversionEvent(DeleteConversionEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteConversionEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteConversionEventAsync(DeleteConversionEventRequest, CallSettings)

Deprecated: Use DeleteKeyEvent instead. Deletes a conversion event in a property.

Declaration
[Obsolete]
public override Task DeleteConversionEventAsync(DeleteConversionEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteConversionEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteDataStream(DeleteDataStreamRequest, CallSettings)

Deletes a DataStream on a property.

Declaration
public override void DeleteDataStream(DeleteDataStreamRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteDataStreamRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteDataStreamAsync(DeleteDataStreamRequest, CallSettings)

Deletes a DataStream on a property.

Declaration
public override Task DeleteDataStreamAsync(DeleteDataStreamRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteDataStreamRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteFirebaseLink(DeleteFirebaseLinkRequest, CallSettings)

Deletes a FirebaseLink on a property

Declaration
public override void DeleteFirebaseLink(DeleteFirebaseLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteFirebaseLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteFirebaseLinkAsync(DeleteFirebaseLinkRequest, CallSettings)

Deletes a FirebaseLink on a property

Declaration
public override Task DeleteFirebaseLinkAsync(DeleteFirebaseLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteFirebaseLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteGoogleAdsLink(DeleteGoogleAdsLinkRequest, CallSettings)

Deletes a GoogleAdsLink on a property

Declaration
public override void DeleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteGoogleAdsLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteGoogleAdsLinkAsync(DeleteGoogleAdsLinkRequest, CallSettings)

Deletes a GoogleAdsLink on a property

Declaration
public override Task DeleteGoogleAdsLinkAsync(DeleteGoogleAdsLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteGoogleAdsLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteKeyEvent(DeleteKeyEventRequest, CallSettings)

Deletes a Key Event.

Declaration
public override void DeleteKeyEvent(DeleteKeyEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteKeyEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteKeyEventAsync(DeleteKeyEventRequest, CallSettings)

Deletes a Key Event.

Declaration
public override Task DeleteKeyEventAsync(DeleteKeyEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteKeyEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest, CallSettings)

Deletes target MeasurementProtocolSecret.

Declaration
public override void DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteMeasurementProtocolSecretRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteMeasurementProtocolSecretAsync(DeleteMeasurementProtocolSecretRequest, CallSettings)

Deletes target MeasurementProtocolSecret.

Declaration
public override Task DeleteMeasurementProtocolSecretAsync(DeleteMeasurementProtocolSecretRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteMeasurementProtocolSecretRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteProperty(DeletePropertyRequest, CallSettings)

Marks target Property as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.

If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found, or is not a GA4 Property.

Declaration
public override Property DeleteProperty(DeletePropertyRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeletePropertyRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Property

The RPC response.
Overrides

DeletePropertyAsync(DeletePropertyRequest, CallSettings)

Marks target Property as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.

If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found, or is not a GA4 Property.

Declaration
public override Task<Property> DeletePropertyAsync(DeletePropertyRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeletePropertyRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Property>

A Task containing the RPC response.
Overrides

GetAccount(GetAccountRequest, CallSettings)

Lookup for a single Account.

Declaration
public override Account GetAccount(GetAccountRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetAccountRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Account

The RPC response.
Overrides

GetAccountAsync(GetAccountRequest, CallSettings)

Lookup for a single Account.

Declaration
public override Task<Account> GetAccountAsync(GetAccountRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetAccountRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Account>

A Task containing the RPC response.
Overrides

GetConversionEvent(GetConversionEventRequest, CallSettings)

Deprecated: Use GetKeyEvent instead. Retrieve a single conversion event.

Declaration
[Obsolete]
public override ConversionEvent GetConversionEvent(GetConversionEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetConversionEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ConversionEvent

The RPC response.
Overrides

GetConversionEventAsync(GetConversionEventRequest, CallSettings)

Deprecated: Use GetKeyEvent instead. Retrieve a single conversion event.

Declaration
[Obsolete]
public override Task<ConversionEvent> GetConversionEventAsync(GetConversionEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetConversionEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<ConversionEvent>

A Task containing the RPC response.
Overrides

GetCustomDimension(GetCustomDimensionRequest, CallSettings)

Lookup for a single CustomDimension.

Declaration
public override CustomDimension GetCustomDimension(GetCustomDimensionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetCustomDimensionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CustomDimension

The RPC response.
Overrides

GetCustomDimensionAsync(GetCustomDimensionRequest, CallSettings)

Lookup for a single CustomDimension.

Declaration
public override Task<CustomDimension> GetCustomDimensionAsync(GetCustomDimensionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetCustomDimensionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<CustomDimension>

A Task containing the RPC response.
Overrides

GetCustomMetric(GetCustomMetricRequest, CallSettings)

Lookup for a single CustomMetric.

Declaration
public override CustomMetric GetCustomMetric(GetCustomMetricRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetCustomMetricRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CustomMetric

The RPC response.
Overrides

GetCustomMetricAsync(GetCustomMetricRequest, CallSettings)

Lookup for a single CustomMetric.

Declaration
public override Task<CustomMetric> GetCustomMetricAsync(GetCustomMetricRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetCustomMetricRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<CustomMetric>

A Task containing the RPC response.
Overrides

GetDataRetentionSettings(GetDataRetentionSettingsRequest, CallSettings)

Returns the singleton data retention settings for this property.

Declaration
public override DataRetentionSettings GetDataRetentionSettings(GetDataRetentionSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDataRetentionSettingsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataRetentionSettings

The RPC response.
Overrides

GetDataRetentionSettingsAsync(GetDataRetentionSettingsRequest, CallSettings)

Returns the singleton data retention settings for this property.

Declaration
public override Task<DataRetentionSettings> GetDataRetentionSettingsAsync(GetDataRetentionSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDataRetentionSettingsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<DataRetentionSettings>

A Task containing the RPC response.
Overrides

GetDataSharingSettings(GetDataSharingSettingsRequest, CallSettings)

Get data sharing settings on an account. Data sharing settings are singletons.

Declaration
public override DataSharingSettings GetDataSharingSettings(GetDataSharingSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDataSharingSettingsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataSharingSettings

The RPC response.
Overrides

GetDataSharingSettingsAsync(GetDataSharingSettingsRequest, CallSettings)

Get data sharing settings on an account. Data sharing settings are singletons.

Declaration
public override Task<DataSharingSettings> GetDataSharingSettingsAsync(GetDataSharingSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDataSharingSettingsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<DataSharingSettings>

A Task containing the RPC response.
Overrides

GetDataStream(GetDataStreamRequest, CallSettings)

Lookup for a single DataStream.

Declaration
public override DataStream GetDataStream(GetDataStreamRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDataStreamRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataStream

The RPC response.
Overrides

GetDataStreamAsync(GetDataStreamRequest, CallSettings)

Lookup for a single DataStream.

Declaration
public override Task<DataStream> GetDataStreamAsync(GetDataStreamRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDataStreamRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<DataStream>

A Task containing the RPC response.
Overrides

GetKeyEvent(GetKeyEventRequest, CallSettings)

Retrieve a single Key Event.

Declaration
public override KeyEvent GetKeyEvent(GetKeyEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetKeyEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
KeyEvent

The RPC response.
Overrides

GetKeyEventAsync(GetKeyEventRequest, CallSettings)

Retrieve a single Key Event.

Declaration
public override Task<KeyEvent> GetKeyEventAsync(GetKeyEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetKeyEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<KeyEvent>

A Task containing the RPC response.
Overrides

GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest, CallSettings)

Lookup for a single "GA4" MeasurementProtocolSecret.

Declaration
public override MeasurementProtocolSecret GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetMeasurementProtocolSecretRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
MeasurementProtocolSecret

The RPC response.
Overrides

GetMeasurementProtocolSecretAsync(GetMeasurementProtocolSecretRequest, CallSettings)

Lookup for a single "GA4" MeasurementProtocolSecret.

Declaration
public override Task<MeasurementProtocolSecret> GetMeasurementProtocolSecretAsync(GetMeasurementProtocolSecretRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetMeasurementProtocolSecretRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<MeasurementProtocolSecret>

A Task containing the RPC response.
Overrides

GetProperty(GetPropertyRequest, CallSettings)

Lookup for a single "GA4" Property.

Declaration
public override Property GetProperty(GetPropertyRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetPropertyRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Property

The RPC response.
Overrides

GetPropertyAsync(GetPropertyRequest, CallSettings)

Lookup for a single "GA4" Property.

Declaration
public override Task<Property> GetPropertyAsync(GetPropertyRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetPropertyRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Property>

A Task containing the RPC response.
Overrides

ListAccountSummaries(ListAccountSummariesRequest, CallSettings)

Returns summaries of all accounts accessible by the caller.

Declaration
public override PagedEnumerable<ListAccountSummariesResponse, AccountSummary> ListAccountSummaries(ListAccountSummariesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAccountSummariesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListAccountSummariesResponse, AccountSummary>

A pageable sequence of AccountSummary resources.
Overrides

ListAccountSummariesAsync(ListAccountSummariesRequest, CallSettings)

Returns summaries of all accounts accessible by the caller.

Declaration
public override PagedAsyncEnumerable<ListAccountSummariesResponse, AccountSummary> ListAccountSummariesAsync(ListAccountSummariesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAccountSummariesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListAccountSummariesResponse, AccountSummary>

A pageable asynchronous sequence of AccountSummary resources.
Overrides

ListAccounts(ListAccountsRequest, CallSettings)

Returns all accounts accessible by the caller.

Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

Declaration
public override PagedEnumerable<ListAccountsResponse, Account> ListAccounts(ListAccountsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAccountsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListAccountsResponse, Account>

A pageable sequence of Account resources.
Overrides

ListAccountsAsync(ListAccountsRequest, CallSettings)

Returns all accounts accessible by the caller.

Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

Declaration
public override PagedAsyncEnumerable<ListAccountsResponse, Account> ListAccountsAsync(ListAccountsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAccountsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListAccountsResponse, Account>

A pageable asynchronous sequence of Account resources.
Overrides

ListConversionEvents(ListConversionEventsRequest, CallSettings)

Deprecated: Use ListKeyEvents instead. Returns a list of conversion events in the specified parent property.

Returns an empty list if no conversion events are found.

Declaration
[Obsolete]
public override PagedEnumerable<ListConversionEventsResponse, ConversionEvent> ListConversionEvents(ListConversionEventsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListConversionEventsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListConversionEventsResponse, ConversionEvent>

A pageable sequence of ConversionEvent resources.
Overrides

ListConversionEventsAsync(ListConversionEventsRequest, CallSettings)

Deprecated: Use ListKeyEvents instead. Returns a list of conversion events in the specified parent property.

Returns an empty list if no conversion events are found.

Declaration
[Obsolete]
public override PagedAsyncEnumerable<ListConversionEventsResponse, ConversionEvent> ListConversionEventsAsync(ListConversionEventsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListConversionEventsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListConversionEventsResponse, ConversionEvent>

A pageable asynchronous sequence of ConversionEvent resources.
Overrides

ListCustomDimensions(ListCustomDimensionsRequest, CallSettings)

Lists CustomDimensions on a property.

Declaration
public override PagedEnumerable<ListCustomDimensionsResponse, CustomDimension> ListCustomDimensions(ListCustomDimensionsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListCustomDimensionsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListCustomDimensionsResponse, CustomDimension>

A pageable sequence of CustomDimension resources.
Overrides

ListCustomDimensionsAsync(ListCustomDimensionsRequest, CallSettings)

Lists CustomDimensions on a property.

Declaration
public override PagedAsyncEnumerable<ListCustomDimensionsResponse, CustomDimension> ListCustomDimensionsAsync(ListCustomDimensionsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListCustomDimensionsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListCustomDimensionsResponse, CustomDimension>

A pageable asynchronous sequence of CustomDimension resources.
Overrides

ListCustomMetrics(ListCustomMetricsRequest, CallSettings)

Lists CustomMetrics on a property.

Declaration
public override PagedEnumerable<ListCustomMetricsResponse, CustomMetric> ListCustomMetrics(ListCustomMetricsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListCustomMetricsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListCustomMetricsResponse, CustomMetric>

A pageable sequence of CustomMetric resources.
Overrides

ListCustomMetricsAsync(ListCustomMetricsRequest, CallSettings)

Lists CustomMetrics on a property.

Declaration
public override PagedAsyncEnumerable<ListCustomMetricsResponse, CustomMetric> ListCustomMetricsAsync(ListCustomMetricsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListCustomMetricsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListCustomMetricsResponse, CustomMetric>

A pageable asynchronous sequence of CustomMetric resources.
Overrides

ListDataStreams(ListDataStreamsRequest, CallSettings)

Lists DataStreams on a property.

Declaration
public override PagedEnumerable<ListDataStreamsResponse, DataStream> ListDataStreams(ListDataStreamsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDataStreamsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListDataStreamsResponse, DataStream>

A pageable sequence of DataStream resources.
Overrides

ListDataStreamsAsync(ListDataStreamsRequest, CallSettings)

Lists DataStreams on a property.

Declaration
public override PagedAsyncEnumerable<ListDataStreamsResponse, DataStream> ListDataStreamsAsync(ListDataStreamsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDataStreamsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListDataStreamsResponse, DataStream>

A pageable asynchronous sequence of DataStream resources.
Overrides

ListFirebaseLinks(ListFirebaseLinksRequest, CallSettings)

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

Declaration
public override PagedEnumerable<ListFirebaseLinksResponse, FirebaseLink> ListFirebaseLinks(ListFirebaseLinksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListFirebaseLinksRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListFirebaseLinksResponse, FirebaseLink>

A pageable sequence of FirebaseLink resources.
Overrides

ListFirebaseLinksAsync(ListFirebaseLinksRequest, CallSettings)

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

Declaration
public override PagedAsyncEnumerable<ListFirebaseLinksResponse, FirebaseLink> ListFirebaseLinksAsync(ListFirebaseLinksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListFirebaseLinksRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListFirebaseLinksResponse, FirebaseLink>

A pageable asynchronous sequence of FirebaseLink resources.
Overrides

ListGoogleAdsLinks(ListGoogleAdsLinksRequest, CallSettings)

Lists GoogleAdsLinks on a property.

Declaration
public override PagedEnumerable<ListGoogleAdsLinksResponse, GoogleAdsLink> ListGoogleAdsLinks(ListGoogleAdsLinksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListGoogleAdsLinksRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListGoogleAdsLinksResponse, GoogleAdsLink>

A pageable sequence of GoogleAdsLink resources.
Overrides

ListGoogleAdsLinksAsync(ListGoogleAdsLinksRequest, CallSettings)

Lists GoogleAdsLinks on a property.

Declaration
public override PagedAsyncEnumerable<ListGoogleAdsLinksResponse, GoogleAdsLink> ListGoogleAdsLinksAsync(ListGoogleAdsLinksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListGoogleAdsLinksRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListGoogleAdsLinksResponse, GoogleAdsLink>

A pageable asynchronous sequence of GoogleAdsLink resources.
Overrides

ListKeyEvents(ListKeyEventsRequest, CallSettings)

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.

Declaration
public override PagedEnumerable<ListKeyEventsResponse, KeyEvent> ListKeyEvents(ListKeyEventsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListKeyEventsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListKeyEventsResponse, KeyEvent>

A pageable sequence of KeyEvent resources.
Overrides

ListKeyEventsAsync(ListKeyEventsRequest, CallSettings)

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.

Declaration
public override PagedAsyncEnumerable<ListKeyEventsResponse, KeyEvent> ListKeyEventsAsync(ListKeyEventsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListKeyEventsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListKeyEventsResponse, KeyEvent>

A pageable asynchronous sequence of KeyEvent resources.
Overrides

ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest, CallSettings)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Declaration
public override PagedEnumerable<ListMeasurementProtocolSecretsResponse, MeasurementProtocolSecret> ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListMeasurementProtocolSecretsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListMeasurementProtocolSecretsResponse, MeasurementProtocolSecret>

A pageable sequence of MeasurementProtocolSecret resources.
Overrides

ListMeasurementProtocolSecretsAsync(ListMeasurementProtocolSecretsRequest, CallSettings)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Declaration
public override PagedAsyncEnumerable<ListMeasurementProtocolSecretsResponse, MeasurementProtocolSecret> ListMeasurementProtocolSecretsAsync(ListMeasurementProtocolSecretsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListMeasurementProtocolSecretsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListMeasurementProtocolSecretsResponse, MeasurementProtocolSecret>

A pageable asynchronous sequence of MeasurementProtocolSecret resources.
Overrides

ListProperties(ListPropertiesRequest, CallSettings)

Returns child Properties under the specified parent Account.

Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.

Declaration
public override PagedEnumerable<ListPropertiesResponse, Property> ListProperties(ListPropertiesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListPropertiesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListPropertiesResponse, Property>

A pageable sequence of Property resources.
Overrides

ListPropertiesAsync(ListPropertiesRequest, CallSettings)

Returns child Properties under the specified parent Account.

Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.

Declaration
public override PagedAsyncEnumerable<ListPropertiesResponse, Property> ListPropertiesAsync(ListPropertiesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListPropertiesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListPropertiesResponse, Property>

A pageable asynchronous sequence of Property resources.
Overrides

ProvisionAccountTicket(ProvisionAccountTicketRequest, CallSettings)

Requests a ticket for creating an account.

Declaration
public override ProvisionAccountTicketResponse ProvisionAccountTicket(ProvisionAccountTicketRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ProvisionAccountTicketRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ProvisionAccountTicketResponse

The RPC response.
Overrides

ProvisionAccountTicketAsync(ProvisionAccountTicketRequest, CallSettings)

Requests a ticket for creating an account.

Declaration
public override Task<ProvisionAccountTicketResponse> ProvisionAccountTicketAsync(ProvisionAccountTicketRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ProvisionAccountTicketRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<ProvisionAccountTicketResponse>

A Task containing the RPC response.
Overrides

RunAccessReport(RunAccessReportRequest, CallSettings)

Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years.

Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators.

These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see searchChangeHistoryEvents.

Declaration
public override RunAccessReportResponse RunAccessReport(RunAccessReportRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
RunAccessReportRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RunAccessReportResponse

The RPC response.
Overrides

RunAccessReportAsync(RunAccessReportRequest, CallSettings)

Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years.

Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators.

These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see searchChangeHistoryEvents.

Declaration
public override Task<RunAccessReportResponse> RunAccessReportAsync(RunAccessReportRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
RunAccessReportRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<RunAccessReportResponse>

A Task containing the RPC response.
Overrides

SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest, CallSettings)

Searches through all changes to an account or its children given the specified set of filters.

Declaration
public override PagedEnumerable<SearchChangeHistoryEventsResponse, ChangeHistoryEvent> SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
SearchChangeHistoryEventsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<SearchChangeHistoryEventsResponse, ChangeHistoryEvent>

A pageable sequence of ChangeHistoryEvent resources.
Overrides

SearchChangeHistoryEventsAsync(SearchChangeHistoryEventsRequest, CallSettings)

Searches through all changes to an account or its children given the specified set of filters.

Declaration
public override PagedAsyncEnumerable<SearchChangeHistoryEventsResponse, ChangeHistoryEvent> SearchChangeHistoryEventsAsync(SearchChangeHistoryEventsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
SearchChangeHistoryEventsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<SearchChangeHistoryEventsResponse, ChangeHistoryEvent>

A pageable asynchronous sequence of ChangeHistoryEvent resources.
Overrides

UpdateAccount(UpdateAccountRequest, CallSettings)

Updates an account.

Declaration
public override Account UpdateAccount(UpdateAccountRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateAccountRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Account

The RPC response.
Overrides

UpdateAccountAsync(UpdateAccountRequest, CallSettings)

Updates an account.

Declaration
public override Task<Account> UpdateAccountAsync(UpdateAccountRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateAccountRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Account>

A Task containing the RPC response.
Overrides

UpdateConversionEvent(UpdateConversionEventRequest, CallSettings)

Deprecated: Use UpdateKeyEvent instead. Updates a conversion event with the specified attributes.

Declaration
[Obsolete]
public override ConversionEvent UpdateConversionEvent(UpdateConversionEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateConversionEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ConversionEvent

The RPC response.
Overrides

UpdateConversionEventAsync(UpdateConversionEventRequest, CallSettings)

Deprecated: Use UpdateKeyEvent instead. Updates a conversion event with the specified attributes.

Declaration
[Obsolete]
public override Task<ConversionEvent> UpdateConversionEventAsync(UpdateConversionEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateConversionEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<ConversionEvent>

A Task containing the RPC response.
Overrides

UpdateCustomDimension(UpdateCustomDimensionRequest, CallSettings)

Updates a CustomDimension on a property.

Declaration
public override CustomDimension UpdateCustomDimension(UpdateCustomDimensionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateCustomDimensionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CustomDimension

The RPC response.
Overrides

UpdateCustomDimensionAsync(UpdateCustomDimensionRequest, CallSettings)

Updates a CustomDimension on a property.

Declaration
public override Task<CustomDimension> UpdateCustomDimensionAsync(UpdateCustomDimensionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateCustomDimensionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<CustomDimension>

A Task containing the RPC response.
Overrides

UpdateCustomMetric(UpdateCustomMetricRequest, CallSettings)

Updates a CustomMetric on a property.

Declaration
public override CustomMetric UpdateCustomMetric(UpdateCustomMetricRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateCustomMetricRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CustomMetric

The RPC response.
Overrides

UpdateCustomMetricAsync(UpdateCustomMetricRequest, CallSettings)

Updates a CustomMetric on a property.

Declaration
public override Task<CustomMetric> UpdateCustomMetricAsync(UpdateCustomMetricRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateCustomMetricRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<CustomMetric>

A Task containing the RPC response.
Overrides

UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest, CallSettings)

Updates the singleton data retention settings for this property.

Declaration
public override DataRetentionSettings UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateDataRetentionSettingsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataRetentionSettings

The RPC response.
Overrides

UpdateDataRetentionSettingsAsync(UpdateDataRetentionSettingsRequest, CallSettings)

Updates the singleton data retention settings for this property.

Declaration
public override Task<DataRetentionSettings> UpdateDataRetentionSettingsAsync(UpdateDataRetentionSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateDataRetentionSettingsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<DataRetentionSettings>

A Task containing the RPC response.
Overrides

UpdateDataStream(UpdateDataStreamRequest, CallSettings)

Updates a DataStream on a property.

Declaration
public override DataStream UpdateDataStream(UpdateDataStreamRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateDataStreamRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataStream

The RPC response.
Overrides

UpdateDataStreamAsync(UpdateDataStreamRequest, CallSettings)

Updates a DataStream on a property.

Declaration
public override Task<DataStream> UpdateDataStreamAsync(UpdateDataStreamRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateDataStreamRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<DataStream>

A Task containing the RPC response.
Overrides

UpdateGoogleAdsLink(UpdateGoogleAdsLinkRequest, CallSettings)

Updates a GoogleAdsLink on a property

Declaration
public override GoogleAdsLink UpdateGoogleAdsLink(UpdateGoogleAdsLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateGoogleAdsLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GoogleAdsLink

The RPC response.
Overrides

UpdateGoogleAdsLinkAsync(UpdateGoogleAdsLinkRequest, CallSettings)

Updates a GoogleAdsLink on a property

Declaration
public override Task<GoogleAdsLink> UpdateGoogleAdsLinkAsync(UpdateGoogleAdsLinkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateGoogleAdsLinkRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<GoogleAdsLink>

A Task containing the RPC response.
Overrides

UpdateKeyEvent(UpdateKeyEventRequest, CallSettings)

Updates a Key Event.

Declaration
public override KeyEvent UpdateKeyEvent(UpdateKeyEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateKeyEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
KeyEvent

The RPC response.
Overrides

UpdateKeyEventAsync(UpdateKeyEventRequest, CallSettings)

Updates a Key Event.

Declaration
public override Task<KeyEvent> UpdateKeyEventAsync(UpdateKeyEventRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateKeyEventRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<KeyEvent>

A Task containing the RPC response.
Overrides

UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest, CallSettings)

Updates a measurement protocol secret.

Declaration
public override MeasurementProtocolSecret UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateMeasurementProtocolSecretRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
MeasurementProtocolSecret

The RPC response.
Overrides

UpdateMeasurementProtocolSecretAsync(UpdateMeasurementProtocolSecretRequest, CallSettings)

Updates a measurement protocol secret.

Declaration
public override Task<MeasurementProtocolSecret> UpdateMeasurementProtocolSecretAsync(UpdateMeasurementProtocolSecretRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateMeasurementProtocolSecretRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<MeasurementProtocolSecret>

A Task containing the RPC response.
Overrides

UpdateProperty(UpdatePropertyRequest, CallSettings)

Updates a property.

Declaration
public override Property UpdateProperty(UpdatePropertyRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdatePropertyRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Property

The RPC response.
Overrides

UpdatePropertyAsync(UpdatePropertyRequest, CallSettings)

Updates a property.

Declaration
public override Task<Property> UpdatePropertyAsync(UpdatePropertyRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdatePropertyRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Property>

A Task containing the RPC response.
Overrides