Interface AnalyticsAdminServiceGrpc.AsyncService (0.58.0)

public static interface AnalyticsAdminServiceGrpc.AsyncService

Service Interface for the Analytics Admin API (GA4).

Methods

acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, StreamObserver<AcknowledgeUserDataCollectionResponse> responseObserver)

public default void acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, StreamObserver<AcknowledgeUserDataCollectionResponse> responseObserver)

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.

Parameters
Name Description
request AcknowledgeUserDataCollectionRequest
responseObserver io.grpc.stub.StreamObserver<AcknowledgeUserDataCollectionResponse>

approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<ApproveDisplayVideo360AdvertiserLinkProposalResponse> responseObserver)

public default void approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<ApproveDisplayVideo360AdvertiserLinkProposalResponse> responseObserver)

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

Parameters
Name Description
request ApproveDisplayVideo360AdvertiserLinkProposalRequest
responseObserver io.grpc.stub.StreamObserver<ApproveDisplayVideo360AdvertiserLinkProposalResponse>

archiveAudience(ArchiveAudienceRequest request, StreamObserver<Empty> responseObserver)

public default void archiveAudience(ArchiveAudienceRequest request, StreamObserver<Empty> responseObserver)

Archives an Audience on a property.

Parameters
Name Description
request ArchiveAudienceRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver<Empty> responseObserver)

public default void archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver<Empty> responseObserver)

Archives a CustomDimension on a property.

Parameters
Name Description
request ArchiveCustomDimensionRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver<Empty> responseObserver)

public default void archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver<Empty> responseObserver)

Archives a CustomMetric on a property.

Parameters
Name Description
request ArchiveCustomMetricRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

batchCreateAccessBindings(BatchCreateAccessBindingsRequest request, StreamObserver<BatchCreateAccessBindingsResponse> responseObserver)

public default void batchCreateAccessBindings(BatchCreateAccessBindingsRequest request, StreamObserver<BatchCreateAccessBindingsResponse> responseObserver)

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.

Parameters
Name Description
request BatchCreateAccessBindingsRequest
responseObserver io.grpc.stub.StreamObserver<BatchCreateAccessBindingsResponse>

batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request, StreamObserver<Empty> responseObserver)

public default void batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name Description
request BatchDeleteAccessBindingsRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

batchGetAccessBindings(BatchGetAccessBindingsRequest request, StreamObserver<BatchGetAccessBindingsResponse> responseObserver)

public default void batchGetAccessBindings(BatchGetAccessBindingsRequest request, StreamObserver<BatchGetAccessBindingsResponse> responseObserver)

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

Parameters
Name Description
request BatchGetAccessBindingsRequest
responseObserver io.grpc.stub.StreamObserver<BatchGetAccessBindingsResponse>

batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request, StreamObserver<BatchUpdateAccessBindingsResponse> responseObserver)

public default void batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request, StreamObserver<BatchUpdateAccessBindingsResponse> responseObserver)

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

Parameters
Name Description
request BatchUpdateAccessBindingsRequest
responseObserver io.grpc.stub.StreamObserver<BatchUpdateAccessBindingsResponse>

cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

public default void cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

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.
Parameters
Name Description
request CancelDisplayVideo360AdvertiserLinkProposalRequest
responseObserver io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLinkProposal>

