Class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub (0.24.0)

public static final class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub extends AbstractBlockingStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub>

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

Service Interface for the Analytics Admin API (GA4).

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub

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 through this API) before MeasurementProtocolSecret resources may be created.

Parameter
NameDescription
requestAcknowledgeUserDataCollectionRequest
Returns
TypeDescription
AcknowledgeUserDataCollectionResponse

archiveCustomDimension(ArchiveCustomDimensionRequest request)

public Empty archiveCustomDimension(ArchiveCustomDimensionRequest request)

Archives a CustomDimension on a property.

Parameter
NameDescription
requestArchiveCustomDimensionRequest
Returns
TypeDescription
Empty

archiveCustomMetric(ArchiveCustomMetricRequest request)

public Empty archiveCustomMetric(ArchiveCustomMetricRequest request)

Archives a CustomMetric on a property.

Parameter
NameDescription
requestArchiveCustomMetricRequest
Returns
TypeDescription
Empty

build(Channel channel, CallOptions callOptions)

protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub
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.

Parameter
NameDescription
requestCreateConversionEventRequest
Returns
TypeDescription
ConversionEvent

createCustomDimension(CreateCustomDimensionRequest request)

public CustomDimension createCustomDimension(CreateCustomDimensionRequest request)

Creates a CustomDimension.

Parameter
NameDescription
requestCreateCustomDimensionRequest
Returns
TypeDescription
CustomDimension

createCustomMetric(CreateCustomMetricRequest request)

public CustomMetric createCustomMetric(CreateCustomMetricRequest request)

Creates a CustomMetric.

Parameter
NameDescription
requestCreateCustomMetricRequest
Returns
TypeDescription
CustomMetric

createDataStream(CreateDataStreamRequest request)

public DataStream createDataStream(CreateDataStreamRequest request)

Creates a DataStream.

Parameter
NameDescription
requestCreateDataStreamRequest
Returns
TypeDescription
DataStream
public FirebaseLink createFirebaseLink(CreateFirebaseLinkRequest request)

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

Parameter
NameDescription
requestCreateFirebaseLinkRequest
Returns
TypeDescription
FirebaseLink
public GoogleAdsLink createGoogleAdsLink(CreateGoogleAdsLinkRequest request)

Creates a GoogleAdsLink.

Parameter
NameDescription
requestCreateGoogleAdsLinkRequest
Returns
TypeDescription
GoogleAdsLink

createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

public MeasurementProtocolSecret createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

Creates a measurement protocol secret.

Parameter
NameDescription
requestCreateMeasurementProtocolSecretRequest
Returns
TypeDescription
MeasurementProtocolSecret

createProperty(CreatePropertyRequest request)

public Property createProperty(CreatePropertyRequest request)

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

Parameter
NameDescription
requestCreatePropertyRequest
Returns
TypeDescription
Property

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.

Parameter
NameDescription
requestDeleteAccountRequest
Returns
TypeDescription
Empty

deleteConversionEvent(DeleteConversionEventRequest request)

public Empty deleteConversionEvent(DeleteConversionEventRequest request)

Deletes a conversion event in a property.

Parameter
NameDescription
requestDeleteConversionEventRequest
Returns
TypeDescription
Empty

deleteDataStream(DeleteDataStreamRequest request)

public Empty deleteDataStream(DeleteDataStreamRequest request)

Deletes a DataStream on a property.

Parameter
NameDescription
requestDeleteDataStreamRequest
Returns
TypeDescription
Empty
public Empty deleteFirebaseLink(DeleteFirebaseLinkRequest request)

Deletes a FirebaseLink on a property

Parameter
NameDescription
requestDeleteFirebaseLinkRequest
Returns
TypeDescription
Empty
public Empty deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)

Deletes a GoogleAdsLink on a property

Parameter
NameDescription
requestDeleteGoogleAdsLinkRequest
Returns
TypeDescription
Empty

deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

public Empty deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

