Show / Hide Table of Contents

Class AnalyticsAdminService.AnalyticsAdminServiceBase

Base class for server-side implementations of AnalyticsAdminService

Inheritance
object
AnalyticsAdminService.AnalyticsAdminServiceBase
Inherited Members
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Analytics.Admin.V1Alpha
Assembly: Google.Analytics.Admin.V1Alpha.dll
Syntax
[BindServiceMethod(typeof(AnalyticsAdminService), "BindService")]
public abstract class AnalyticsAdminService.AnalyticsAdminServiceBase

Methods

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).

ApproveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest, ServerCallContext)

Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.

Declaration
public virtual Task<ApproveDisplayVideo360AdvertiserLinkProposalResponse> ApproveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request, ServerCallContext context)
Parameters
Type Name Description
ApproveDisplayVideo360AdvertiserLinkProposalRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ApproveDisplayVideo360AdvertiserLinkProposalResponse>

The response to send back to the client (wrapped by a task).

ArchiveAudience(ArchiveAudienceRequest, ServerCallContext)

Archives an Audience on a property.

Declaration
public virtual Task<Empty> ArchiveAudience(ArchiveAudienceRequest request, ServerCallContext context)
Parameters
Type Name Description
ArchiveAudienceRequest 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).

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).

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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<AuditUserLinksResponse>

The response to send back to the client (wrapped by a task).

BatchCreateAccessBindings(BatchCreateAccessBindingsRequest, ServerCallContext)

Creates information about multiple access bindings to an account or property.

This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created.

Declaration
public virtual Task<BatchCreateAccessBindingsResponse> BatchCreateAccessBindings(BatchCreateAccessBindingsRequest request, ServerCallContext context)
Parameters
Type Name Description
BatchCreateAccessBindingsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<BatchCreateAccessBindingsResponse>

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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<BatchCreateUserLinksResponse>

The response to send back to the client (wrapped by a task).

BatchDeleteAccessBindings(BatchDeleteAccessBindingsRequest, ServerCallContext)

Deletes information about multiple users' links to an account or property.

Declaration
public virtual Task<Empty> BatchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request, ServerCallContext context)
Parameters
Type Name Description
BatchDeleteAccessBindingsRequest 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).

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.

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).

BatchGetAccessBindings(BatchGetAccessBindingsRequest, ServerCallContext)

Gets information about multiple access bindings to an account or property.

Declaration
public virtual Task<BatchGetAccessBindingsResponse> BatchGetAccessBindings(BatchGetAccessBindingsRequest request, ServerCallContext context)
Parameters
Type Name Description
BatchGetAccessBindingsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<BatchGetAccessBindingsResponse>

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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<BatchGetUserLinksResponse>

The response to send back to the client (wrapped by a task).

BatchUpdateAccessBindings(BatchUpdateAccessBindingsRequest, ServerCallContext)

Updates information about multiple access bindings to an account or property.

Declaration
public virtual Task<BatchUpdateAccessBindingsResponse> BatchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request, ServerCallContext context)
Parameters
Type Name Description
BatchUpdateAccessBindingsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<BatchUpdateAccessBindingsResponse>

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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<BatchUpdateUserLinksResponse>

The response to send back to the client (wrapped by a task).

CancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest, ServerCallContext)

Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either:

  • Declining a proposal initiated from Display & Video 360
  • Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.
Declaration
public virtual Task<DisplayVideo360AdvertiserLinkProposal> CancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request, ServerCallContext context)
Parameters
Type Name Description
CancelDisplayVideo360AdvertiserLinkProposalRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<DisplayVideo360AdvertiserLinkProposal>

The response to send back to the client (wrapped by a task).

CreateAccessBinding(CreateAccessBindingRequest, ServerCallContext)

Creates an access binding on an account or property.