createAccessBinding(CreateAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

public default void createAccessBinding(CreateAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

Creates an access binding on an account or property.

Parameters
Name Description
request CreateAccessBindingRequest
responseObserver io.grpc.stub.StreamObserver<AccessBinding>
public default void createAdSenseLink(CreateAdSenseLinkRequest request, StreamObserver<AdSenseLink> responseObserver)

Creates an AdSenseLink.

Parameters
Name Description
request CreateAdSenseLinkRequest
responseObserver io.grpc.stub.StreamObserver<AdSenseLink>

createAudience(CreateAudienceRequest request, StreamObserver<Audience> responseObserver)

public default void createAudience(CreateAudienceRequest request, StreamObserver<Audience> responseObserver)

Creates an Audience.

Parameters
Name Description
request CreateAudienceRequest
responseObserver io.grpc.stub.StreamObserver<Audience>
public default void createBigQueryLink(CreateBigQueryLinkRequest request, StreamObserver<BigQueryLink> responseObserver)

Creates a BigQueryLink.

Parameters
Name Description
request CreateBigQueryLinkRequest
responseObserver io.grpc.stub.StreamObserver<BigQueryLink>

createCalculatedMetric(CreateCalculatedMetricRequest request, StreamObserver<CalculatedMetric> responseObserver)

public default void createCalculatedMetric(CreateCalculatedMetricRequest request, StreamObserver<CalculatedMetric> responseObserver)

Creates a CalculatedMetric.

Parameters
Name Description
request CreateCalculatedMetricRequest
responseObserver io.grpc.stub.StreamObserver<CalculatedMetric>

createChannelGroup(CreateChannelGroupRequest request, StreamObserver<ChannelGroup> responseObserver)

public default void createChannelGroup(CreateChannelGroupRequest request, StreamObserver<ChannelGroup> responseObserver)

Creates a ChannelGroup.

Parameters
Name Description
request CreateChannelGroupRequest
responseObserver io.grpc.stub.StreamObserver<ChannelGroup>

createConnectedSiteTag(CreateConnectedSiteTagRequest request, StreamObserver<CreateConnectedSiteTagResponse> responseObserver)

public default void createConnectedSiteTag(CreateConnectedSiteTagRequest request, StreamObserver<CreateConnectedSiteTagResponse> responseObserver)

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.

Parameters
Name Description
request CreateConnectedSiteTagRequest
responseObserver io.grpc.stub.StreamObserver<CreateConnectedSiteTagResponse>

createConversionEvent(CreateConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver) (deprecated)

public default void createConversionEvent(CreateConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)

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

Parameters
Name Description
request CreateConversionEventRequest
responseObserver io.grpc.stub.StreamObserver<ConversionEvent>

createCustomDimension(CreateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

public default void createCustomDimension(CreateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

Creates a CustomDimension.

Parameters
Name Description
request CreateCustomDimensionRequest
responseObserver io.grpc.stub.StreamObserver<CustomDimension>

createCustomMetric(CreateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

public default void createCustomMetric(CreateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

Creates a CustomMetric.

Parameters
Name Description
request CreateCustomMetricRequest
responseObserver io.grpc.stub.StreamObserver<CustomMetric>

createDataStream(CreateDataStreamRequest request, StreamObserver<DataStream> responseObserver)

public default void createDataStream(CreateDataStreamRequest request, StreamObserver<DataStream> responseObserver)

Creates a DataStream.

Parameters
Name Description
request CreateDataStreamRequest
responseObserver io.grpc.stub.StreamObserver<DataStream>
public default void createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)

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.

Parameters
Name Description
request CreateDisplayVideo360AdvertiserLinkRequest
responseObserver io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLink>

createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

public default void createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

Creates a DisplayVideo360AdvertiserLinkProposal.

Parameters
Name Description
request CreateDisplayVideo360AdvertiserLinkProposalRequest
responseObserver io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLinkProposal>

createEventCreateRule(CreateEventCreateRuleRequest request, StreamObserver<EventCreateRule> responseObserver)

public default void createEventCreateRule(CreateEventCreateRuleRequest request, StreamObserver<EventCreateRule> responseObserver)

Creates an EventCreateRule.

Parameters
Name Description
request CreateEventCreateRuleRequest
responseObserver io.grpc.stub.StreamObserver<EventCreateRule>

createEventEditRule(CreateEventEditRuleRequest request, StreamObserver<EventEditRule> responseObserver)

public default void createEventEditRule(CreateEventEditRuleRequest request, StreamObserver<EventEditRule> responseObserver)

Creates an EventEditRule.

Parameters
Name Description
request CreateEventEditRuleRequest
responseObserver io.grpc.stub.StreamObserver<EventEditRule>

createExpandedDataSet(CreateExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

public default void createExpandedDataSet(CreateExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

Creates a ExpandedDataSet.

Parameters
Name Description
request CreateExpandedDataSetRequest
responseObserver io.grpc.stub.StreamObserver<ExpandedDataSet>
public default void createFirebaseLink(CreateFirebaseLinkRequest request, StreamObserver<FirebaseLink> responseObserver)

Creates a FirebaseLink. Properties can have at most one FirebaseLink.

Parameters
Name Description
request CreateFirebaseLinkRequest
responseObserver io.grpc.stub.StreamObserver<FirebaseLink>
public default void createGoogleAdsLink(CreateGoogleAdsLinkRequest request, StreamObserver<GoogleAdsLink> responseObserver)

Creates a GoogleAdsLink.

Parameters
Name Description
request CreateGoogleAdsLinkRequest
responseObserver io.grpc.stub.StreamObserver<GoogleAdsLink>

createKeyEvent(CreateKeyEventRequest request, StreamObserver<KeyEvent> responseObserver)

public default void createKeyEvent(CreateKeyEventRequest request, StreamObserver<KeyEvent> responseObserver)

Creates a Key Event.

Parameters
Name Description
request CreateKeyEventRequest
responseObserver io.grpc.stub.StreamObserver<KeyEvent>

createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

public default void createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

Creates a measurement protocol secret.

Parameters
Name Description
request CreateMeasurementProtocolSecretRequest
responseObserver io.grpc.stub.StreamObserver<MeasurementProtocolSecret>

createProperty(CreatePropertyRequest request, StreamObserver<Property> responseObserver)

public default void createProperty(CreatePropertyRequest request, StreamObserver<Property> responseObserver)

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

Parameters
Name Description
request CreatePropertyRequest
responseObserver io.grpc.stub.StreamObserver<Property>

createRollupProperty(CreateRollupPropertyRequest request, StreamObserver<CreateRollupPropertyResponse> responseObserver)

public default void createRollupProperty(CreateRollupPropertyRequest request, StreamObserver<CreateRollupPropertyResponse> responseObserver)

Create a roll-up property and all roll-up property source links.

Parameters
Name Description
request CreateRollupPropertyRequest
responseObserver io.grpc.stub.StreamObserver<CreateRollupPropertyResponse>
public default void createRollupPropertySourceLink(CreateRollupPropertySourceLinkRequest request, StreamObserver<RollupPropertySourceLink> responseObserver)

Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

Parameters
Name Description
request CreateRollupPropertySourceLinkRequest
responseObserver io.grpc.stub.StreamObserver<RollupPropertySourceLink>

createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request, StreamObserver<SKAdNetworkConversionValueSchema> responseObserver)

public default void createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request, StreamObserver<SKAdNetworkConversionValueSchema> responseObserver)

Creates a SKAdNetworkConversionValueSchema.

Parameters
Name Description
request CreateSKAdNetworkConversionValueSchemaRequest
responseObserver io.grpc.stub.StreamObserver<SKAdNetworkConversionValueSchema>
public default void createSearchAds360Link(CreateSearchAds360LinkRequest request, StreamObserver<SearchAds360Link> responseObserver)

Creates a SearchAds360Link.

Parameters
Name Description
request CreateSearchAds360LinkRequest
responseObserver io.grpc.stub.StreamObserver<SearchAds360Link>

createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request, StreamObserver<SubpropertyEventFilter> responseObserver)

public default void createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request, StreamObserver<SubpropertyEventFilter> responseObserver)

Creates a subproperty Event Filter.

Parameters
Name Description
request CreateSubpropertyEventFilterRequest
responseObserver io.grpc.stub.StreamObserver<SubpropertyEventFilter>

deleteAccessBinding(DeleteAccessBindingRequest request, StreamObserver<Empty> responseObserver)

public default void deleteAccessBinding(DeleteAccessBindingRequest request, StreamObserver<Empty> responseObserver)

Deletes an access binding on an account or property.

Parameters
Name Description
request DeleteAccessBindingRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteAccount(DeleteAccountRequest request, StreamObserver<Empty> responseObserver)

public default void deleteAccount(DeleteAccountRequest request, StreamObserver<Empty> responseObserver)

Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.

Parameters
Name Description
request DeleteAccountRequest
responseObserver io.grpc.stub.StreamObserver<Empty>
public default void deleteAdSenseLink(DeleteAdSenseLinkRequest request, StreamObserver<Empty> responseObserver)

Deletes an AdSenseLink.

Parameters
Name Description
request DeleteAdSenseLinkRequest
responseObserver io.grpc.stub.StreamObserver<Empty>
public default void deleteBigQueryLink(DeleteBigQueryLinkRequest request, StreamObserver<Empty> responseObserver)

Deletes a BigQueryLink on a property.

Parameters
Name Description
request DeleteBigQueryLinkRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteCalculatedMetric(DeleteCalculatedMetricRequest request, StreamObserver<Empty> responseObserver)

public default void deleteCalculatedMetric(DeleteCalculatedMetricRequest request, StreamObserver<Empty> responseObserver)

Deletes a CalculatedMetric on a property.

Parameters
Name Description
request DeleteCalculatedMetricRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteChannelGroup(DeleteChannelGroupRequest request, StreamObserver<Empty> responseObserver)

public default void deleteChannelGroup(DeleteChannelGroupRequest request, StreamObserver<Empty> responseObserver)

Deletes a ChannelGroup on a property.

Parameters
Name Description
request DeleteChannelGroupRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request, StreamObserver<Empty> responseObserver)

public default void deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name Description
request DeleteConnectedSiteTagRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver<Empty> responseObserver) (deprecated)

public default void deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name Description
request DeleteConversionEventRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteDataStream(DeleteDataStreamRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDataStream(DeleteDataStreamRequest request, StreamObserver<Empty> responseObserver)

Deletes a DataStream on a property.

Parameters
Name Description
request DeleteDataStreamRequest
responseObserver io.grpc.stub.StreamObserver<Empty>
public default void deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request, StreamObserver<Empty> responseObserver)

Deletes a DisplayVideo360AdvertiserLink on a property.

Parameters
Name Description
request DeleteDisplayVideo360AdvertiserLinkRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name Description
request DeleteDisplayVideo360AdvertiserLinkProposalRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteEventCreateRule(DeleteEventCreateRuleRequest request, StreamObserver<Empty> responseObserver)

public default void deleteEventCreateRule(DeleteEventCreateRuleRequest request, StreamObserver<Empty> responseObserver)

Deletes an EventCreateRule.

Parameters
Name Description
request DeleteEventCreateRuleRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteEventEditRule(DeleteEventEditRuleRequest request, StreamObserver<Empty> responseObserver)

public default void deleteEventEditRule(DeleteEventEditRuleRequest request, StreamObserver<Empty> responseObserver)

Deletes an EventEditRule.

Parameters
Name Description
request DeleteEventEditRuleRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteExpandedDataSet(DeleteExpandedDataSetRequest request, StreamObserver<Empty> responseObserver)

public default void deleteExpandedDataSet(DeleteExpandedDataSetRequest request, StreamObserver<Empty> responseObserver)

Deletes a ExpandedDataSet on a property.

Parameters
Name Description
request DeleteExpandedDataSetRequest
responseObserver io.grpc.stub.StreamObserver<Empty>
public default void deleteFirebaseLink(DeleteFirebaseLinkRequest request, StreamObserver<Empty> responseObserver)

Deletes a FirebaseLink on a property

Parameters
Name Description
request DeleteFirebaseLinkRequest
responseObserver io.grpc.stub.StreamObserver<Empty>
public default void deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, StreamObserver<Empty> responseObserver)