Deletes target MeasurementProtocolSecret.

Parameter
NameDescription
requestDeleteMeasurementProtocolSecretRequest
Returns
TypeDescription
Empty

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 a GA4 Property.

Parameter
NameDescription
requestDeletePropertyRequest
Returns
TypeDescription
Property

getAccount(GetAccountRequest request)

public Account getAccount(GetAccountRequest request)

Lookup for a single Account.

Parameter
NameDescription
requestGetAccountRequest
Returns
TypeDescription
Account

getConversionEvent(GetConversionEventRequest request)

public ConversionEvent getConversionEvent(GetConversionEventRequest request)

Retrieve a single conversion event.

Parameter
NameDescription
requestGetConversionEventRequest
Returns
TypeDescription
ConversionEvent

getCustomDimension(GetCustomDimensionRequest request)

public CustomDimension getCustomDimension(GetCustomDimensionRequest request)

Lookup for a single CustomDimension.

Parameter
NameDescription
requestGetCustomDimensionRequest
Returns
TypeDescription
CustomDimension

getCustomMetric(GetCustomMetricRequest request)

public CustomMetric getCustomMetric(GetCustomMetricRequest request)

Lookup for a single CustomMetric.

Parameter
NameDescription
requestGetCustomMetricRequest
Returns
TypeDescription
CustomMetric

getDataRetentionSettings(GetDataRetentionSettingsRequest request)

public DataRetentionSettings getDataRetentionSettings(GetDataRetentionSettingsRequest request)

Returns the singleton data retention settings for this property.

Parameter
NameDescription
requestGetDataRetentionSettingsRequest
Returns
TypeDescription
DataRetentionSettings

getDataSharingSettings(GetDataSharingSettingsRequest request)

public DataSharingSettings getDataSharingSettings(GetDataSharingSettingsRequest request)

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

Parameter
NameDescription
requestGetDataSharingSettingsRequest
Returns
TypeDescription
DataSharingSettings

getDataStream(GetDataStreamRequest request)

public DataStream getDataStream(GetDataStreamRequest request)

Lookup for a single DataStream.

Parameter
NameDescription
requestGetDataStreamRequest
Returns
TypeDescription
DataStream

getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

public MeasurementProtocolSecret getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

Lookup for a single "GA4" MeasurementProtocolSecret.

Parameter
NameDescription
requestGetMeasurementProtocolSecretRequest
Returns
TypeDescription
MeasurementProtocolSecret

getProperty(GetPropertyRequest request)

public Property getProperty(GetPropertyRequest request)

Lookup for a single "GA4" Property.

Parameter
NameDescription
requestGetPropertyRequest
Returns
TypeDescription
Property

listAccountSummaries(ListAccountSummariesRequest request)

public ListAccountSummariesResponse listAccountSummaries(ListAccountSummariesRequest request)

Returns summaries of all accounts accessible by the caller.

Parameter
NameDescription
requestListAccountSummariesRequest
Returns
TypeDescription
ListAccountSummariesResponse

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.

Parameter
NameDescription
requestListAccountsRequest
Returns
TypeDescription
ListAccountsResponse

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.

Parameter
NameDescription
requestListConversionEventsRequest
Returns
TypeDescription
ListConversionEventsResponse

listCustomDimensions(ListCustomDimensionsRequest request)

public ListCustomDimensionsResponse listCustomDimensions(ListCustomDimensionsRequest request)

Lists CustomDimensions on a property.

Parameter
NameDescription
requestListCustomDimensionsRequest
Returns
TypeDescription
ListCustomDimensionsResponse

listCustomMetrics(ListCustomMetricsRequest request)

public ListCustomMetricsResponse listCustomMetrics(ListCustomMetricsRequest request)

Lists CustomMetrics on a property.

Parameter
NameDescription
requestListCustomMetricsRequest
Returns
TypeDescription
ListCustomMetricsResponse

listDataStreams(ListDataStreamsRequest request)

