Class AnalyticsAdminService.AnalyticsAdminServiceBase
Base class for server-side implementations of AnalyticsAdminService
Inheritance
Inherited Members
Namespace: Google.Analytics.Admin.V1Alpha
Assembly: Google.Analytics.Admin.V1Alpha.dll
Syntax
[BindServiceMethod(typeof(AnalyticsAdminService), "BindService")]
public abstract class AnalyticsAdminServiceBaseMethods
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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.Empty> | The response to send back to the client (wrapped by a task). |
AuditUserLinks(AuditUserLinksRequest, ServerCallContext)
Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles.
If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.
Declaration
public virtual Task<AuditUserLinksResponse> AuditUserLinks(AuditUserLinksRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| AuditUserLinksRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AuditUserLinksResponse> | The response to send back to the client (wrapped by a task). |
BatchCreateUserLinks(BatchCreateUserLinksRequest, ServerCallContext)
Creates information about multiple users' links to an account or property.
This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.
Declaration
public virtual Task<BatchCreateUserLinksResponse> BatchCreateUserLinks(BatchCreateUserLinksRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| BatchCreateUserLinksRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BatchCreateUserLinksResponse> | The response to send back to the client (wrapped by a task). |
BatchDeleteUserLinks(BatchDeleteUserLinksRequest, ServerCallContext)
Deletes information about multiple users' links to an account or property.
Declaration
public virtual Task<Empty> BatchDeleteUserLinks(BatchDeleteUserLinksRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| BatchDeleteUserLinksRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.Empty> | The response to send back to the client (wrapped by a task). |
BatchGetUserLinks(BatchGetUserLinksRequest, ServerCallContext)
Gets information about multiple users' links to an account or property.
Declaration
public virtual Task<BatchGetUserLinksResponse> BatchGetUserLinks(BatchGetUserLinksRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| BatchGetUserLinksRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BatchGetUserLinksResponse> | The response to send back to the client (wrapped by a task). |
BatchUpdateUserLinks(BatchUpdateUserLinksRequest, ServerCallContext)
Updates information about multiple users' links to an account or property.
Declaration
public virtual Task<BatchUpdateUserLinksResponse> BatchUpdateUserLinks(BatchUpdateUserLinksRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| BatchUpdateUserLinksRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BatchUpdateUserLinksResponse> | The response to send back to the client (wrapped by a task). |
CreateConversionEvent(CreateConversionEventRequest, ServerCallContext)
Creates a conversion event with the specified attributes.
Declaration
public virtual Task<ConversionEvent> CreateConversionEvent(CreateConversionEventRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateConversionEventRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<CustomMetric> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GoogleAdsLink> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Property> | The response to send back to the client (wrapped by a task). |
CreateUserLink(CreateUserLinkRequest, ServerCallContext)
Creates a user link on an account or property.
If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.
Declaration
public virtual Task<UserLink> CreateUserLink(CreateUserLinkRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateUserLinkRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<UserLink> | The response to send back to the client (wrapped by a task). |
CreateWebDataStream(CreateWebDataStreamRequest, ServerCallContext)
Creates a web stream with the specified location and attributes.
Declaration
public virtual Task<WebDataStream> CreateWebDataStream(CreateWebDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateWebDataStreamRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<WebDataStream> | 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, UserLinks) 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.Empty> | The response to send back to the client (wrapped by a task). |
DeleteAndroidAppDataStream(DeleteAndroidAppDataStreamRequest, ServerCallContext)
Deletes an android app stream on a property.
Declaration
public virtual Task<Empty> DeleteAndroidAppDataStream(DeleteAndroidAppDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteAndroidAppDataStreamRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.Empty> | The response to send back to the client (wrapped by a task). |
DeleteConversionEvent(DeleteConversionEventRequest, ServerCallContext)
Deletes a conversion event in a property.
Declaration
public virtual Task<Empty> DeleteConversionEvent(DeleteConversionEventRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteConversionEventRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.Empty> | The response to send back to the client (wrapped by a task). |
DeleteIosAppDataStream(DeleteIosAppDataStreamRequest, ServerCallContext)
Deletes an iOS app stream on a property.
Declaration
public virtual Task<Empty> DeleteIosAppDataStream(DeleteIosAppDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteIosAppDataStreamRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found, or is not an GA4 Property.
Declaration
public virtual Task<Property> DeleteProperty(DeletePropertyRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeletePropertyRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Property> | The response to send back to the client (wrapped by a task). |
DeleteUserLink(DeleteUserLinkRequest, ServerCallContext)
Deletes a user link on an account or property.
Declaration
public virtual Task<Empty> DeleteUserLink(DeleteUserLinkRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteUserLinkRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.Empty> | The response to send back to the client (wrapped by a task). |
DeleteWebDataStream(DeleteWebDataStreamRequest, ServerCallContext)
Deletes a web stream on a property.
Declaration
public virtual Task<Empty> DeleteWebDataStream(DeleteWebDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteWebDataStreamRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Protobuf.WellKnownTypes.Empty> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Account> | The response to send back to the client (wrapped by a task). |
GetAndroidAppDataStream(GetAndroidAppDataStreamRequest, ServerCallContext)
Lookup for a single AndroidAppDataStream
Declaration
public virtual Task<AndroidAppDataStream> GetAndroidAppDataStream(GetAndroidAppDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetAndroidAppDataStreamRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AndroidAppDataStream> | The response to send back to the client (wrapped by a task). |
GetConversionEvent(GetConversionEventRequest, ServerCallContext)
Retrieve a single conversion event.
Declaration
public virtual Task<ConversionEvent> GetConversionEvent(GetConversionEventRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetConversionEventRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<CustomMetric> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<DataSharingSettings> | The response to send back to the client (wrapped by a task). |
GetEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest, ServerCallContext)
Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.
Declaration
public virtual Task<EnhancedMeasurementSettings> GetEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetEnhancedMeasurementSettingsRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<EnhancedMeasurementSettings> | The response to send back to the client (wrapped by a task). |
GetGlobalSiteTag(GetGlobalSiteTagRequest, ServerCallContext)
Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
Declaration
public virtual Task<GlobalSiteTag> GetGlobalSiteTag(GetGlobalSiteTagRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetGlobalSiteTagRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GlobalSiteTag> | The response to send back to the client (wrapped by a task). |
GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest, ServerCallContext)
Lookup for Google Signals settings for a property.
Declaration
public virtual Task<GoogleSignalsSettings> GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetGoogleSignalsSettingsRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GoogleSignalsSettings> | The response to send back to the client (wrapped by a task). |
GetIosAppDataStream(GetIosAppDataStreamRequest, ServerCallContext)
Lookup for a single IosAppDataStream
Declaration
public virtual Task<IosAppDataStream> GetIosAppDataStream(GetIosAppDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetIosAppDataStreamRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IosAppDataStream> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Property> | The response to send back to the client (wrapped by a task). |
GetUserLink(GetUserLinkRequest, ServerCallContext)
Gets information about a user's link to an account or property.
Declaration
public virtual Task<UserLink> GetUserLink(GetUserLinkRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetUserLinkRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<UserLink> | The response to send back to the client (wrapped by a task). |
GetWebDataStream(GetWebDataStreamRequest, ServerCallContext)
Lookup for a single WebDataStream
Declaration
public virtual Task<WebDataStream> GetWebDataStream(GetWebDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetWebDataStreamRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<WebDataStream> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListAccountsResponse> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListAccountSummariesResponse> | The response to send back to the client (wrapped by a task). |
ListAndroidAppDataStreams(ListAndroidAppDataStreamsRequest, ServerCallContext)
Returns child android app streams under the specified parent property.
Android app streams will be excluded if the caller does not have access. Returns an empty list if no relevant android app streams are found.
Declaration
public virtual Task<ListAndroidAppDataStreamsResponse> ListAndroidAppDataStreams(ListAndroidAppDataStreamsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListAndroidAppDataStreamsRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListAndroidAppDataStreamsResponse> | The response to send back to the client (wrapped by a task). |
ListConversionEvents(ListConversionEventsRequest, ServerCallContext)
Returns a list of conversion events in the specified parent property.
Returns an empty list if no conversion events are found.
Declaration
public virtual Task<ListConversionEventsResponse> ListConversionEvents(ListConversionEventsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListConversionEventsRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListCustomMetricsResponse> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListGoogleAdsLinksResponse> | The response to send back to the client (wrapped by a task). |
ListIosAppDataStreams(ListIosAppDataStreamsRequest, ServerCallContext)
Returns child iOS app data streams under the specified parent property.
iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.
Declaration
public virtual Task<ListIosAppDataStreamsResponse> ListIosAppDataStreams(ListIosAppDataStreamsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListIosAppDataStreamsRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListIosAppDataStreamsResponse> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListPropertiesResponse> | The response to send back to the client (wrapped by a task). |
ListUserLinks(ListUserLinksRequest, ServerCallContext)
Lists all user links on an account or property.
Declaration
public virtual Task<ListUserLinksResponse> ListUserLinks(ListUserLinksRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListUserLinksRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListUserLinksResponse> | The response to send back to the client (wrapped by a task). |
ListWebDataStreams(ListWebDataStreamsRequest, ServerCallContext)
Returns child web data streams under the specified parent property.
Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.
Declaration
public virtual Task<ListWebDataStreamsResponse> ListWebDataStreams(ListWebDataStreamsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListWebDataStreamsRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListWebDataStreamsResponse> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ProvisionAccountTicketResponse> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Account> | The response to send back to the client (wrapped by a task). |
UpdateAndroidAppDataStream(UpdateAndroidAppDataStreamRequest, ServerCallContext)
Updates an android app stream on a property.
Declaration
public virtual Task<AndroidAppDataStream> UpdateAndroidAppDataStream(UpdateAndroidAppDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateAndroidAppDataStreamRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AndroidAppDataStream> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<CustomMetric> | The response to send back to the client (wrapped by a task). |
UpdateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest, ServerCallContext)
Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.
Declaration
public virtual Task<EnhancedMeasurementSettings> UpdateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateEnhancedMeasurementSettingsRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<EnhancedMeasurementSettings> | The response to send back to the client (wrapped by a task). |
UpdateFirebaseLink(UpdateFirebaseLinkRequest, ServerCallContext)
Updates a FirebaseLink on a property
Declaration
public virtual Task<FirebaseLink> UpdateFirebaseLink(UpdateFirebaseLinkRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateFirebaseLinkRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FirebaseLink> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GoogleAdsLink> | The response to send back to the client (wrapped by a task). |
UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest, ServerCallContext)
Updates Google Signals settings for a property.
Declaration
public virtual Task<GoogleSignalsSettings> UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateGoogleSignalsSettingsRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GoogleSignalsSettings> | The response to send back to the client (wrapped by a task). |
UpdateIosAppDataStream(UpdateIosAppDataStreamRequest, ServerCallContext)
Updates an iOS app stream on a property.
Declaration
public virtual Task<IosAppDataStream> UpdateIosAppDataStream(UpdateIosAppDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateIosAppDataStreamRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IosAppDataStream> | 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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.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. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Property> | The response to send back to the client (wrapped by a task). |
UpdateUserLink(UpdateUserLinkRequest, ServerCallContext)
Updates a user link on an account or property.
Declaration
public virtual Task<UserLink> UpdateUserLink(UpdateUserLinkRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateUserLinkRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<UserLink> | The response to send back to the client (wrapped by a task). |
UpdateWebDataStream(UpdateWebDataStreamRequest, ServerCallContext)
Updates a web stream on a property.
Declaration
public virtual Task<WebDataStream> UpdateWebDataStream(UpdateWebDataStreamRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateWebDataStreamRequest | request | The request received from the client. |
| Grpc.Core.ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<WebDataStream> | The response to send back to the client (wrapped by a task). |