Declaration
public virtual Task<AccessBinding> CreateAccessBinding(CreateAccessBindingRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateAccessBindingRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<AccessBinding>

The response to send back to the client (wrapped by a task).

CreateAdSenseLink(CreateAdSenseLinkRequest, ServerCallContext)

Creates an AdSenseLink.

Declaration
public virtual Task<AdSenseLink> CreateAdSenseLink(CreateAdSenseLinkRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateAdSenseLinkRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<AdSenseLink>

The response to send back to the client (wrapped by a task).

CreateAudience(CreateAudienceRequest, ServerCallContext)

Creates an Audience.

Declaration
public virtual Task<Audience> CreateAudience(CreateAudienceRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateAudienceRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<Audience>

The response to send back to the client (wrapped by a task).

CreateChannelGroup(CreateChannelGroupRequest, ServerCallContext)

Creates a ChannelGroup.

Declaration
public virtual Task<ChannelGroup> CreateChannelGroup(CreateChannelGroupRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateChannelGroupRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ChannelGroup>

The response to send back to the client (wrapped by a task).

CreateConnectedSiteTag(CreateConnectedSiteTagRequest, ServerCallContext)

Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties.

Declaration
public virtual Task<CreateConnectedSiteTagResponse> CreateConnectedSiteTag(CreateConnectedSiteTagRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateConnectedSiteTagRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<CreateConnectedSiteTagResponse>

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.

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).

CreateDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest, ServerCallContext)

Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.

Declaration
public virtual Task<DisplayVideo360AdvertiserLink> CreateDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateDisplayVideo360AdvertiserLinkRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<DisplayVideo360AdvertiserLink>

The response to send back to the client (wrapped by a task).

CreateDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest, ServerCallContext)

Creates a DisplayVideo360AdvertiserLinkProposal.

Declaration
public virtual Task<DisplayVideo360AdvertiserLinkProposal> CreateDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateDisplayVideo360AdvertiserLinkProposalRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<DisplayVideo360AdvertiserLinkProposal>

The response to send back to the client (wrapped by a task).

CreateEventCreateRule(CreateEventCreateRuleRequest, ServerCallContext)

Creates an EventCreateRule.

Declaration
public virtual Task<EventCreateRule> CreateEventCreateRule(CreateEventCreateRuleRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateEventCreateRuleRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<EventCreateRule>

The response to send back to the client (wrapped by a task).

CreateExpandedDataSet(CreateExpandedDataSetRequest, ServerCallContext)

Creates a ExpandedDataSet.

Declaration
public virtual Task<ExpandedDataSet> CreateExpandedDataSet(CreateExpandedDataSetRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateExpandedDataSetRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ExpandedDataSet>

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).

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).

CreateSearchAds360Link(CreateSearchAds360LinkRequest, ServerCallContext)

Creates a SearchAds360Link.

Declaration
public virtual Task<SearchAds360Link> CreateSearchAds360Link(CreateSearchAds360LinkRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateSearchAds360LinkRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<SearchAds360Link>

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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<UserLink>

The response to send back to the client (wrapped by a task).

DeleteAccessBinding(DeleteAccessBindingRequest, ServerCallContext)

Deletes an access binding on an account or property.

Declaration
public virtual Task<Empty> DeleteAccessBinding(DeleteAccessBindingRequest request, ServerCallContext context)
Parameters
Type Name Description
DeleteAccessBindingRequest 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).

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.

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).

DeleteAdSenseLink(DeleteAdSenseLinkRequest, ServerCallContext)

Deletes an AdSenseLink.

Declaration
public virtual Task<Empty> DeleteAdSenseLink(DeleteAdSenseLinkRequest request, ServerCallContext context)
Parameters
Type Name Description
DeleteAdSenseLinkRequest 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).

DeleteChannelGroup(DeleteChannelGroupRequest, ServerCallContext)

Deletes a ChannelGroup on a property.

Declaration
public virtual Task<Empty> DeleteChannelGroup(DeleteChannelGroupRequest request, ServerCallContext context)
Parameters
Type Name Description
DeleteChannelGroupRequest 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).

DeleteConnectedSiteTag(DeleteConnectedSiteTagRequest, ServerCallContext)

Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.

Declaration
public virtual Task<Empty> DeleteConnectedSiteTag(DeleteConnectedSiteTagRequest request, ServerCallContext context)
Parameters
Type Name Description
DeleteConnectedSiteTagRequest 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)

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.

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).

DeleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest, ServerCallContext)

Deletes a DisplayVideo360AdvertiserLink on a property.

Declaration
public virtual Task<Empty> DeleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request, ServerCallContext context)
Parameters
Type Name Description
DeleteDisplayVideo360AdvertiserLinkRequest 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).

DeleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest, ServerCallContext)

Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.

Declaration
public virtual Task<Empty> DeleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request, ServerCallContext context)
Parameters
Type Name Description
DeleteDisplayVideo360AdvertiserLinkProposalRequest 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).

DeleteEventCreateRule(DeleteEventCreateRuleRequest, ServerCallContext)

Deletes an EventCreateRule.

Declaration
public virtual Task<Empty> DeleteEventCreateRule(DeleteEventCreateRuleRequest request, ServerCallContext context)
Parameters
Type Name Description
DeleteEventCreateRuleRequest 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).

DeleteExpandedDataSet(DeleteExpandedDataSetRequest, ServerCallContext)

Deletes a ExpandedDataSet on a property.

