public static final class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub extends AbstractBlockingStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub>
Service Interface for the Analytics Admin API (GA4).
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)
public AcknowledgeUserDataCollectionResponse acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)
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.
archiveCustomDimension(ArchiveCustomDimensionRequest request)
public Empty archiveCustomDimension(ArchiveCustomDimensionRequest request)
Archives a CustomDimension on a property.
archiveCustomMetric(ArchiveCustomMetricRequest request)
public Empty archiveCustomMetric(ArchiveCustomMetricRequest request)
Archives a CustomMetric on a property.
build(Channel channel, CallOptions callOptions)
protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
| Name | Description |
channel | io.grpc.Channel
|
callOptions | io.grpc.CallOptions
|
Returns
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createConversionEvent(CreateConversionEventRequest request)
public ConversionEvent createConversionEvent(CreateConversionEventRequest request)
Creates a conversion event with the specified attributes.
createCustomDimension(CreateCustomDimensionRequest request)
public CustomDimension createCustomDimension(CreateCustomDimensionRequest request)
Creates a CustomDimension.
createCustomMetric(CreateCustomMetricRequest request)
public CustomMetric createCustomMetric(CreateCustomMetricRequest request)
Parameter
Returns
createDataStream(CreateDataStreamRequest request)
public DataStream createDataStream(CreateDataStreamRequest request)
Parameter
Returns
createFirebaseLink(CreateFirebaseLinkRequest request)
public FirebaseLink createFirebaseLink(CreateFirebaseLinkRequest request)
Creates a FirebaseLink.
Properties can have at most one FirebaseLink.
createGoogleAdsLink(CreateGoogleAdsLinkRequest request)
public GoogleAdsLink createGoogleAdsLink(CreateGoogleAdsLinkRequest request)
Parameter
Returns
createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)
public MeasurementProtocolSecret createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)
Creates a measurement protocol secret.
createProperty(CreatePropertyRequest request)
public Property createProperty(CreatePropertyRequest request)
Creates an "GA4" property with the specified location and attributes.
deleteAccount(DeleteAccountRequest request)
public Empty deleteAccount(DeleteAccountRequest request)
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.
deleteConversionEvent(DeleteConversionEventRequest request)
public Empty deleteConversionEvent(DeleteConversionEventRequest request)
Deletes a conversion event in a property.
deleteDataStream(DeleteDataStreamRequest request)
public Empty deleteDataStream(DeleteDataStreamRequest request)
Deletes a DataStream on a property.
deleteFirebaseLink(DeleteFirebaseLinkRequest request)
public Empty deleteFirebaseLink(DeleteFirebaseLinkRequest request)
Deletes a FirebaseLink on a property
deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)
public Empty deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)
Deletes a GoogleAdsLink on a property
deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)
public Empty deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)
Deletes target MeasurementProtocolSecret.
deleteProperty(DeletePropertyRequest request)
public Property deleteProperty(DeletePropertyRequest request)
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.
getAccount(GetAccountRequest request)
public Account getAccount(GetAccountRequest request)
Lookup for a single Account.
getConversionEvent(GetConversionEventRequest request)
public ConversionEvent getConversionEvent(GetConversionEventRequest request)
Retrieve a single conversion event.
getCustomDimension(GetCustomDimensionRequest request)
public CustomDimension getCustomDimension(GetCustomDimensionRequest request)
Lookup for a single CustomDimension.
getCustomMetric(GetCustomMetricRequest request)
public CustomMetric getCustomMetric(GetCustomMetricRequest request)
Lookup for a single CustomMetric.
getDataRetentionSettings(GetDataRetentionSettingsRequest request)
public DataRetentionSettings getDataRetentionSettings(GetDataRetentionSettingsRequest request)
Returns the singleton data retention settings for this property.
getDataSharingSettings(GetDataSharingSettingsRequest request)
public DataSharingSettings getDataSharingSettings(GetDataSharingSettingsRequest request)
Get data sharing settings on an account.
Data sharing settings are singletons.
getDataStream(GetDataStreamRequest request)
public DataStream getDataStream(GetDataStreamRequest request)
Lookup for a single DataStream.
getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)
public MeasurementProtocolSecret getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)
Lookup for a single "GA4" MeasurementProtocolSecret.
getProperty(GetPropertyRequest request)
public Property getProperty(GetPropertyRequest request)
Lookup for a single "GA4" Property.
listAccountSummaries(ListAccountSummariesRequest request)
public ListAccountSummariesResponse listAccountSummaries(ListAccountSummariesRequest request)
Returns summaries of all accounts accessible by the caller.
listAccounts(ListAccountsRequest request)
public ListAccountsResponse listAccounts(ListAccountsRequest request)
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.
listConversionEvents(ListConversionEventsRequest request)
public ListConversionEventsResponse listConversionEvents(ListConversionEventsRequest request)
Returns a list of conversion events in the specified parent property.
Returns an empty list if no conversion events are found.
listCustomDimensions(ListCustomDimensionsRequest request)
public ListCustomDimensionsResponse listCustomDimensions(ListCustomDimensionsRequest request)
Lists CustomDimensions on a property.
listCustomMetrics(ListCustomMetricsRequest request)
public ListCustomMetricsResponse listCustomMetrics(ListCustomMetricsRequest request)
Lists CustomMetrics on a property.
listDataStreams(ListDataStreamsRequest request)
public ListDataStreamsResponse listDataStreams(ListDataStreamsRequest request)
Lists DataStreams on a property.
listFirebaseLinks(ListFirebaseLinksRequest request)
public ListFirebaseLinksResponse listFirebaseLinks(ListFirebaseLinksRequest request)
Lists FirebaseLinks on a property.
Properties can have at most one FirebaseLink.
listGoogleAdsLinks(ListGoogleAdsLinksRequest request)
public ListGoogleAdsLinksResponse listGoogleAdsLinks(ListGoogleAdsLinksRequest request)
Lists GoogleAdsLinks on a property.
listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)
public ListMeasurementProtocolSecretsResponse listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)
Returns child MeasurementProtocolSecrets under the specified parent
Property.
listProperties(ListPropertiesRequest request)
public ListPropertiesResponse listProperties(ListPropertiesRequest request)
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.
provisionAccountTicket(ProvisionAccountTicketRequest request)
public ProvisionAccountTicketResponse provisionAccountTicket(ProvisionAccountTicketRequest request)
Requests a ticket for creating an account.
searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)
public SearchChangeHistoryEventsResponse searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)
Searches through all changes to an account or its children given the
specified set of filters.
updateAccount(UpdateAccountRequest request)
public Account updateAccount(UpdateAccountRequest request)
Parameter
Returns
updateCustomDimension(UpdateCustomDimensionRequest request)
public CustomDimension updateCustomDimension(UpdateCustomDimensionRequest request)
Updates a CustomDimension on a property.
updateCustomMetric(UpdateCustomMetricRequest request)
public CustomMetric updateCustomMetric(UpdateCustomMetricRequest request)
Updates a CustomMetric on a property.
updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)
public DataRetentionSettings updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)
Updates the singleton data retention settings for this property.
updateDataStream(UpdateDataStreamRequest request)
public DataStream updateDataStream(UpdateDataStreamRequest request)
Updates a DataStream on a property.
updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)
public GoogleAdsLink updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)
Updates a GoogleAdsLink on a property
updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)
public MeasurementProtocolSecret updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)
Updates a measurement protocol secret.
updateProperty(UpdatePropertyRequest request)
public Property updateProperty(UpdatePropertyRequest request)
Parameter
Returns
