Class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceImplBase (0.21.0)

public abstract static class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceImplBase implements BindableService

Service Interface for the Analytics Admin API (GA4).

Inheritance

java.lang.Object > AnalyticsAdminServiceGrpc.AnalyticsAdminServiceImplBase

Implements

io.grpc.BindableService

Constructors

AnalyticsAdminServiceImplBase()

public AnalyticsAdminServiceImplBase()

Methods

acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, StreamObserver responseObserver)

public void acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, StreamObserver responseObserver)

Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.

Parameters
NameDescription
requestAcknowledgeUserDataCollectionRequest
responseObserverio.grpc.stub.StreamObserver<AcknowledgeUserDataCollectionResponse>

archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver responseObserver)

public void archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver responseObserver)

Archives a CustomDimension on a property.

Parameters
NameDescription
requestArchiveCustomDimensionRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver responseObserver)

public void archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver responseObserver)

Archives a CustomMetric on a property.

Parameters
NameDescription
requestArchiveCustomMetricRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

bindService()

public final ServerServiceDefinition bindService()
Returns
TypeDescription
io.grpc.ServerServiceDefinition

createConversionEvent(CreateConversionEventRequest request, StreamObserver responseObserver)

public void createConversionEvent(CreateConversionEventRequest request, StreamObserver responseObserver)

Creates a conversion event with the specified attributes.

Parameters
NameDescription
requestCreateConversionEventRequest
responseObserverio.grpc.stub.StreamObserver<ConversionEvent>

createCustomDimension(CreateCustomDimensionRequest request, StreamObserver responseObserver)

public void createCustomDimension(CreateCustomDimensionRequest request, StreamObserver responseObserver)

Creates a CustomDimension.

Parameters
NameDescription
requestCreateCustomDimensionRequest
responseObserverio.grpc.stub.StreamObserver<CustomDimension>

createCustomMetric(CreateCustomMetricRequest request, StreamObserver responseObserver)

public void createCustomMetric(CreateCustomMetricRequest request, StreamObserver responseObserver)

Creates a CustomMetric.

Parameters
NameDescription
requestCreateCustomMetricRequest
responseObserverio.grpc.stub.StreamObserver<CustomMetric>

createDataStream(CreateDataStreamRequest request, StreamObserver responseObserver)

public void createDataStream(CreateDataStreamRequest request, StreamObserver responseObserver)

Creates a DataStream.

Parameters
NameDescription
requestCreateDataStreamRequest
responseObserverio.grpc.stub.StreamObserver<DataStream>
public void createFirebaseLink(CreateFirebaseLinkRequest request, StreamObserver responseObserver)

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

Parameters
NameDescription
requestCreateFirebaseLinkRequest
responseObserverio.grpc.stub.StreamObserver<FirebaseLink>
public void createGoogleAdsLink(CreateGoogleAdsLinkRequest request, StreamObserver responseObserver)

Creates a GoogleAdsLink.

Parameters
NameDescription
requestCreateGoogleAdsLinkRequest
responseObserverio.grpc.stub.StreamObserver<GoogleAdsLink>

createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver responseObserver)

public void createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver responseObserver)

Creates a measurement protocol secret.

Parameters
NameDescription
requestCreateMeasurementProtocolSecretRequest
responseObserverio.grpc.stub.StreamObserver<MeasurementProtocolSecret>

createProperty(CreatePropertyRequest request, StreamObserver responseObserver)

public void createProperty(CreatePropertyRequest request, StreamObserver responseObserver)

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

Parameters
NameDescription
requestCreatePropertyRequest
responseObserverio.grpc.stub.StreamObserver<Property>

deleteAccount(DeleteAccountRequest request, StreamObserver responseObserver)

public void deleteAccount(DeleteAccountRequest request, StreamObserver 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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.

Parameters
NameDescription
requestDeleteAccountRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver responseObserver)

public void deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver responseObserver)

Deletes a conversion event in a property.

Parameters
NameDescription
requestDeleteConversionEventRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteDataStream(DeleteDataStreamRequest request, StreamObserver responseObserver)

public void deleteDataStream(DeleteDataStreamRequest request, StreamObserver responseObserver)

Deletes a DataStream on a property.

Parameters
NameDescription
requestDeleteDataStreamRequest
responseObserverio.grpc.stub.StreamObserver<Empty>
public void deleteFirebaseLink(DeleteFirebaseLinkRequest request, StreamObserver responseObserver)

Deletes a FirebaseLink on a property

Parameters
NameDescription
requestDeleteFirebaseLinkRequest
responseObserverio.grpc.stub.StreamObserver<Empty>
public void deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, StreamObserver responseObserver)

Deletes a GoogleAdsLink on a property

Parameters
NameDescription
requestDeleteGoogleAdsLinkRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver responseObserver)

public void deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver responseObserver)

Deletes target MeasurementProtocolSecret.