Deletes a GoogleAdsLink on a property

Parameters
Name Description
request DeleteGoogleAdsLinkRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteKeyEvent(DeleteKeyEventRequest request, StreamObserver<Empty> responseObserver)

public default void deleteKeyEvent(DeleteKeyEventRequest request, StreamObserver<Empty> responseObserver)

Deletes a Key Event.

Parameters
Name Description
request DeleteKeyEventRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver<Empty> responseObserver)

public default void deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver<Empty> responseObserver)

Deletes target MeasurementProtocolSecret.

Parameters
Name Description
request DeleteMeasurementProtocolSecretRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteProperty(DeletePropertyRequest request, StreamObserver<Property> responseObserver)

public default void deleteProperty(DeletePropertyRequest request, StreamObserver<Property> responseObserver)

Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.

Parameters
Name Description
request DeletePropertyRequest
responseObserver io.grpc.stub.StreamObserver<Property>
public default void deleteRollupPropertySourceLink(DeleteRollupPropertySourceLinkRequest request, StreamObserver<Empty> responseObserver)

Deletes a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

Parameters
Name Description
request DeleteRollupPropertySourceLinkRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request, StreamObserver<Empty> responseObserver)

public default void deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request, StreamObserver<Empty> responseObserver)

Deletes target SKAdNetworkConversionValueSchema.

Parameters
Name Description
request DeleteSKAdNetworkConversionValueSchemaRequest
responseObserver io.grpc.stub.StreamObserver<Empty>
public default void deleteSearchAds360Link(DeleteSearchAds360LinkRequest request, StreamObserver<Empty> responseObserver)

Deletes a SearchAds360Link on a property.

Parameters
Name Description
request DeleteSearchAds360LinkRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request, StreamObserver<Empty> responseObserver)

public default void deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request, StreamObserver<Empty> responseObserver)

Deletes a subproperty event filter.

Parameters
Name Description
request DeleteSubpropertyEventFilterRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request, StreamObserver<FetchAutomatedGa4ConfigurationOptOutResponse> responseObserver)

public default void fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request, StreamObserver<FetchAutomatedGa4ConfigurationOptOutResponse> responseObserver)

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

Parameters
Name Description
request FetchAutomatedGa4ConfigurationOptOutRequest
responseObserver io.grpc.stub.StreamObserver<FetchAutomatedGa4ConfigurationOptOutResponse>

fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request, StreamObserver<FetchConnectedGa4PropertyResponse> responseObserver)

public default void fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request, StreamObserver<FetchConnectedGa4PropertyResponse> responseObserver)

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

Parameters
Name Description
request FetchConnectedGa4PropertyRequest
responseObserver io.grpc.stub.StreamObserver<FetchConnectedGa4PropertyResponse>