Declaration
public virtual Task<Empty> DeleteExpandedDataSet(DeleteExpandedDataSetRequest request, ServerCallContext context)
Parameters
Type Name Description
DeleteExpandedDataSetRequest 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).

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, UserLinks) 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).

DeleteSearchAds360Link(DeleteSearchAds360LinkRequest, ServerCallContext)

Deletes a SearchAds360Link on a property.

Declaration
public virtual Task<Empty> DeleteSearchAds360Link(DeleteSearchAds360LinkRequest request, ServerCallContext context)
Parameters
Type Name Description
DeleteSearchAds360LinkRequest 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).

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.

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).

FetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest, ServerCallContext)

Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Declaration
public virtual Task<FetchAutomatedGa4ConfigurationOptOutResponse> FetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request, ServerCallContext context)
Parameters
Type Name Description
FetchAutomatedGa4ConfigurationOptOutRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<FetchAutomatedGa4ConfigurationOptOutResponse>

The response to send back to the client (wrapped by a task).

FetchConnectedGa4Property(FetchConnectedGa4PropertyRequest, ServerCallContext)

Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.

Declaration
public virtual Task<FetchConnectedGa4PropertyResponse> FetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request, ServerCallContext context)
Parameters
Type Name Description
FetchConnectedGa4PropertyRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<FetchConnectedGa4PropertyResponse>

The response to send back to the client (wrapped by a task).

GetAccessBinding(GetAccessBindingRequest, ServerCallContext)

Gets information about an access binding.

Declaration
public virtual Task<AccessBinding> GetAccessBinding(GetAccessBindingRequest request, ServerCallContext context)
Parameters
Type Name Description
GetAccessBindingRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<AccessBinding>

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).

GetAdSenseLink(GetAdSenseLinkRequest, ServerCallContext)

Looks up a single AdSenseLink.

Declaration
public virtual Task<AdSenseLink> GetAdSenseLink(GetAdSenseLinkRequest request, ServerCallContext context)
Parameters
Type Name Description
GetAdSenseLinkRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<AdSenseLink>

The response to send back to the client (wrapped by a task).

GetAttributionSettings(GetAttributionSettingsRequest, ServerCallContext)

Lookup for a AttributionSettings singleton.

Declaration
public virtual Task<AttributionSettings> GetAttributionSettings(GetAttributionSettingsRequest request, ServerCallContext context)
Parameters
Type Name Description
GetAttributionSettingsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<AttributionSettings>

The response to send back to the client (wrapped by a task).

GetAudience(GetAudienceRequest, ServerCallContext)

Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Declaration
public virtual Task<Audience> GetAudience(GetAudienceRequest request, ServerCallContext context)
Parameters
Type Name Description
GetAudienceRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<Audience>

The response to send back to the client (wrapped by a task).

GetBigQueryLink(GetBigQueryLinkRequest, ServerCallContext)

Lookup for a single BigQuery Link.

Declaration
public virtual Task<BigQueryLink> GetBigQueryLink(GetBigQueryLinkRequest request, ServerCallContext context)
Parameters
Type Name Description
GetBigQueryLinkRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<BigQueryLink>

The response to send back to the client (wrapped by a task).

GetChannelGroup(GetChannelGroupRequest, ServerCallContext)

Lookup for a single ChannelGroup.

Declaration
public virtual Task<ChannelGroup> GetChannelGroup(GetChannelGroupRequest request, ServerCallContext context)
Parameters
Type Name Description
GetChannelGroupRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ChannelGroup>

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.

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).

GetDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest, ServerCallContext)

Look up a single DisplayVideo360AdvertiserLink

Declaration
public virtual Task<DisplayVideo360AdvertiserLink> GetDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request, ServerCallContext context)
Parameters
Type Name Description
GetDisplayVideo360AdvertiserLinkRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<DisplayVideo360AdvertiserLink>

The response to send back to the client (wrapped by a task).

GetDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest, ServerCallContext)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Declaration
public virtual Task<DisplayVideo360AdvertiserLinkProposal> GetDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request, ServerCallContext context)
Parameters
Type Name Description
GetDisplayVideo360AdvertiserLinkProposalRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<DisplayVideo360AdvertiserLinkProposal>

The response to send back to the client (wrapped by a task).

GetEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest, ServerCallContext)

Returns the enhanced measurement settings for this data 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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<EnhancedMeasurementSettings>

The response to send back to the client (wrapped by a task).

GetEventCreateRule(GetEventCreateRuleRequest, ServerCallContext)

Lookup for a single EventCreateRule.

