Class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceStub (0.57.0)

public static final class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceStub extends AbstractAsyncStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceStub>

A stub to allow clients to do asynchronous rpc calls to service AnalyticsAdminService.

Service Interface for the Analytics Admin API (GA4).

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > AnalyticsAdminServiceGrpc.AnalyticsAdminServiceStub

Methods

acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, StreamObserver<AcknowledgeUserDataCollectionResponse> responseObserver)

public 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>

archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver<Empty> responseObserver)

public 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 void archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver<Empty> responseObserver)

Archives a CustomMetric on a property.

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

build(Channel channel, CallOptions callOptions)

protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
AnalyticsAdminServiceGrpc.AnalyticsAdminServiceStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

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

public 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 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 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 void createDataStream(CreateDataStreamRequest request, StreamObserver<DataStream> responseObserver)

Creates a DataStream.

Parameters
Name Description
request CreateDataStreamRequest
responseObserver io.grpc.stub.StreamObserver<DataStream>
public 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 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 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 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 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>

deleteAccount(DeleteAccountRequest request, StreamObserver<Empty> responseObserver)

public 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>

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

public 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 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 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 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 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 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 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>

getAccount(GetAccountRequest request, StreamObserver<Account> responseObserver)

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

Lookup for a single Account.

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

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

public 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 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 void getCustomMetric(GetCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

Lookup for a single CustomMetric.

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

getDataRetentionSettings(GetDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)

public 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 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 void getDataStream(GetDataStreamRequest request, StreamObserver<DataStream> responseObserver)

Lookup for a single DataStream.

Parameters
Name Description
request GetDataStreamRequest
responseObserver io.grpc.stub.StreamObserver<DataStream>

getKeyEvent(GetKeyEventRequest request, StreamObserver<KeyEvent> responseObserver)

public 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 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 void getProperty(GetPropertyRequest request, StreamObserver<Property> responseObserver)

Lookup for a single "GA4" Property.

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

listAccountSummaries(ListAccountSummariesRequest request, StreamObserver<ListAccountSummariesResponse> responseObserver)

public 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 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>

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

public 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 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 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 void listDataStreams(ListDataStreamsRequest request, StreamObserver<ListDataStreamsResponse> responseObserver)

Lists DataStreams on a property.

Parameters
Name Description
request ListDataStreamsRequest
responseObserver io.grpc.stub.StreamObserver<ListDataStreamsResponse>
public 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 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 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 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 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>

provisionAccountTicket(ProvisionAccountTicketRequest request, StreamObserver<ProvisionAccountTicketResponse> responseObserver)

public 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>

runAccessReport(RunAccessReportRequest request, StreamObserver<RunAccessReportResponse> responseObserver)

public 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 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>

updateAccount(UpdateAccountRequest request, StreamObserver<Account> responseObserver)

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

Updates an account.

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

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

public 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 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 void updateCustomMetric(UpdateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

Updates a CustomMetric on a property.

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

updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)

public 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 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 void updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request, StreamObserver<GoogleAdsLink> responseObserver)

Updates a GoogleAdsLink on a property

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

updateKeyEvent(UpdateKeyEventRequest request, StreamObserver<KeyEvent> responseObserver)

public 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 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 void updateProperty(UpdatePropertyRequest request, StreamObserver<Property> responseObserver)

Updates a property.

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