getAccessBinding(GetAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

public default void getAccessBinding(GetAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

Gets information about an access binding.

Parameters
Name Description
request GetAccessBindingRequest
responseObserver io.grpc.stub.StreamObserver<AccessBinding>

getAccount(GetAccountRequest request, StreamObserver<Account> responseObserver)

public default void getAccount(GetAccountRequest request, StreamObserver<Account> responseObserver)

Lookup for a single Account.

Parameters
Name Description
request GetAccountRequest
responseObserver io.grpc.stub.StreamObserver<Account>
public default void getAdSenseLink(GetAdSenseLinkRequest request, StreamObserver<AdSenseLink> responseObserver)

Looks up a single AdSenseLink.

Parameters
Name Description
request GetAdSenseLinkRequest
responseObserver io.grpc.stub.StreamObserver<AdSenseLink>

getAttributionSettings(GetAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)

public default void getAttributionSettings(GetAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)

Lookup for a AttributionSettings singleton.

Parameters
Name Description
request GetAttributionSettingsRequest
responseObserver io.grpc.stub.StreamObserver<AttributionSettings>

getAudience(GetAudienceRequest request, StreamObserver<Audience> responseObserver)

public default void getAudience(GetAudienceRequest request, StreamObserver<Audience> responseObserver)

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

Parameters
Name Description
request GetAudienceRequest
responseObserver io.grpc.stub.StreamObserver<Audience>
public default void getBigQueryLink(GetBigQueryLinkRequest request, StreamObserver<BigQueryLink> responseObserver)

Lookup for a single BigQuery Link.

Parameters
Name Description
request GetBigQueryLinkRequest
responseObserver io.grpc.stub.StreamObserver<BigQueryLink>

getCalculatedMetric(GetCalculatedMetricRequest request, StreamObserver<CalculatedMetric> responseObserver)

public default void getCalculatedMetric(GetCalculatedMetricRequest request, StreamObserver<CalculatedMetric> responseObserver)

Lookup for a single CalculatedMetric.

Parameters
Name Description
request GetCalculatedMetricRequest
responseObserver io.grpc.stub.StreamObserver<CalculatedMetric>

getChannelGroup(GetChannelGroupRequest request, StreamObserver<ChannelGroup> responseObserver)

public default void getChannelGroup(GetChannelGroupRequest request, StreamObserver<ChannelGroup> responseObserver)

Lookup for a single ChannelGroup.

Parameters
Name Description
request GetChannelGroupRequest
responseObserver io.grpc.stub.StreamObserver<ChannelGroup>

getConversionEvent(GetConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver) (deprecated)

public default void getConversionEvent(GetConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)

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

Parameters
Name Description
request GetConversionEventRequest
responseObserver io.grpc.stub.StreamObserver<ConversionEvent>

getCustomDimension(GetCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

public default void getCustomDimension(GetCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

Lookup for a single CustomDimension.

Parameters
Name Description
request GetCustomDimensionRequest
responseObserver io.grpc.stub.StreamObserver<CustomDimension>

getCustomMetric(GetCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

public default void getCustomMetric(GetCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

Lookup for a single CustomMetric.

Parameters
Name Description
request GetCustomMetricRequest
responseObserver io.grpc.stub.StreamObserver<CustomMetric>

getDataRedactionSettings(GetDataRedactionSettingsRequest request, StreamObserver<DataRedactionSettings> responseObserver)

public default void getDataRedactionSettings(GetDataRedactionSettingsRequest request, StreamObserver<DataRedactionSettings> responseObserver)

Lookup for a single DataRedactionSettings.

Parameters
Name Description
request GetDataRedactionSettingsRequest
responseObserver io.grpc.stub.StreamObserver<DataRedactionSettings>

getDataRetentionSettings(GetDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)

public default void getDataRetentionSettings(GetDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)

Returns the singleton data retention settings for this property.

Parameters
Name Description
request GetDataRetentionSettingsRequest
responseObserver io.grpc.stub.StreamObserver<DataRetentionSettings>

getDataSharingSettings(GetDataSharingSettingsRequest request, StreamObserver<DataSharingSettings> responseObserver)

public default void getDataSharingSettings(GetDataSharingSettingsRequest request, StreamObserver<DataSharingSettings> responseObserver)

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

Parameters
Name Description
request GetDataSharingSettingsRequest
responseObserver io.grpc.stub.StreamObserver<DataSharingSettings>

getDataStream(GetDataStreamRequest request, StreamObserver<DataStream> responseObserver)

public default void getDataStream(GetDataStreamRequest request, StreamObserver<DataStream> responseObserver)

Lookup for a single DataStream.

Parameters
Name Description
request GetDataStreamRequest
responseObserver io.grpc.stub.StreamObserver<DataStream>
public default void getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)

Look up a single DisplayVideo360AdvertiserLink

Parameters
Name Description
request GetDisplayVideo360AdvertiserLinkRequest
responseObserver io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLink>

getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

public default void getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Parameters
Name Description
request GetDisplayVideo360AdvertiserLinkProposalRequest
responseObserver io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLinkProposal>

getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request, StreamObserver<EnhancedMeasurementSettings> responseObserver)

public default void getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request, StreamObserver<EnhancedMeasurementSettings> responseObserver)

Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Parameters
Name Description
request GetEnhancedMeasurementSettingsRequest
responseObserver io.grpc.stub.StreamObserver<EnhancedMeasurementSettings>

getEventCreateRule(GetEventCreateRuleRequest request, StreamObserver<EventCreateRule> responseObserver)

public default void getEventCreateRule(GetEventCreateRuleRequest request, StreamObserver<EventCreateRule> responseObserver)

Lookup for a single EventCreateRule.

Parameters
Name Description
request GetEventCreateRuleRequest
responseObserver io.grpc.stub.StreamObserver<EventCreateRule>

getEventEditRule(GetEventEditRuleRequest request, StreamObserver<EventEditRule> responseObserver)

public default void getEventEditRule(GetEventEditRuleRequest request, StreamObserver<EventEditRule> responseObserver)

Lookup for a single EventEditRule.

Parameters
Name Description
request GetEventEditRuleRequest
responseObserver io.grpc.stub.StreamObserver<EventEditRule>

getExpandedDataSet(GetExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

public default void getExpandedDataSet(GetExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

Lookup for a single ExpandedDataSet.

Parameters
Name Description
request GetExpandedDataSetRequest
responseObserver io.grpc.stub.StreamObserver<ExpandedDataSet>

getGlobalSiteTag(GetGlobalSiteTagRequest request, StreamObserver<GlobalSiteTag> responseObserver)

public default void getGlobalSiteTag(GetGlobalSiteTagRequest request, StreamObserver<GlobalSiteTag> responseObserver)

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Parameters
Name Description
request GetGlobalSiteTagRequest
responseObserver io.grpc.stub.StreamObserver<GlobalSiteTag>

getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)

public default void getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)

Lookup for Google Signals settings for a property.

Parameters
Name Description
request GetGoogleSignalsSettingsRequest
responseObserver io.grpc.stub.StreamObserver<GoogleSignalsSettings>

getKeyEvent(GetKeyEventRequest request, StreamObserver<KeyEvent> responseObserver)

public default void getKeyEvent(GetKeyEventRequest request, StreamObserver<KeyEvent> responseObserver)

Retrieve a single Key Event.

Parameters
Name Description
request GetKeyEventRequest
responseObserver io.grpc.stub.StreamObserver<KeyEvent>

getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

public default void getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

Lookup for a single "GA4" MeasurementProtocolSecret.

Parameters
Name Description
request GetMeasurementProtocolSecretRequest
responseObserver io.grpc.stub.StreamObserver<MeasurementProtocolSecret>

getProperty(GetPropertyRequest request, StreamObserver<Property> responseObserver)

public default void getProperty(GetPropertyRequest request, StreamObserver<Property> responseObserver)

Lookup for a single "GA4" Property.

Parameters
Name Description
request GetPropertyRequest
responseObserver io.grpc.stub.StreamObserver<Property>
public default void getRollupPropertySourceLink(GetRollupPropertySourceLinkRequest request, StreamObserver<RollupPropertySourceLink> responseObserver)

Lookup for a single roll-up property source Link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

Parameters
Name Description
request GetRollupPropertySourceLinkRequest
responseObserver io.grpc.stub.StreamObserver<RollupPropertySourceLink>

getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request, StreamObserver<SKAdNetworkConversionValueSchema> responseObserver)

public default void getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request, StreamObserver<SKAdNetworkConversionValueSchema> responseObserver)

Looks up a single SKAdNetworkConversionValueSchema.

Parameters
Name Description
request GetSKAdNetworkConversionValueSchemaRequest
responseObserver io.grpc.stub.StreamObserver<SKAdNetworkConversionValueSchema>
public default void getSearchAds360Link(GetSearchAds360LinkRequest request, StreamObserver<SearchAds360Link> responseObserver)

Look up a single SearchAds360Link

Parameters
Name Description
request GetSearchAds360LinkRequest
responseObserver io.grpc.stub.StreamObserver<SearchAds360Link>

getSubpropertyEventFilter(GetSubpropertyEventFilterRequest request, StreamObserver<SubpropertyEventFilter> responseObserver)

public default void getSubpropertyEventFilter(GetSubpropertyEventFilterRequest request, StreamObserver<SubpropertyEventFilter> responseObserver)

Lookup for a single subproperty Event Filter.

Parameters
Name Description
request GetSubpropertyEventFilterRequest
responseObserver io.grpc.stub.StreamObserver<SubpropertyEventFilter>

listAccessBindings(ListAccessBindingsRequest request, StreamObserver<ListAccessBindingsResponse> responseObserver)

public default void listAccessBindings(ListAccessBindingsRequest request, StreamObserver<ListAccessBindingsResponse> responseObserver)

Lists all access bindings on an account or property.

Parameters
Name Description
request ListAccessBindingsRequest
responseObserver io.grpc.stub.StreamObserver<ListAccessBindingsResponse>

listAccountSummaries(ListAccountSummariesRequest request, StreamObserver<ListAccountSummariesResponse> responseObserver)

public default void listAccountSummaries(ListAccountSummariesRequest request, StreamObserver<ListAccountSummariesResponse> responseObserver)

Returns summaries of all accounts accessible by the caller.

Parameters
Name Description
request ListAccountSummariesRequest
responseObserver io.grpc.stub.StreamObserver<ListAccountSummariesResponse>

listAccounts(ListAccountsRequest request, StreamObserver<ListAccountsResponse> responseObserver)

public default void listAccounts(ListAccountsRequest request, StreamObserver<ListAccountsResponse> responseObserver)

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.

Parameters
Name Description
request ListAccountsRequest
responseObserver io.grpc.stub.StreamObserver<ListAccountsResponse>
public default void listAdSenseLinks(ListAdSenseLinksRequest request, StreamObserver<ListAdSenseLinksResponse> responseObserver)

Lists AdSenseLinks on a property.

Parameters
Name Description
request ListAdSenseLinksRequest
responseObserver io.grpc.stub.StreamObserver<ListAdSenseLinksResponse>

listAudiences(ListAudiencesRequest request, StreamObserver<ListAudiencesResponse> responseObserver)

public default void listAudiences(ListAudiencesRequest request, StreamObserver<ListAudiencesResponse> responseObserver)

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

Parameters
Name Description
request ListAudiencesRequest
responseObserver io.grpc.stub.StreamObserver<ListAudiencesResponse>
public default void listBigQueryLinks(ListBigQueryLinksRequest request, StreamObserver<ListBigQueryLinksResponse> responseObserver)

Lists BigQuery Links on a property.

Parameters
Name Description
request ListBigQueryLinksRequest
responseObserver io.grpc.stub.StreamObserver<ListBigQueryLinksResponse>

listCalculatedMetrics(ListCalculatedMetricsRequest request, StreamObserver<ListCalculatedMetricsResponse> responseObserver)

public default void listCalculatedMetrics(ListCalculatedMetricsRequest request, StreamObserver<ListCalculatedMetricsResponse> responseObserver)

Lists CalculatedMetrics on a property.

Parameters
Name Description
request ListCalculatedMetricsRequest
responseObserver io.grpc.stub.StreamObserver<ListCalculatedMetricsResponse>

listChannelGroups(ListChannelGroupsRequest request, StreamObserver<ListChannelGroupsResponse> responseObserver)

public default void listChannelGroups(ListChannelGroupsRequest request, StreamObserver<ListChannelGroupsResponse> responseObserver)

Lists ChannelGroups on a property.

Parameters
Name Description
request ListChannelGroupsRequest
responseObserver io.grpc.stub.StreamObserver<ListChannelGroupsResponse>

listConnectedSiteTags(ListConnectedSiteTagsRequest request, StreamObserver<ListConnectedSiteTagsResponse> responseObserver)

public default void listConnectedSiteTags(ListConnectedSiteTagsRequest request, StreamObserver<ListConnectedSiteTagsResponse> responseObserver)

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.

Parameters
Name Description
request ListConnectedSiteTagsRequest
responseObserver io.grpc.stub.StreamObserver<ListConnectedSiteTagsResponse>

listConversionEvents(ListConversionEventsRequest request, StreamObserver<ListConversionEventsResponse> responseObserver) (deprecated)

public default void listConversionEvents(ListConversionEventsRequest request, StreamObserver<ListConversionEventsResponse> responseObserver)

Deprecated: Use ListKeyEvents instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

Parameters
Name Description
request ListConversionEventsRequest
responseObserver io.grpc.stub.StreamObserver<ListConversionEventsResponse>

listCustomDimensions(ListCustomDimensionsRequest request, StreamObserver<ListCustomDimensionsResponse> responseObserver)

public default void listCustomDimensions(ListCustomDimensionsRequest request, StreamObserver<ListCustomDimensionsResponse> responseObserver)

Lists CustomDimensions on a property.

Parameters
Name Description
request ListCustomDimensionsRequest
responseObserver io.grpc.stub.StreamObserver<ListCustomDimensionsResponse>

listCustomMetrics(ListCustomMetricsRequest request, StreamObserver<ListCustomMetricsResponse> responseObserver)

public default void listCustomMetrics(ListCustomMetricsRequest request, StreamObserver<ListCustomMetricsResponse> responseObserver)

Lists CustomMetrics on a property.

Parameters
Name Description
request ListCustomMetricsRequest
responseObserver io.grpc.stub.StreamObserver<ListCustomMetricsResponse>

listDataStreams(ListDataStreamsRequest request, StreamObserver<ListDataStreamsResponse> responseObserver)

public default void listDataStreams(ListDataStreamsRequest request, StreamObserver<ListDataStreamsResponse> responseObserver)

Lists DataStreams on a property.

Parameters
Name Description
request ListDataStreamsRequest
responseObserver io.grpc.stub.StreamObserver<ListDataStreamsResponse>

listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request, StreamObserver<ListDisplayVideo360AdvertiserLinkProposalsResponse> responseObserver)