Declaration
public virtual Task<EventCreateRule> GetEventCreateRule(GetEventCreateRuleRequest request, ServerCallContext context)
Parameters
Type Name Description
GetEventCreateRuleRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<EventCreateRule>

The response to send back to the client (wrapped by a task).

GetExpandedDataSet(GetExpandedDataSetRequest, ServerCallContext)

Lookup for a single ExpandedDataSet.

Declaration
public virtual Task<ExpandedDataSet> GetExpandedDataSet(GetExpandedDataSetRequest request, ServerCallContext context)
Parameters
Type Name Description
GetExpandedDataSetRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ExpandedDataSet>

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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<GoogleSignalsSettings>

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).

GetSearchAds360Link(GetSearchAds360LinkRequest, ServerCallContext)

Look up a single SearchAds360Link

Declaration
public virtual Task<SearchAds360Link> GetSearchAds360Link(GetSearchAds360LinkRequest request, ServerCallContext context)
Parameters
Type Name Description
GetSearchAds360LinkRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<SearchAds360Link>

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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<UserLink>

The response to send back to the client (wrapped by a task).

ListAccessBindings(ListAccessBindingsRequest, ServerCallContext)

Lists all access bindings on an account or property.

Declaration
public virtual Task<ListAccessBindingsResponse> ListAccessBindings(ListAccessBindingsRequest request, ServerCallContext context)
Parameters
Type Name Description
ListAccessBindingsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListAccessBindingsResponse>

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).

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).

ListAdSenseLinks(ListAdSenseLinksRequest, ServerCallContext)

Lists AdSenseLinks on a property.

Declaration
public virtual Task<ListAdSenseLinksResponse> ListAdSenseLinks(ListAdSenseLinksRequest request, ServerCallContext context)
Parameters
Type Name Description
ListAdSenseLinksRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListAdSenseLinksResponse>

The response to send back to the client (wrapped by a task).

ListAudiences(ListAudiencesRequest, ServerCallContext)

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Declaration
public virtual Task<ListAudiencesResponse> ListAudiences(ListAudiencesRequest request, ServerCallContext context)
Parameters
Type Name Description
ListAudiencesRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListAudiencesResponse>

The response to send back to the client (wrapped by a task).

ListBigQueryLinks(ListBigQueryLinksRequest, ServerCallContext)

Lists BigQuery Links on a property.

Declaration
public virtual Task<ListBigQueryLinksResponse> ListBigQueryLinks(ListBigQueryLinksRequest request, ServerCallContext context)
Parameters
Type Name Description
ListBigQueryLinksRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListBigQueryLinksResponse>

The response to send back to the client (wrapped by a task).

ListChannelGroups(ListChannelGroupsRequest, ServerCallContext)

Lists ChannelGroups on a property.

Declaration
public virtual Task<ListChannelGroupsResponse> ListChannelGroups(ListChannelGroupsRequest request, ServerCallContext context)
Parameters
Type Name Description
ListChannelGroupsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListChannelGroupsResponse>

The response to send back to the client (wrapped by a task).

ListConnectedSiteTags(ListConnectedSiteTagsRequest, ServerCallContext)

Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property.

Declaration
public virtual Task<ListConnectedSiteTagsResponse> ListConnectedSiteTags(ListConnectedSiteTagsRequest request, ServerCallContext context)
Parameters
Type Name Description
ListConnectedSiteTagsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListConnectedSiteTagsResponse>

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.

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).

ListDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest, ServerCallContext)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Declaration
public virtual Task<ListDisplayVideo360AdvertiserLinkProposalsResponse> ListDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request, ServerCallContext context)
Parameters
Type Name Description
ListDisplayVideo360AdvertiserLinkProposalsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListDisplayVideo360AdvertiserLinkProposalsResponse>

The response to send back to the client (wrapped by a task).

ListDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest, ServerCallContext)

Lists all DisplayVideo360AdvertiserLinks on a property.

Declaration
public virtual Task<ListDisplayVideo360AdvertiserLinksResponse> ListDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request, ServerCallContext context)
Parameters
Type Name Description
ListDisplayVideo360AdvertiserLinksRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListDisplayVideo360AdvertiserLinksResponse>

The response to send back to the client (wrapped by a task).

ListEventCreateRules(ListEventCreateRulesRequest, ServerCallContext)

Lists EventCreateRules on a web data stream.

Declaration
public virtual Task<ListEventCreateRulesResponse> ListEventCreateRules(ListEventCreateRulesRequest request, ServerCallContext context)
Parameters
Type Name Description
ListEventCreateRulesRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListEventCreateRulesResponse>

The response to send back to the client (wrapped by a task).

