Class AnalyticsAdminService.AnalyticsAdminServiceBase
Base class for server-side implementations of AnalyticsAdminService
Namespace: Google.Analytics.Admin.V1Beta
Assembly: Google.Analytics.Admin.V1Beta.dll
Syntax
[BindServiceMethod(typeof(AnalyticsAdminService), "BindService")]
public abstract class AnalyticsAdminService.AnalyticsAdminServiceBaseMethods
AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest, ServerCallContext)
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 virtual Task<AcknowledgeUserDataCollectionResponse> AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| AcknowledgeUserDataCollectionRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<AcknowledgeUserDataCollectionResponse> | The response to send back to the client (wrapped by a task). |
ArchiveCustomDimension(ArchiveCustomDimensionRequest, ServerCallContext)
Archives a CustomDimension on a property.
Declaration
public virtual Task<Empty> ArchiveCustomDimension(ArchiveCustomDimensionRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ArchiveCustomDimensionRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Empty> | The response to send back to the client (wrapped by a task). |
ArchiveCustomMetric(ArchiveCustomMetricRequest, ServerCallContext)
Archives a CustomMetric on a property.
Declaration
public virtual Task<Empty> ArchiveCustomMetric(ArchiveCustomMetricRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ArchiveCustomMetricRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Empty> | The response to send back to the client (wrapped by a task). |
CreateConversionEvent(CreateConversionEventRequest, ServerCallContext)
Deprecated: Use CreateKeyEvent instead.
Creates a conversion event with the specified attributes.
Declaration
[Obsolete]
public virtual Task<ConversionEvent> CreateConversionEvent(CreateConversionEventRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateConversionEventRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ConversionEvent> | The response to send back to the client (wrapped by a task). |
CreateCustomDimension(CreateCustomDimensionRequest, ServerCallContext)
Creates a CustomDimension.
Declaration
public virtual Task<CustomDimension> CreateCustomDimension(CreateCustomDimensionRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateCustomDimensionRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<CustomDimension> | The response to send back to the client (wrapped by a task). |
CreateCustomMetric(CreateCustomMetricRequest, ServerCallContext)
Creates a CustomMetric.
Declaration
public virtual Task<CustomMetric> CreateCustomMetric(CreateCustomMetricRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateCustomMetricRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<CustomMetric> | The response to send back to the client (wrapped by a task). |
CreateDataStream(CreateDataStreamRequest, ServerCallContext)
Creates a DataStream.
Declaration
public virtual Task<DataStream> CreateDataStream(CreateDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateDataStreamRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<DataStream> | The response to send back to the client (wrapped by a task). |
CreateFirebaseLink(CreateFirebaseLinkRequest, ServerCallContext)
Creates a FirebaseLink.
Properties can have at most one FirebaseLink.
Declaration
public virtual Task<FirebaseLink> CreateFirebaseLink(CreateFirebaseLinkRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateFirebaseLinkRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<FirebaseLink> | The response to send back to the client (wrapped by a task). |
CreateGoogleAdsLink(CreateGoogleAdsLinkRequest, ServerCallContext)
Creates a GoogleAdsLink.
Declaration
public virtual Task<GoogleAdsLink> CreateGoogleAdsLink(CreateGoogleAdsLinkRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateGoogleAdsLinkRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<GoogleAdsLink> | The response to send back to the client (wrapped by a task). |
CreateKeyEvent(CreateKeyEventRequest, ServerCallContext)
Creates a Key Event.
Declaration
public virtual Task<KeyEvent> CreateKeyEvent(CreateKeyEventRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateKeyEventRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<KeyEvent> | The response to send back to the client (wrapped by a task). |
CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest, ServerCallContext)
Creates a measurement protocol secret.
Declaration
public virtual Task<MeasurementProtocolSecret> CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateMeasurementProtocolSecretRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<MeasurementProtocolSecret> | The response to send back to the client (wrapped by a task). |
CreateProperty(CreatePropertyRequest, ServerCallContext)
Creates an "GA4" property with the specified location and attributes.
Declaration
public virtual Task<Property> CreateProperty(CreatePropertyRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreatePropertyRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Property> | The response to send back to the client (wrapped by a task). |
DeleteAccount(DeleteAccountRequest, ServerCallContext)
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 virtual Task<Empty> DeleteAccount(DeleteAccountRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteAccountRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteConversionEvent(DeleteConversionEventRequest, ServerCallContext)
Deprecated: Use DeleteKeyEvent instead.
Deletes a conversion event in a property.
Declaration
[Obsolete]
public virtual Task<Empty> DeleteConversionEvent(DeleteConversionEventRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteConversionEventRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteDataStream(DeleteDataStreamRequest, ServerCallContext)
Deletes a DataStream on a property.
Declaration
public virtual Task<Empty> DeleteDataStream(DeleteDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteDataStreamRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteFirebaseLink(DeleteFirebaseLinkRequest, ServerCallContext)
Deletes a FirebaseLink on a property
Declaration
public virtual Task<Empty> DeleteFirebaseLink(DeleteFirebaseLinkRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteFirebaseLinkRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteGoogleAdsLink(DeleteGoogleAdsLinkRequest, ServerCallContext)
Deletes a GoogleAdsLink on a property
Declaration
public virtual Task<Empty> DeleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteGoogleAdsLinkRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteKeyEvent(DeleteKeyEventRequest, ServerCallContext)
Deletes a Key Event.
Declaration
public virtual Task<Empty> DeleteKeyEvent(DeleteKeyEventRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteKeyEventRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest, ServerCallContext)
Deletes target MeasurementProtocolSecret.
Declaration
public virtual Task<Empty> DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteMeasurementProtocolSecretRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteProperty(DeletePropertyRequest, ServerCallContext)
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 virtual Task<Property> DeleteProperty(DeletePropertyRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeletePropertyRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Property> | The response to send back to the client (wrapped by a task). |
GetAccount(GetAccountRequest, ServerCallContext)
Lookup for a single Account.
Declaration
public virtual Task<Account> GetAccount(GetAccountRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetAccountRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Account> | The response to send back to the client (wrapped by a task). |
GetConversionEvent(GetConversionEventRequest, ServerCallContext)
Deprecated: Use GetKeyEvent instead.
Retrieve a single conversion event.
Declaration
[Obsolete]
public virtual Task<ConversionEvent> GetConversionEvent(GetConversionEventRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetConversionEventRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ConversionEvent> | The response to send back to the client (wrapped by a task). |
GetCustomDimension(GetCustomDimensionRequest, ServerCallContext)
Lookup for a single CustomDimension.
Declaration
public virtual Task<CustomDimension> GetCustomDimension(GetCustomDimensionRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetCustomDimensionRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<CustomDimension> | The response to send back to the client (wrapped by a task). |
GetCustomMetric(GetCustomMetricRequest, ServerCallContext)
Lookup for a single CustomMetric.
Declaration
public virtual Task<CustomMetric> GetCustomMetric(GetCustomMetricRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetCustomMetricRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<CustomMetric> | The response to send back to the client (wrapped by a task). |
GetDataRetentionSettings(GetDataRetentionSettingsRequest, ServerCallContext)
Returns the singleton data retention settings for this property.
Declaration
public virtual Task<DataRetentionSettings> GetDataRetentionSettings(GetDataRetentionSettingsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetDataRetentionSettingsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<DataRetentionSettings> | The response to send back to the client (wrapped by a task). |
GetDataSharingSettings(GetDataSharingSettingsRequest, ServerCallContext)
Get data sharing settings on an account. Data sharing settings are singletons.
Declaration
public virtual Task<DataSharingSettings> GetDataSharingSettings(GetDataSharingSettingsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetDataSharingSettingsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<DataSharingSettings> | The response to send back to the client (wrapped by a task). |
GetDataStream(GetDataStreamRequest, ServerCallContext)
Lookup for a single DataStream.
Declaration
public virtual Task<DataStream> GetDataStream(GetDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetDataStreamRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<DataStream> | The response to send back to the client (wrapped by a task). |
GetKeyEvent(GetKeyEventRequest, ServerCallContext)
Retrieve a single Key Event.
Declaration
public virtual Task<KeyEvent> GetKeyEvent(GetKeyEventRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetKeyEventRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<KeyEvent> | The response to send back to the client (wrapped by a task). |
GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest, ServerCallContext)
Lookup for a single "GA4" MeasurementProtocolSecret.
Declaration
public virtual Task<MeasurementProtocolSecret> GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetMeasurementProtocolSecretRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<MeasurementProtocolSecret> | The response to send back to the client (wrapped by a task). |
GetProperty(GetPropertyRequest, ServerCallContext)
Lookup for a single "GA4" Property.
Declaration
public virtual Task<Property> GetProperty(GetPropertyRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetPropertyRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Property> | The response to send back to the client (wrapped by a task). |
ListAccountSummaries(ListAccountSummariesRequest, ServerCallContext)
Returns summaries of all accounts accessible by the caller.
Declaration
public virtual Task<ListAccountSummariesResponse> ListAccountSummaries(ListAccountSummariesRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListAccountSummariesRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListAccountSummariesResponse> | The response to send back to the client (wrapped by a task). |
ListAccounts(ListAccountsRequest, ServerCallContext)
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 virtual Task<ListAccountsResponse> ListAccounts(ListAccountsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListAccountsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListAccountsResponse> | The response to send back to the client (wrapped by a task). |
ListConversionEvents(ListConversionEventsRequest, ServerCallContext)
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 virtual Task<ListConversionEventsResponse> ListConversionEvents(ListConversionEventsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListConversionEventsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListConversionEventsResponse> | The response to send back to the client (wrapped by a task). |
ListCustomDimensions(ListCustomDimensionsRequest, ServerCallContext)
Lists CustomDimensions on a property.
Declaration
public virtual Task<ListCustomDimensionsResponse> ListCustomDimensions(ListCustomDimensionsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListCustomDimensionsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListCustomDimensionsResponse> | The response to send back to the client (wrapped by a task). |
ListCustomMetrics(ListCustomMetricsRequest, ServerCallContext)
Lists CustomMetrics on a property.
Declaration
public virtual Task<ListCustomMetricsResponse> ListCustomMetrics(ListCustomMetricsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListCustomMetricsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListCustomMetricsResponse> | The response to send back to the client (wrapped by a task). |
ListDataStreams(ListDataStreamsRequest, ServerCallContext)
Lists DataStreams on a property.
Declaration
public virtual Task<ListDataStreamsResponse> ListDataStreams(ListDataStreamsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListDataStreamsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListDataStreamsResponse> | The response to send back to the client (wrapped by a task). |
ListFirebaseLinks(ListFirebaseLinksRequest, ServerCallContext)
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
Declaration
public virtual Task<ListFirebaseLinksResponse> ListFirebaseLinks(ListFirebaseLinksRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListFirebaseLinksRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListFirebaseLinksResponse> | The response to send back to the client (wrapped by a task). |
ListGoogleAdsLinks(ListGoogleAdsLinksRequest, ServerCallContext)
Lists GoogleAdsLinks on a property.
Declaration
public virtual Task<ListGoogleAdsLinksResponse> ListGoogleAdsLinks(ListGoogleAdsLinksRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListGoogleAdsLinksRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListGoogleAdsLinksResponse> | The response to send back to the client (wrapped by a task). |
ListKeyEvents(ListKeyEventsRequest, ServerCallContext)
Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.
Declaration
public virtual Task<ListKeyEventsResponse> ListKeyEvents(ListKeyEventsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListKeyEventsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListKeyEventsResponse> | The response to send back to the client (wrapped by a task). |
ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest, ServerCallContext)
Returns child MeasurementProtocolSecrets under the specified parent Property.
Declaration
public virtual Task<ListMeasurementProtocolSecretsResponse> ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListMeasurementProtocolSecretsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListMeasurementProtocolSecretsResponse> | The response to send back to the client (wrapped by a task). |
ListProperties(ListPropertiesRequest, ServerCallContext)
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 virtual Task<ListPropertiesResponse> ListProperties(ListPropertiesRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListPropertiesRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListPropertiesResponse> | The response to send back to the client (wrapped by a task). |
ProvisionAccountTicket(ProvisionAccountTicketRequest, ServerCallContext)
Requests a ticket for creating an account.
Declaration
public virtual Task<ProvisionAccountTicketResponse> ProvisionAccountTicket(ProvisionAccountTicketRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ProvisionAccountTicketRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ProvisionAccountTicketResponse> | The response to send back to the client (wrapped by a task). |
RunAccessReport(RunAccessReportRequest, ServerCallContext)
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 virtual Task<RunAccessReportResponse> RunAccessReport(RunAccessReportRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| RunAccessReportRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<RunAccessReportResponse> | The response to send back to the client (wrapped by a task). |
SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest, ServerCallContext)
Searches through all changes to an account or its children given the specified set of filters.
Declaration
public virtual Task<SearchChangeHistoryEventsResponse> SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| SearchChangeHistoryEventsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<SearchChangeHistoryEventsResponse> | The response to send back to the client (wrapped by a task). |
UpdateAccount(UpdateAccountRequest, ServerCallContext)
Updates an account.
Declaration
public virtual Task<Account> UpdateAccount(UpdateAccountRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateAccountRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Account> | The response to send back to the client (wrapped by a task). |
UpdateConversionEvent(UpdateConversionEventRequest, ServerCallContext)
Deprecated: Use UpdateKeyEvent instead.
Updates a conversion event with the specified attributes.
Declaration
[Obsolete]
public virtual Task<ConversionEvent> UpdateConversionEvent(UpdateConversionEventRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateConversionEventRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ConversionEvent> | The response to send back to the client (wrapped by a task). |
UpdateCustomDimension(UpdateCustomDimensionRequest, ServerCallContext)
Updates a CustomDimension on a property.
Declaration
public virtual Task<CustomDimension> UpdateCustomDimension(UpdateCustomDimensionRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateCustomDimensionRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<CustomDimension> | The response to send back to the client (wrapped by a task). |
UpdateCustomMetric(UpdateCustomMetricRequest, ServerCallContext)
Updates a CustomMetric on a property.
Declaration
public virtual Task<CustomMetric> UpdateCustomMetric(UpdateCustomMetricRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateCustomMetricRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<CustomMetric> | The response to send back to the client (wrapped by a task). |
UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest, ServerCallContext)
Updates the singleton data retention settings for this property.
Declaration
public virtual Task<DataRetentionSettings> UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateDataRetentionSettingsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<DataRetentionSettings> | The response to send back to the client (wrapped by a task). |
UpdateDataStream(UpdateDataStreamRequest, ServerCallContext)
Updates a DataStream on a property.
Declaration
public virtual Task<DataStream> UpdateDataStream(UpdateDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateDataStreamRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<DataStream> | The response to send back to the client (wrapped by a task). |
UpdateGoogleAdsLink(UpdateGoogleAdsLinkRequest, ServerCallContext)
Updates a GoogleAdsLink on a property
Declaration
public virtual Task<GoogleAdsLink> UpdateGoogleAdsLink(UpdateGoogleAdsLinkRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateGoogleAdsLinkRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<GoogleAdsLink> | The response to send back to the client (wrapped by a task). |
UpdateKeyEvent(UpdateKeyEventRequest, ServerCallContext)
Updates a Key Event.
Declaration
public virtual Task<KeyEvent> UpdateKeyEvent(UpdateKeyEventRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateKeyEventRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<KeyEvent> | The response to send back to the client (wrapped by a task). |
UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest, ServerCallContext)
Updates a measurement protocol secret.
Declaration
public virtual Task<MeasurementProtocolSecret> UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateMeasurementProtocolSecretRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<MeasurementProtocolSecret> | The response to send back to the client (wrapped by a task). |
UpdateProperty(UpdatePropertyRequest, ServerCallContext)
Updates a property.
Declaration
public virtual Task<Property> UpdateProperty(UpdatePropertyRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdatePropertyRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Property> | The response to send back to the client (wrapped by a task). |