public default void listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request, StreamObserver<ListDisplayVideo360AdvertiserLinkProposalsResponse> responseObserver)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Parameters
Name Description
request ListDisplayVideo360AdvertiserLinkProposalsRequest
responseObserver io.grpc.stub.StreamObserver<ListDisplayVideo360AdvertiserLinkProposalsResponse>
public default void listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request, StreamObserver<ListDisplayVideo360AdvertiserLinksResponse> responseObserver)

Lists all DisplayVideo360AdvertiserLinks on a property.

Parameters
Name Description
request ListDisplayVideo360AdvertiserLinksRequest
responseObserver io.grpc.stub.StreamObserver<ListDisplayVideo360AdvertiserLinksResponse>

listEventCreateRules(ListEventCreateRulesRequest request, StreamObserver<ListEventCreateRulesResponse> responseObserver)

public default void listEventCreateRules(ListEventCreateRulesRequest request, StreamObserver<ListEventCreateRulesResponse> responseObserver)

Lists EventCreateRules on a web data stream.

Parameters
Name Description
request ListEventCreateRulesRequest
responseObserver io.grpc.stub.StreamObserver<ListEventCreateRulesResponse>

listEventEditRules(ListEventEditRulesRequest request, StreamObserver<ListEventEditRulesResponse> responseObserver)