Parameters
NameDescription
requestDeleteMeasurementProtocolSecretRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteProperty(DeletePropertyRequest request, StreamObserver responseObserver)

public void deleteProperty(DeletePropertyRequest request, StreamObserver 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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.

Parameters
NameDescription
requestDeletePropertyRequest
responseObserverio.grpc.stub.StreamObserver<Property>

getAccount(GetAccountRequest request, StreamObserver responseObserver)

public void getAccount(GetAccountRequest request, StreamObserver responseObserver)

Lookup for a single Account.

Parameters
NameDescription
requestGetAccountRequest
responseObserverio.grpc.stub.StreamObserver<Account>

getConversionEvent(GetConversionEventRequest request, StreamObserver responseObserver)

public void getConversionEvent(GetConversionEventRequest request, StreamObserver responseObserver)

Retrieve a single conversion event.

Parameters
NameDescription
requestGetConversionEventRequest
responseObserverio.grpc.stub.StreamObserver<ConversionEvent>

getCustomDimension(GetCustomDimensionRequest request, StreamObserver responseObserver)

public void getCustomDimension(GetCustomDimensionRequest request, StreamObserver responseObserver)

Lookup for a single CustomDimension.

Parameters
NameDescription
requestGetCustomDimensionRequest
responseObserverio.grpc.stub.StreamObserver<CustomDimension>

getCustomMetric(GetCustomMetricRequest request, StreamObserver responseObserver)

public void getCustomMetric(GetCustomMetricRequest request, StreamObserver responseObserver)

Lookup for a single CustomMetric.

Parameters
NameDescription
requestGetCustomMetricRequest
responseObserverio.grpc.stub.StreamObserver<CustomMetric>

getDataRetentionSettings(GetDataRetentionSettingsRequest request, StreamObserver responseObserver)

public void getDataRetentionSettings(GetDataRetentionSettingsRequest request, StreamObserver responseObserver)

Returns the singleton data retention settings for this property.

Parameters
NameDescription
requestGetDataRetentionSettingsRequest
responseObserverio.grpc.stub.StreamObserver<DataRetentionSettings>

getDataSharingSettings(GetDataSharingSettingsRequest request, StreamObserver responseObserver)

public void getDataSharingSettings(GetDataSharingSettingsRequest request, StreamObserver responseObserver)

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

Parameters
NameDescription
requestGetDataSharingSettingsRequest
responseObserverio.grpc.stub.StreamObserver<DataSharingSettings>

getDataStream(GetDataStreamRequest request, StreamObserver responseObserver)

public void getDataStream(GetDataStreamRequest request, StreamObserver responseObserver)

Lookup for a single DataStream.

Parameters
NameDescription
requestGetDataStreamRequest
responseObserverio.grpc.stub.StreamObserver<DataStream>

getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, StreamObserver responseObserver)

public void getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, StreamObserver responseObserver)

Lookup for a single "GA4" MeasurementProtocolSecret.

Parameters
NameDescription
requestGetMeasurementProtocolSecretRequest
responseObserverio.grpc.stub.StreamObserver<MeasurementProtocolSecret>

getProperty(GetPropertyRequest request, StreamObserver responseObserver)

public void getProperty(GetPropertyRequest request, StreamObserver responseObserver)

Lookup for a single "GA4" Property.

Parameters
NameDescription
requestGetPropertyRequest
responseObserverio.grpc.stub.StreamObserver<Property>

listAccountSummaries(ListAccountSummariesRequest request, StreamObserver responseObserver)

public void listAccountSummaries(ListAccountSummariesRequest request, StreamObserver responseObserver)

Returns summaries of all accounts accessible by the caller.

Parameters
NameDescription
requestListAccountSummariesRequest
responseObserverio.grpc.stub.StreamObserver<ListAccountSummariesResponse>

listAccounts(ListAccountsRequest request, StreamObserver responseObserver)