public ListDataStreamsResponse listDataStreams(ListDataStreamsRequest request)

Lists DataStreams on a property.

Parameter
NameDescription
requestListDataStreamsRequest
Returns
TypeDescription
ListDataStreamsResponse
public ListFirebaseLinksResponse listFirebaseLinks(ListFirebaseLinksRequest request)

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

Parameter
NameDescription
requestListFirebaseLinksRequest
Returns
TypeDescription
ListFirebaseLinksResponse
public ListGoogleAdsLinksResponse listGoogleAdsLinks(ListGoogleAdsLinksRequest request)

Lists GoogleAdsLinks on a property.

Parameter
NameDescription
requestListGoogleAdsLinksRequest
Returns
TypeDescription
ListGoogleAdsLinksResponse

listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

public ListMeasurementProtocolSecretsResponse listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Parameter
NameDescription
requestListMeasurementProtocolSecretsRequest
Returns
TypeDescription
ListMeasurementProtocolSecretsResponse

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.

Parameter
NameDescription
requestListPropertiesRequest
Returns
TypeDescription
ListPropertiesResponse

provisionAccountTicket(ProvisionAccountTicketRequest request)

public ProvisionAccountTicketResponse provisionAccountTicket(ProvisionAccountTicketRequest request)

Requests a ticket for creating an account.

Parameter
NameDescription
requestProvisionAccountTicketRequest
Returns
TypeDescription
ProvisionAccountTicketResponse

runAccessReport(RunAccessReportRequest request)

public RunAccessReportResponse runAccessReport(RunAccessReportRequest request)

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. The property must be in Google Analytics 360. 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.

Parameter
NameDescription
requestRunAccessReportRequest
Returns
TypeDescription
RunAccessReportResponse

searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

public SearchChangeHistoryEventsResponse searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

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

Parameter
NameDescription
requestSearchChangeHistoryEventsRequest
Returns
TypeDescription
SearchChangeHistoryEventsResponse

updateAccount(UpdateAccountRequest request)

public Account updateAccount(UpdateAccountRequest request)

Updates an account.

Parameter
NameDescription
requestUpdateAccountRequest
Returns
TypeDescription
Account

updateCustomDimension(UpdateCustomDimensionRequest request)

public CustomDimension updateCustomDimension(UpdateCustomDimensionRequest request)

Updates a CustomDimension on a property.

Parameter
NameDescription
requestUpdateCustomDimensionRequest
Returns
TypeDescription
CustomDimension

updateCustomMetric(UpdateCustomMetricRequest request)

public CustomMetric updateCustomMetric(UpdateCustomMetricRequest request)

Updates a CustomMetric on a property.

Parameter
NameDescription
requestUpdateCustomMetricRequest
Returns
TypeDescription
CustomMetric

updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

public DataRetentionSettings updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

Updates the singleton data retention settings for this property.

Parameter
NameDescription
requestUpdateDataRetentionSettingsRequest
Returns
TypeDescription
DataRetentionSettings

updateDataStream(UpdateDataStreamRequest request)

public DataStream updateDataStream(UpdateDataStreamRequest request)

Updates a DataStream on a property.

Parameter
NameDescription
requestUpdateDataStreamRequest
Returns
TypeDescription
DataStream
public GoogleAdsLink updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

Updates a GoogleAdsLink on a property

Parameter
NameDescription
requestUpdateGoogleAdsLinkRequest
Returns
TypeDescription
GoogleAdsLink

updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

public MeasurementProtocolSecret updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

Updates a measurement protocol secret.

Parameter
NameDescription
requestUpdateMeasurementProtocolSecretRequest
Returns
TypeDescription
MeasurementProtocolSecret

updateProperty(UpdatePropertyRequest request)

public Property updateProperty(UpdatePropertyRequest request)

Updates a property.

Parameter
NameDescription
requestUpdatePropertyRequest
Returns
TypeDescription
Property