public default void listEventEditRules(ListEventEditRulesRequest request, StreamObserver<ListEventEditRulesResponse> responseObserver)

Lists EventEditRules on a web data stream.

Parameters
Name Description
request ListEventEditRulesRequest
responseObserver io.grpc.stub.StreamObserver<ListEventEditRulesResponse>

listExpandedDataSets(ListExpandedDataSetsRequest request, StreamObserver<ListExpandedDataSetsResponse> responseObserver)

public default void listExpandedDataSets(ListExpandedDataSetsRequest request, StreamObserver<ListExpandedDataSetsResponse> responseObserver)

Lists ExpandedDataSets on a property.

Parameters
Name Description
request ListExpandedDataSetsRequest
responseObserver io.grpc.stub.StreamObserver<ListExpandedDataSetsResponse>
public default void listFirebaseLinks(ListFirebaseLinksRequest request, StreamObserver<ListFirebaseLinksResponse> responseObserver)

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

Parameters
Name Description
request ListFirebaseLinksRequest
responseObserver io.grpc.stub.StreamObserver<ListFirebaseLinksResponse>
public default void listGoogleAdsLinks(ListGoogleAdsLinksRequest request, StreamObserver<ListGoogleAdsLinksResponse> responseObserver)

Lists GoogleAdsLinks on a property.

Parameters
Name Description
request ListGoogleAdsLinksRequest
responseObserver io.grpc.stub.StreamObserver<ListGoogleAdsLinksResponse>

listKeyEvents(ListKeyEventsRequest request, StreamObserver<ListKeyEventsResponse> responseObserver)

public default void listKeyEvents(ListKeyEventsRequest request, StreamObserver<ListKeyEventsResponse> responseObserver)

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

Parameters
Name Description
request ListKeyEventsRequest
responseObserver io.grpc.stub.StreamObserver<ListKeyEventsResponse>

listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, StreamObserver<ListMeasurementProtocolSecretsResponse> responseObserver)

public default void listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, StreamObserver<ListMeasurementProtocolSecretsResponse> responseObserver)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Parameters
Name Description
request ListMeasurementProtocolSecretsRequest
responseObserver io.grpc.stub.StreamObserver<ListMeasurementProtocolSecretsResponse>

listProperties(ListPropertiesRequest request, StreamObserver<ListPropertiesResponse> responseObserver)

public default void listProperties(ListPropertiesRequest request, StreamObserver<ListPropertiesResponse> responseObserver)

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.