public void listAccounts(ListAccountsRequest request, StreamObserver 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
NameDescription
requestListAccountsRequest
responseObserverio.grpc.stub.StreamObserver<ListAccountsResponse>

listConversionEvents(ListConversionEventsRequest request, StreamObserver responseObserver)

public void listConversionEvents(ListConversionEventsRequest request, StreamObserver responseObserver)

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

Parameters
NameDescription
requestListConversionEventsRequest
responseObserverio.grpc.stub.StreamObserver<ListConversionEventsResponse>

listCustomDimensions(ListCustomDimensionsRequest request, StreamObserver responseObserver)

public void listCustomDimensions(ListCustomDimensionsRequest request, StreamObserver responseObserver)

Lists CustomDimensions on a property.

Parameters
NameDescription
requestListCustomDimensionsRequest
responseObserverio.grpc.stub.StreamObserver<ListCustomDimensionsResponse>

listCustomMetrics(ListCustomMetricsRequest request, StreamObserver responseObserver)

public void listCustomMetrics(ListCustomMetricsRequest request, StreamObserver responseObserver)

Lists CustomMetrics on a property.

Parameters
NameDescription
requestListCustomMetricsRequest
responseObserverio.grpc.stub.StreamObserver<ListCustomMetricsResponse>

listDataStreams(ListDataStreamsRequest request, StreamObserver responseObserver)

public void listDataStreams(ListDataStreamsRequest request, StreamObserver responseObserver)

Lists DataStreams on a property.

Parameters
NameDescription
requestListDataStreamsRequest
responseObserverio.grpc.stub.StreamObserver<ListDataStreamsResponse>
public void listFirebaseLinks(ListFirebaseLinksRequest request, StreamObserver responseObserver)

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

Parameters
NameDescription
requestListFirebaseLinksRequest
responseObserverio.grpc.stub.StreamObserver<ListFirebaseLinksResponse>
public void listGoogleAdsLinks(ListGoogleAdsLinksRequest request, StreamObserver responseObserver)

Lists GoogleAdsLinks on a property.

Parameters
NameDescription
requestListGoogleAdsLinksRequest
responseObserverio.grpc.stub.StreamObserver<ListGoogleAdsLinksResponse>

listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, StreamObserver responseObserver)

public void listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, StreamObserver responseObserver)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Parameters
NameDescription
requestListMeasurementProtocolSecretsRequest
responseObserverio.grpc.stub.StreamObserver<ListMeasurementProtocolSecretsResponse>

listProperties(ListPropertiesRequest request, StreamObserver responseObserver)

public void listProperties(ListPropertiesRequest request, StreamObserver 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
NameDescription
requestListPropertiesRequest
responseObserverio.grpc.stub.StreamObserver<ListPropertiesResponse>

provisionAccountTicket(ProvisionAccountTicketRequest request, StreamObserver responseObserver)

public void provisionAccountTicket(ProvisionAccountTicketRequest request, StreamObserver responseObserver)

Requests a ticket for creating an account.

Parameters
NameDescription
requestProvisionAccountTicketRequest
responseObserverio.grpc.stub.StreamObserver<ProvisionAccountTicketResponse>

searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request, StreamObserver responseObserver)

public void searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request, StreamObserver responseObserver)

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

Parameters
NameDescription
requestSearchChangeHistoryEventsRequest
responseObserverio.grpc.stub.StreamObserver<SearchChangeHistoryEventsResponse>

updateAccount(UpdateAccountRequest request, StreamObserver responseObserver)

public void updateAccount(UpdateAccountRequest request, StreamObserver responseObserver)

Updates an account.

Parameters
NameDescription
requestUpdateAccountRequest
responseObserverio.grpc.stub.StreamObserver<Account>

updateCustomDimension(UpdateCustomDimensionRequest request, StreamObserver responseObserver)

public void updateCustomDimension(UpdateCustomDimensionRequest request, StreamObserver responseObserver)

Updates a CustomDimension on a property.

Parameters
NameDescription
requestUpdateCustomDimensionRequest
responseObserverio.grpc.stub.StreamObserver<CustomDimension>

updateCustomMetric(UpdateCustomMetricRequest request, StreamObserver responseObserver)

public void updateCustomMetric(UpdateCustomMetricRequest request, StreamObserver responseObserver)

Updates a CustomMetric on a property.

Parameters
NameDescription
requestUpdateCustomMetricRequest
responseObserverio.grpc.stub.StreamObserver<CustomMetric>

updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, StreamObserver responseObserver)

public void updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, StreamObserver responseObserver)

Updates the singleton data retention settings for this property.

Parameters
NameDescription
requestUpdateDataRetentionSettingsRequest
responseObserverio.grpc.stub.StreamObserver<DataRetentionSettings>

updateDataStream(UpdateDataStreamRequest request, StreamObserver responseObserver)

public void updateDataStream(UpdateDataStreamRequest request, StreamObserver responseObserver)

Updates a DataStream on a property.

Parameters
NameDescription
requestUpdateDataStreamRequest
responseObserverio.grpc.stub.StreamObserver<DataStream>
public void updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request, StreamObserver responseObserver)

Updates a GoogleAdsLink on a property

Parameters
NameDescription
requestUpdateGoogleAdsLinkRequest
responseObserverio.grpc.stub.StreamObserver<GoogleAdsLink>

updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, StreamObserver responseObserver)

public void updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, StreamObserver responseObserver)

Updates a measurement protocol secret.

Parameters
NameDescription
requestUpdateMeasurementProtocolSecretRequest
responseObserverio.grpc.stub.StreamObserver<MeasurementProtocolSecret>

updateProperty(UpdatePropertyRequest request, StreamObserver responseObserver)

public void updateProperty(UpdatePropertyRequest request, StreamObserver responseObserver)

Updates a property.

Parameters
NameDescription
requestUpdatePropertyRequest
responseObserverio.grpc.stub.StreamObserver<Property>