ListExpandedDataSets(ListExpandedDataSetsRequest, ServerCallContext)

Lists ExpandedDataSets on a property.

Declaration
public virtual Task<ListExpandedDataSetsResponse> ListExpandedDataSets(ListExpandedDataSetsRequest request, ServerCallContext context)
Parameters
Type Name Description
ListExpandedDataSetsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListExpandedDataSetsResponse>

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).

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).

ListSearchAds360Links(ListSearchAds360LinksRequest, ServerCallContext)

Lists all SearchAds360Links on a property.

Declaration
public virtual Task<ListSearchAds360LinksResponse> ListSearchAds360Links(ListSearchAds360LinksRequest request, ServerCallContext context)
Parameters
Type Name Description
ListSearchAds360LinksRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListSearchAds360LinksResponse>

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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListUserLinksResponse>

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. The property must be in Google Analytics 360. 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).

SetAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest, ServerCallContext)

Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Declaration
public virtual Task<SetAutomatedGa4ConfigurationOptOutResponse> SetAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request, ServerCallContext context)
Parameters
Type Name Description
SetAutomatedGa4ConfigurationOptOutRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<SetAutomatedGa4ConfigurationOptOutResponse>

The response to send back to the client (wrapped by a task).

UpdateAccessBinding(UpdateAccessBindingRequest, ServerCallContext)

Updates an access binding on an account or property.

Declaration
public virtual Task<AccessBinding> UpdateAccessBinding(UpdateAccessBindingRequest request, ServerCallContext context)
Parameters
Type Name Description
UpdateAccessBindingRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<AccessBinding>

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).

UpdateAttributionSettings(UpdateAttributionSettingsRequest, ServerCallContext)

Updates attribution settings on a property.

Declaration
public virtual Task<AttributionSettings> UpdateAttributionSettings(UpdateAttributionSettingsRequest request, ServerCallContext context)
Parameters
Type Name Description
UpdateAttributionSettingsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<AttributionSettings>

The response to send back to the client (wrapped by a task).

UpdateAudience(UpdateAudienceRequest, ServerCallContext)

Updates an Audience on a property.

Declaration
public virtual Task<Audience> UpdateAudience(UpdateAudienceRequest request, ServerCallContext context)
Parameters
Type Name Description
UpdateAudienceRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<Audience>

The response to send back to the client (wrapped by a task).

UpdateChannelGroup(UpdateChannelGroupRequest, ServerCallContext)

Updates a ChannelGroup.

Declaration
public virtual Task<ChannelGroup> UpdateChannelGroup(UpdateChannelGroupRequest request, ServerCallContext context)
Parameters
Type Name Description
UpdateChannelGroupRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ChannelGroup>

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).

UpdateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest, ServerCallContext)

Updates a DisplayVideo360AdvertiserLink on a property.

Declaration
public virtual Task<DisplayVideo360AdvertiserLink> UpdateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request, ServerCallContext context)
Parameters
Type Name Description
UpdateDisplayVideo360AdvertiserLinkRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<DisplayVideo360AdvertiserLink>

The response to send back to the client (wrapped by a task).

UpdateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest, ServerCallContext)

Updates the enhanced measurement settings for this data 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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<EnhancedMeasurementSettings>

The response to send back to the client (wrapped by a task).

UpdateEventCreateRule(UpdateEventCreateRuleRequest, ServerCallContext)

Updates an EventCreateRule.

Declaration
public virtual Task<EventCreateRule> UpdateEventCreateRule(UpdateEventCreateRuleRequest request, ServerCallContext context)
Parameters
Type Name Description
UpdateEventCreateRuleRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<EventCreateRule>

The response to send back to the client (wrapped by a task).

UpdateExpandedDataSet(UpdateExpandedDataSetRequest, ServerCallContext)

Updates a ExpandedDataSet on a property.

Declaration
public virtual Task<ExpandedDataSet> UpdateExpandedDataSet(UpdateExpandedDataSetRequest request, ServerCallContext context)
Parameters
Type Name Description
UpdateExpandedDataSetRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ExpandedDataSet>

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).

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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<GoogleSignalsSettings>

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).

UpdateSearchAds360Link(UpdateSearchAds360LinkRequest, ServerCallContext)

Updates a SearchAds360Link on a property.

Declaration
public virtual Task<SearchAds360Link> UpdateSearchAds360Link(UpdateSearchAds360LinkRequest request, ServerCallContext context)
Parameters
Type Name Description
UpdateSearchAds360LinkRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<SearchAds360Link>

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.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<UserLink>

The response to send back to the client (wrapped by a task).

In This Article
Back to top Generated by DocFX