Parameters
Name Description
request ListPropertiesRequest
responseObserver io.grpc.stub.StreamObserver<ListPropertiesResponse>
public default void listRollupPropertySourceLinks(ListRollupPropertySourceLinksRequest request, StreamObserver<ListRollupPropertySourceLinksResponse> responseObserver)

Lists roll-up property source Links on a property. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

Parameters
Name Description
request ListRollupPropertySourceLinksRequest
responseObserver io.grpc.stub.StreamObserver<ListRollupPropertySourceLinksResponse>

listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request, StreamObserver<ListSKAdNetworkConversionValueSchemasResponse> responseObserver)

public default void listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request, StreamObserver<ListSKAdNetworkConversionValueSchemasResponse> responseObserver)

Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema.

Parameters
Name Description
request ListSKAdNetworkConversionValueSchemasRequest
responseObserver io.grpc.stub.StreamObserver<ListSKAdNetworkConversionValueSchemasResponse>
public default void listSearchAds360Links(ListSearchAds360LinksRequest request, StreamObserver<ListSearchAds360LinksResponse> responseObserver)

Lists all SearchAds360Links on a property.

Parameters
Name Description
request ListSearchAds360LinksRequest
responseObserver io.grpc.stub.StreamObserver<ListSearchAds360LinksResponse>

listSubpropertyEventFilters(ListSubpropertyEventFiltersRequest request, StreamObserver<ListSubpropertyEventFiltersResponse> responseObserver)

public default void listSubpropertyEventFilters(ListSubpropertyEventFiltersRequest request, StreamObserver<ListSubpropertyEventFiltersResponse> responseObserver)

List all subproperty Event Filters on a property.

Parameters
Name Description
request ListSubpropertyEventFiltersRequest
responseObserver io.grpc.stub.StreamObserver<ListSubpropertyEventFiltersResponse>

provisionAccountTicket(ProvisionAccountTicketRequest request, StreamObserver<ProvisionAccountTicketResponse> responseObserver)

public default void provisionAccountTicket(ProvisionAccountTicketRequest request, StreamObserver<ProvisionAccountTicketResponse> responseObserver)

Requests a ticket for creating an account.

Parameters
Name Description
request ProvisionAccountTicketRequest
responseObserver io.grpc.stub.StreamObserver<ProvisionAccountTicketResponse>

provisionSubproperty(ProvisionSubpropertyRequest request, StreamObserver<ProvisionSubpropertyResponse> responseObserver)

public default void provisionSubproperty(ProvisionSubpropertyRequest request, StreamObserver<ProvisionSubpropertyResponse> responseObserver)

Create a subproperty and a subproperty event filter that applies to the created subproperty.

Parameters
Name Description
request ProvisionSubpropertyRequest
responseObserver io.grpc.stub.StreamObserver<ProvisionSubpropertyResponse>

reorderEventEditRules(ReorderEventEditRulesRequest request, StreamObserver<Empty> responseObserver)

public default void reorderEventEditRules(ReorderEventEditRulesRequest request, StreamObserver<Empty> responseObserver)

Changes the processing order of event edit rules on the specified stream.

Parameters
Name Description
request ReorderEventEditRulesRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

runAccessReport(RunAccessReportRequest request, StreamObserver<RunAccessReportResponse> responseObserver)

public default void runAccessReport(RunAccessReportRequest request, StreamObserver<RunAccessReportResponse> responseObserver)

Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see searchChangeHistoryEvents.

Parameters
Name Description
request RunAccessReportRequest
responseObserver io.grpc.stub.StreamObserver<RunAccessReportResponse>

searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request, StreamObserver<SearchChangeHistoryEventsResponse> responseObserver)

public default void searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request, StreamObserver<SearchChangeHistoryEventsResponse> responseObserver)

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

Parameters
Name Description
request SearchChangeHistoryEventsRequest
responseObserver io.grpc.stub.StreamObserver<SearchChangeHistoryEventsResponse>

setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request, StreamObserver<SetAutomatedGa4ConfigurationOptOutResponse> responseObserver)

public default void setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request, StreamObserver<SetAutomatedGa4ConfigurationOptOutResponse> responseObserver)

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

Parameters
Name Description
request SetAutomatedGa4ConfigurationOptOutRequest
responseObserver io.grpc.stub.StreamObserver<SetAutomatedGa4ConfigurationOptOutResponse>

