- 0.70.0 (latest)
- 0.69.0
- 0.68.0
- 0.67.0
- 0.66.0
- 0.65.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.61.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
public abstract static class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceImplBase implements BindableService
Service Interface for the Analytics Admin API (GA4).
Implements
io.grpc.BindableServiceConstructors
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.
Name | Description |
request | AcknowledgeUserDataCollectionRequest |
responseObserver | io.grpc.stub.StreamObserver<AcknowledgeUserDataCollectionResponse> |
archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver responseObserver)
public void archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver responseObserver)
Archives a CustomDimension on a property.
Name | Description |
request | ArchiveCustomDimensionRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver responseObserver)
public void archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver responseObserver)
Archives a CustomMetric on a property.
Name | Description |
request | ArchiveCustomMetricRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
bindService()
public final ServerServiceDefinition bindService()
Type | Description |
io.grpc.ServerServiceDefinition |
createConversionEvent(CreateConversionEventRequest request, StreamObserver responseObserver)
public void createConversionEvent(CreateConversionEventRequest request, StreamObserver responseObserver)
Creates a conversion event with the specified attributes.
Name | Description |
request | CreateConversionEventRequest |
responseObserver | io.grpc.stub.StreamObserver<ConversionEvent> |
createCustomDimension(CreateCustomDimensionRequest request, StreamObserver responseObserver)
public void createCustomDimension(CreateCustomDimensionRequest request, StreamObserver responseObserver)
Creates a CustomDimension.
Name | Description |
request | CreateCustomDimensionRequest |
responseObserver | io.grpc.stub.StreamObserver<CustomDimension> |
createCustomMetric(CreateCustomMetricRequest request, StreamObserver responseObserver)
public void createCustomMetric(CreateCustomMetricRequest request, StreamObserver responseObserver)
Creates a CustomMetric.
Name | Description |
request | CreateCustomMetricRequest |
responseObserver | io.grpc.stub.StreamObserver<CustomMetric> |
createDataStream(CreateDataStreamRequest request, StreamObserver responseObserver)
public void createDataStream(CreateDataStreamRequest request, StreamObserver responseObserver)
Creates a DataStream.
Name | Description |
request | CreateDataStreamRequest |
responseObserver | io.grpc.stub.StreamObserver<DataStream> |
createFirebaseLink(CreateFirebaseLinkRequest request, StreamObserver responseObserver)
public void createFirebaseLink(CreateFirebaseLinkRequest request, StreamObserver responseObserver)
Creates a FirebaseLink. Properties can have at most one FirebaseLink.
Name | Description |
request | CreateFirebaseLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<FirebaseLink> |
createGoogleAdsLink(CreateGoogleAdsLinkRequest request, StreamObserver responseObserver)
public void createGoogleAdsLink(CreateGoogleAdsLinkRequest request, StreamObserver responseObserver)
Creates a GoogleAdsLink.
Name | Description |
request | CreateGoogleAdsLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<GoogleAdsLink> |
createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver responseObserver)
public void createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver responseObserver)
Creates a measurement protocol secret.
Name | Description |
request | CreateMeasurementProtocolSecretRequest |
responseObserver | io.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.
Name | Description |
request | CreatePropertyRequest |
responseObserver | io.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.
Name | Description |
request | DeleteAccountRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver responseObserver)
public void deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver responseObserver)
Deletes a conversion event in a property.
Name | Description |
request | DeleteConversionEventRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteDataStream(DeleteDataStreamRequest request, StreamObserver responseObserver)
public void deleteDataStream(DeleteDataStreamRequest request, StreamObserver responseObserver)
Deletes a DataStream on a property.
Name | Description |
request | DeleteDataStreamRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteFirebaseLink(DeleteFirebaseLinkRequest request, StreamObserver responseObserver)
public void deleteFirebaseLink(DeleteFirebaseLinkRequest request, StreamObserver responseObserver)
Deletes a FirebaseLink on a property
Name | Description |
request | DeleteFirebaseLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, StreamObserver responseObserver)
public void deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, StreamObserver responseObserver)
Deletes a GoogleAdsLink on a property
Name | Description |
request | DeleteGoogleAdsLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver responseObserver)
public void deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver responseObserver)
Deletes target MeasurementProtocolSecret.
Name | Description |
request | DeleteMeasurementProtocolSecretRequest |
responseObserver | io.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.
Name | Description |
request | DeletePropertyRequest |
responseObserver | io.grpc.stub.StreamObserver<Property> |
getAccount(GetAccountRequest request, StreamObserver responseObserver)
public void getAccount(GetAccountRequest request, StreamObserver responseObserver)
Lookup for a single Account.
Name | Description |
request | GetAccountRequest |
responseObserver | io.grpc.stub.StreamObserver<Account> |
getConversionEvent(GetConversionEventRequest request, StreamObserver responseObserver)
public void getConversionEvent(GetConversionEventRequest request, StreamObserver responseObserver)
Retrieve a single conversion event.
Name | Description |
request | GetConversionEventRequest |
responseObserver | io.grpc.stub.StreamObserver<ConversionEvent> |
getCustomDimension(GetCustomDimensionRequest request, StreamObserver responseObserver)
public void getCustomDimension(GetCustomDimensionRequest request, StreamObserver responseObserver)
Lookup for a single CustomDimension.
Name | Description |
request | GetCustomDimensionRequest |
responseObserver | io.grpc.stub.StreamObserver<CustomDimension> |
getCustomMetric(GetCustomMetricRequest request, StreamObserver responseObserver)
public void getCustomMetric(GetCustomMetricRequest request, StreamObserver responseObserver)
Lookup for a single CustomMetric.
Name | Description |
request | GetCustomMetricRequest |
responseObserver | io.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.
Name | Description |
request | GetDataRetentionSettingsRequest |
responseObserver | io.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.
Name | Description |
request | GetDataSharingSettingsRequest |
responseObserver | io.grpc.stub.StreamObserver<DataSharingSettings> |
getDataStream(GetDataStreamRequest request, StreamObserver responseObserver)
public void getDataStream(GetDataStreamRequest request, StreamObserver responseObserver)
Lookup for a single DataStream.
Name | Description |
request | GetDataStreamRequest |
responseObserver | io.grpc.stub.StreamObserver<DataStream> |
getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, StreamObserver responseObserver)
public void getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, StreamObserver responseObserver)
Lookup for a single "GA4" MeasurementProtocolSecret.
Name | Description |
request | GetMeasurementProtocolSecretRequest |
responseObserver | io.grpc.stub.StreamObserver<MeasurementProtocolSecret> |
getProperty(GetPropertyRequest request, StreamObserver responseObserver)
public void getProperty(GetPropertyRequest request, StreamObserver responseObserver)
Lookup for a single "GA4" Property.
Name | Description |
request | GetPropertyRequest |
responseObserver | io.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.
Name | Description |
request | ListAccountSummariesRequest |
responseObserver | io.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.
Name | Description |
request | ListAccountsRequest |
responseObserver | io.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.
Name | Description |
request | ListConversionEventsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListConversionEventsResponse> |
listCustomDimensions(ListCustomDimensionsRequest request, StreamObserver responseObserver)
public void listCustomDimensions(ListCustomDimensionsRequest request, StreamObserver responseObserver)
Lists CustomDimensions on a property.
Name | Description |
request | ListCustomDimensionsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListCustomDimensionsResponse> |
listCustomMetrics(ListCustomMetricsRequest request, StreamObserver responseObserver)
public void listCustomMetrics(ListCustomMetricsRequest request, StreamObserver responseObserver)
Lists CustomMetrics on a property.
Name | Description |
request | ListCustomMetricsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListCustomMetricsResponse> |
listDataStreams(ListDataStreamsRequest request, StreamObserver responseObserver)
public void listDataStreams(ListDataStreamsRequest request, StreamObserver responseObserver)
Lists DataStreams on a property.
Name | Description |
request | ListDataStreamsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListDataStreamsResponse> |
listFirebaseLinks(ListFirebaseLinksRequest request, StreamObserver responseObserver)
public void listFirebaseLinks(ListFirebaseLinksRequest request, StreamObserver responseObserver)
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
Name | Description |
request | ListFirebaseLinksRequest |
responseObserver | io.grpc.stub.StreamObserver<ListFirebaseLinksResponse> |
listGoogleAdsLinks(ListGoogleAdsLinksRequest request, StreamObserver responseObserver)
public void listGoogleAdsLinks(ListGoogleAdsLinksRequest request, StreamObserver responseObserver)
Lists GoogleAdsLinks on a property.
Name | Description |
request | ListGoogleAdsLinksRequest |
responseObserver | io.grpc.stub.StreamObserver<ListGoogleAdsLinksResponse> |
listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, StreamObserver responseObserver)
public void listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, StreamObserver responseObserver)
Returns child MeasurementProtocolSecrets under the specified parent Property.
Name | Description |
request | ListMeasurementProtocolSecretsRequest |
responseObserver | io.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.
Name | Description |
request | ListPropertiesRequest |
responseObserver | io.grpc.stub.StreamObserver<ListPropertiesResponse> |
provisionAccountTicket(ProvisionAccountTicketRequest request, StreamObserver responseObserver)
public void provisionAccountTicket(ProvisionAccountTicketRequest request, StreamObserver responseObserver)
Requests a ticket for creating an account.
Name | Description |
request | ProvisionAccountTicketRequest |
responseObserver | io.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.
Name | Description |
request | SearchChangeHistoryEventsRequest |
responseObserver | io.grpc.stub.StreamObserver<SearchChangeHistoryEventsResponse> |
updateAccount(UpdateAccountRequest request, StreamObserver responseObserver)
public void updateAccount(UpdateAccountRequest request, StreamObserver responseObserver)
Updates an account.
Name | Description |
request | UpdateAccountRequest |
responseObserver | io.grpc.stub.StreamObserver<Account> |
updateCustomDimension(UpdateCustomDimensionRequest request, StreamObserver responseObserver)
public void updateCustomDimension(UpdateCustomDimensionRequest request, StreamObserver responseObserver)
Updates a CustomDimension on a property.
Name | Description |
request | UpdateCustomDimensionRequest |
responseObserver | io.grpc.stub.StreamObserver<CustomDimension> |
updateCustomMetric(UpdateCustomMetricRequest request, StreamObserver responseObserver)
public void updateCustomMetric(UpdateCustomMetricRequest request, StreamObserver responseObserver)
Updates a CustomMetric on a property.
Name | Description |
request | UpdateCustomMetricRequest |
responseObserver | io.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.
Name | Description |
request | UpdateDataRetentionSettingsRequest |
responseObserver | io.grpc.stub.StreamObserver<DataRetentionSettings> |
updateDataStream(UpdateDataStreamRequest request, StreamObserver responseObserver)
public void updateDataStream(UpdateDataStreamRequest request, StreamObserver responseObserver)
Updates a DataStream on a property.
Name | Description |
request | UpdateDataStreamRequest |
responseObserver | io.grpc.stub.StreamObserver<DataStream> |
updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request, StreamObserver responseObserver)
public void updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request, StreamObserver responseObserver)
Updates a GoogleAdsLink on a property
Name | Description |
request | UpdateGoogleAdsLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<GoogleAdsLink> |
updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, StreamObserver responseObserver)
public void updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, StreamObserver responseObserver)
Updates a measurement protocol secret.
Name | Description |
request | UpdateMeasurementProtocolSecretRequest |
responseObserver | io.grpc.stub.StreamObserver<MeasurementProtocolSecret> |
updateProperty(UpdatePropertyRequest request, StreamObserver responseObserver)
public void updateProperty(UpdatePropertyRequest request, StreamObserver responseObserver)
Updates a property.
Name | Description |
request | UpdatePropertyRequest |
responseObserver | io.grpc.stub.StreamObserver<Property> |