updateAccessBinding(UpdateAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

public default void updateAccessBinding(UpdateAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

Updates an access binding on an account or property.

Parameters
Name Description
request UpdateAccessBindingRequest
responseObserver io.grpc.stub.StreamObserver<AccessBinding>

updateAccount(UpdateAccountRequest request, StreamObserver<Account> responseObserver)

public default void updateAccount(UpdateAccountRequest request, StreamObserver<Account> responseObserver)

Updates an account.

Parameters
Name Description
request UpdateAccountRequest
responseObserver io.grpc.stub.StreamObserver<Account>

updateAttributionSettings(UpdateAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)

public default void updateAttributionSettings(UpdateAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)

Updates attribution settings on a property.

Parameters
Name Description
request UpdateAttributionSettingsRequest
responseObserver io.grpc.stub.StreamObserver<AttributionSettings>

updateAudience(UpdateAudienceRequest request, StreamObserver<Audience> responseObserver)

public default void updateAudience(UpdateAudienceRequest request, StreamObserver<Audience> responseObserver)

Updates an Audience on a property.

Parameters
Name Description
request UpdateAudienceRequest
responseObserver io.grpc.stub.StreamObserver<Audience>
public default void updateBigQueryLink(UpdateBigQueryLinkRequest request, StreamObserver<BigQueryLink> responseObserver)

Updates a BigQueryLink.

Parameters
Name Description
request UpdateBigQueryLinkRequest
responseObserver io.grpc.stub.StreamObserver<BigQueryLink>

updateCalculatedMetric(UpdateCalculatedMetricRequest request, StreamObserver<CalculatedMetric> responseObserver)

public default void updateCalculatedMetric(UpdateCalculatedMetricRequest request, StreamObserver<CalculatedMetric> responseObserver)

Updates a CalculatedMetric on a property.

Parameters
Name Description
request UpdateCalculatedMetricRequest
responseObserver io.grpc.stub.StreamObserver<CalculatedMetric>

updateChannelGroup(UpdateChannelGroupRequest request, StreamObserver<ChannelGroup> responseObserver)

public default void updateChannelGroup(UpdateChannelGroupRequest request, StreamObserver<ChannelGroup> responseObserver)

Updates a ChannelGroup.

Parameters
Name Description
request UpdateChannelGroupRequest
responseObserver io.grpc.stub.StreamObserver<ChannelGroup>

updateConversionEvent(UpdateConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver) (deprecated)

public default void updateConversionEvent(UpdateConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)

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

Parameters
Name Description
request UpdateConversionEventRequest
responseObserver io.grpc.stub.StreamObserver<ConversionEvent>

updateCustomDimension(UpdateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

public default void updateCustomDimension(UpdateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

Updates a CustomDimension on a property.

Parameters
Name Description
request UpdateCustomDimensionRequest
responseObserver io.grpc.stub.StreamObserver<CustomDimension>

updateCustomMetric(UpdateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

public default void updateCustomMetric(UpdateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

Updates a CustomMetric on a property.

Parameters
Name Description
request UpdateCustomMetricRequest
responseObserver io.grpc.stub.StreamObserver<CustomMetric>

updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request, StreamObserver<DataRedactionSettings> responseObserver)

public default void updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request, StreamObserver<DataRedactionSettings> responseObserver)

Updates a DataRedactionSettings on a property.

Parameters
Name Description
request UpdateDataRedactionSettingsRequest
responseObserver io.grpc.stub.StreamObserver<DataRedactionSettings>

updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)

public default void updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)

Updates the singleton data retention settings for this property.

Parameters
Name Description
request UpdateDataRetentionSettingsRequest
responseObserver io.grpc.stub.StreamObserver<DataRetentionSettings>

updateDataStream(UpdateDataStreamRequest request, StreamObserver<DataStream> responseObserver)

public default void updateDataStream(UpdateDataStreamRequest request, StreamObserver<DataStream> responseObserver)

Updates a DataStream on a property.

Parameters
Name Description
request UpdateDataStreamRequest
responseObserver io.grpc.stub.StreamObserver<DataStream>
public default void updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)

Updates a DisplayVideo360AdvertiserLink on a property.

Parameters
Name Description
request UpdateDisplayVideo360AdvertiserLinkRequest
responseObserver io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLink>

updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request, StreamObserver<EnhancedMeasurementSettings> responseObserver)

public default void updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request, StreamObserver<EnhancedMeasurementSettings> responseObserver)

Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Parameters
Name Description
request UpdateEnhancedMeasurementSettingsRequest
responseObserver io.grpc.stub.StreamObserver<EnhancedMeasurementSettings>

updateEventCreateRule(UpdateEventCreateRuleRequest request, StreamObserver<EventCreateRule> responseObserver)

public default void updateEventCreateRule(UpdateEventCreateRuleRequest request, StreamObserver<EventCreateRule> responseObserver)

Updates an EventCreateRule.

Parameters
Name Description
request UpdateEventCreateRuleRequest
responseObserver io.grpc.stub.StreamObserver<EventCreateRule>

updateEventEditRule(UpdateEventEditRuleRequest request, StreamObserver<EventEditRule> responseObserver)

public default void updateEventEditRule(UpdateEventEditRuleRequest request, StreamObserver<EventEditRule> responseObserver)

Updates an EventEditRule.

Parameters
Name Description
request UpdateEventEditRuleRequest
responseObserver io.grpc.stub.StreamObserver<EventEditRule>

updateExpandedDataSet(UpdateExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

public default void updateExpandedDataSet(UpdateExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

Updates a ExpandedDataSet on a property.

Parameters
Name Description
request UpdateExpandedDataSetRequest
responseObserver io.grpc.stub.StreamObserver<ExpandedDataSet>
public default void updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request, StreamObserver<GoogleAdsLink> responseObserver)

Updates a GoogleAdsLink on a property

Parameters
Name Description
request UpdateGoogleAdsLinkRequest
responseObserver io.grpc.stub.StreamObserver<GoogleAdsLink>

updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)

public default void updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)

Updates Google Signals settings for a property.

Parameters
Name Description
request UpdateGoogleSignalsSettingsRequest
responseObserver io.grpc.stub.StreamObserver<GoogleSignalsSettings>

updateKeyEvent(UpdateKeyEventRequest request, StreamObserver<KeyEvent> responseObserver)

public default void updateKeyEvent(UpdateKeyEventRequest request, StreamObserver<KeyEvent> responseObserver)

Updates a Key Event.

Parameters
Name Description
request UpdateKeyEventRequest
responseObserver io.grpc.stub.StreamObserver<KeyEvent>

updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

public default void updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

Updates a measurement protocol secret.

Parameters
Name Description
request UpdateMeasurementProtocolSecretRequest
responseObserver io.grpc.stub.StreamObserver<MeasurementProtocolSecret>

updateProperty(UpdatePropertyRequest request, StreamObserver<Property> responseObserver)

public default void updateProperty(UpdatePropertyRequest request, StreamObserver<Property> responseObserver)

Updates a property.

Parameters
Name Description
request UpdatePropertyRequest
responseObserver io.grpc.stub.StreamObserver<Property>

updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request, StreamObserver<SKAdNetworkConversionValueSchema> responseObserver)

public default void updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request, StreamObserver<SKAdNetworkConversionValueSchema> responseObserver)

Updates a SKAdNetworkConversionValueSchema.

Parameters
Name Description
request UpdateSKAdNetworkConversionValueSchemaRequest
responseObserver io.grpc.stub.StreamObserver<SKAdNetworkConversionValueSchema>
public default void updateSearchAds360Link(UpdateSearchAds360LinkRequest request, StreamObserver<SearchAds360Link> responseObserver)

Updates a SearchAds360Link on a property.

Parameters
Name Description
request UpdateSearchAds360LinkRequest
responseObserver io.grpc.stub.StreamObserver<SearchAds360Link>

updateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest request, StreamObserver<SubpropertyEventFilter> responseObserver)

public default void updateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest request, StreamObserver<SubpropertyEventFilter> responseObserver)

Updates a subproperty Event Filter.

Parameters
Name Description
request UpdateSubpropertyEventFilterRequest
responseObserver io.grpc.stub.StreamObserver<SubpropertyEventFilter>