Package com.google.analytics.admin.v1beta

Class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub>

com.google.analytics.admin.v1beta.AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub

Enclosing class:

AnalyticsAdminServiceGrpc

public static final class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub>

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

 Service Interface for the Google Analytics Admin API.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
AcknowledgeUserDataCollectionResponse	acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)	Acknowledges the terms of user data collection for the specified property.
com.google.protobuf.Empty	archiveCustomDimension(ArchiveCustomDimensionRequest request)	Archives a CustomDimension on a property.
com.google.protobuf.Empty	archiveCustomMetric(ArchiveCustomMetricRequest request)	Archives a CustomMetric on a property.
protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
ConversionEvent	createConversionEvent(CreateConversionEventRequest request)	Deprecated.
CustomDimension	createCustomDimension(CreateCustomDimensionRequest request)	Creates a CustomDimension.
CustomMetric	createCustomMetric(CreateCustomMetricRequest request)	Creates a CustomMetric.
DataStream	createDataStream(CreateDataStreamRequest request)	Creates a DataStream.
FirebaseLink	createFirebaseLink(CreateFirebaseLinkRequest request)	Creates a FirebaseLink.
GoogleAdsLink	createGoogleAdsLink(CreateGoogleAdsLinkRequest request)	Creates a GoogleAdsLink.
KeyEvent	createKeyEvent(CreateKeyEventRequest request)	Creates a Key Event.
MeasurementProtocolSecret	createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)	Creates a measurement protocol secret.
Property	createProperty(CreatePropertyRequest request)	Creates a Google Analytics property with the specified location and attributes.
com.google.protobuf.Empty	deleteAccount(DeleteAccountRequest request)	Marks target Account as soft-deleted (ie: "trashed") and returns it.
com.google.protobuf.Empty	deleteConversionEvent(DeleteConversionEventRequest request)	Deprecated.
com.google.protobuf.Empty	deleteDataStream(DeleteDataStreamRequest request)	Deletes a DataStream on a property.
com.google.protobuf.Empty	deleteFirebaseLink(DeleteFirebaseLinkRequest request)	Deletes a FirebaseLink on a property
com.google.protobuf.Empty	deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)	Deletes a GoogleAdsLink on a property
com.google.protobuf.Empty	deleteKeyEvent(DeleteKeyEventRequest request)	Deletes a Key Event.
com.google.protobuf.Empty	deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)	Deletes target MeasurementProtocolSecret.
Property	deleteProperty(DeletePropertyRequest request)	Marks target Property as soft-deleted (ie: "trashed") and returns it.
Account	getAccount(GetAccountRequest request)	Lookup for a single Account.
ConversionEvent	getConversionEvent(GetConversionEventRequest request)	Deprecated.
CustomDimension	getCustomDimension(GetCustomDimensionRequest request)	Lookup for a single CustomDimension.
CustomMetric	getCustomMetric(GetCustomMetricRequest request)	Lookup for a single CustomMetric.
DataRetentionSettings	getDataRetentionSettings(GetDataRetentionSettingsRequest request)	Returns the singleton data retention settings for this property.
DataSharingSettings	getDataSharingSettings(GetDataSharingSettingsRequest request)	Get data sharing settings on an account.
DataStream	getDataStream(GetDataStreamRequest request)	Lookup for a single DataStream.
KeyEvent	getKeyEvent(GetKeyEventRequest request)	Retrieve a single Key Event.
MeasurementProtocolSecret	getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)	Lookup for a single MeasurementProtocolSecret.
Property	getProperty(GetPropertyRequest request)	Lookup for a single GA Property.
ListAccountsResponse	listAccounts(ListAccountsRequest request)	Returns all accounts accessible by the caller.
ListAccountSummariesResponse	listAccountSummaries(ListAccountSummariesRequest request)	Returns summaries of all accounts accessible by the caller.
ListConversionEventsResponse	listConversionEvents(ListConversionEventsRequest request)	Deprecated.
ListCustomDimensionsResponse	listCustomDimensions(ListCustomDimensionsRequest request)	Lists CustomDimensions on a property.
ListCustomMetricsResponse	listCustomMetrics(ListCustomMetricsRequest request)	Lists CustomMetrics on a property.
ListDataStreamsResponse	listDataStreams(ListDataStreamsRequest request)	Lists DataStreams on a property.
ListFirebaseLinksResponse	listFirebaseLinks(ListFirebaseLinksRequest request)	Lists FirebaseLinks on a property.
ListGoogleAdsLinksResponse	listGoogleAdsLinks(ListGoogleAdsLinksRequest request)	Lists GoogleAdsLinks on a property.
ListKeyEventsResponse	listKeyEvents(ListKeyEventsRequest request)	Returns a list of Key Events in the specified parent property.
ListMeasurementProtocolSecretsResponse	listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)	Returns child MeasurementProtocolSecrets under the specified parent Property.
ListPropertiesResponse	listProperties(ListPropertiesRequest request)	Returns child Properties under the specified parent Account.
ProvisionAccountTicketResponse	provisionAccountTicket(ProvisionAccountTicketRequest request)	Requests a ticket for creating an account.
RunAccessReportResponse	runAccessReport(RunAccessReportRequest request)	Returns a customized report of data access records.
SearchChangeHistoryEventsResponse	searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)	Searches through all changes to an account or its children given the specified set of filters.
Account	updateAccount(UpdateAccountRequest request)	Updates an account.
ConversionEvent	updateConversionEvent(UpdateConversionEventRequest request)	Deprecated.
CustomDimension	updateCustomDimension(UpdateCustomDimensionRequest request)	Updates a CustomDimension on a property.
CustomMetric	updateCustomMetric(UpdateCustomMetricRequest request)	Updates a CustomMetric on a property.
DataRetentionSettings	updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)	Updates the singleton data retention settings for this property.
DataStream	updateDataStream(UpdateDataStreamRequest request)	Updates a DataStream on a property.
GoogleAdsLink	updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)	Updates a GoogleAdsLink on a property
KeyEvent	updateKeyEvent(UpdateKeyEventRequest request)	Updates a Key Event.
MeasurementProtocolSecret	updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)	Updates a measurement protocol secret.
Property	updateProperty(UpdatePropertyRequest request)	Updates a property.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub>

getAccount

public Account getAccount(GetAccountRequest request)

 Lookup for a single Account.
 

listAccounts

public ListAccountsResponse listAccounts(ListAccountsRequest request)

 Returns all accounts accessible by the caller.
 Note that these accounts might not currently have GA properties.
 Soft-deleted (ie: "trashed") accounts are excluded by default.
 Returns an empty list if no relevant accounts are found.
 

deleteAccount

public com.google.protobuf.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,
 AccessBindings) will be permanently purged.
 https://support.google.com/analytics/answer/6154772
 Returns an error if the target is not found.
 

updateAccount

public Account updateAccount(UpdateAccountRequest request)

 Updates an account.
 

provisionAccountTicket

public ProvisionAccountTicketResponse provisionAccountTicket(ProvisionAccountTicketRequest request)

 Requests a ticket for creating an account.
 

listAccountSummaries

public ListAccountSummariesResponse listAccountSummaries(ListAccountSummariesRequest request)

 Returns summaries of all accounts accessible by the caller.
 

getProperty

public Property getProperty(GetPropertyRequest request)

 Lookup for a single GA Property.
 

listProperties

public ListPropertiesResponse listProperties(ListPropertiesRequest request)

 Returns child Properties under the specified parent Account.
 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.
 

createProperty

public Property createProperty(CreatePropertyRequest request)

 Creates a Google Analytics property with the specified location and
 attributes.
 

deleteProperty

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, AccessBindings)
 will be permanently purged.
 https://support.google.com/analytics/answer/6154772
 Returns an error if the target is not found.
 

updateProperty

public Property updateProperty(UpdatePropertyRequest request)

 Updates a property.
 

createFirebaseLink

public FirebaseLink createFirebaseLink(CreateFirebaseLinkRequest request)

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

deleteFirebaseLink

public com.google.protobuf.Empty deleteFirebaseLink(DeleteFirebaseLinkRequest request)

 Deletes a FirebaseLink on a property
 

listFirebaseLinks

public ListFirebaseLinksResponse listFirebaseLinks(ListFirebaseLinksRequest request)

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

createGoogleAdsLink

public GoogleAdsLink createGoogleAdsLink(CreateGoogleAdsLinkRequest request)

 Creates a GoogleAdsLink.
 

updateGoogleAdsLink

public GoogleAdsLink updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

 Updates a GoogleAdsLink on a property
 

deleteGoogleAdsLink

public com.google.protobuf.Empty deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)

 Deletes a GoogleAdsLink on a property
 

listGoogleAdsLinks

public ListGoogleAdsLinksResponse listGoogleAdsLinks(ListGoogleAdsLinksRequest request)

 Lists GoogleAdsLinks on a property.
 

getDataSharingSettings

public DataSharingSettings getDataSharingSettings(GetDataSharingSettingsRequest request)

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

getMeasurementProtocolSecret

public MeasurementProtocolSecret getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

 Lookup for a single MeasurementProtocolSecret.
 

listMeasurementProtocolSecrets

public ListMeasurementProtocolSecretsResponse listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

 Returns child MeasurementProtocolSecrets under the specified parent
 Property.
 

createMeasurementProtocolSecret

public MeasurementProtocolSecret createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

 Creates a measurement protocol secret.
 

deleteMeasurementProtocolSecret

public com.google.protobuf.Empty deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

 Deletes target MeasurementProtocolSecret.
 

updateMeasurementProtocolSecret

public MeasurementProtocolSecret updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

 Updates a measurement protocol secret.
 

acknowledgeUserDataCollection

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.
 

searchChangeHistoryEvents

public SearchChangeHistoryEventsResponse searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

 Searches through all changes to an account or its children given the
 specified set of filters.
 Only returns the subset of changes supported by the API. The UI may return
 additional changes.
 

createConversionEvent

@Deprecated
public ConversionEvent createConversionEvent(CreateConversionEventRequest request)

Deprecated.

 Deprecated: Use `CreateKeyEvent` instead.
 Creates a conversion event with the specified attributes.
 

updateConversionEvent

@Deprecated
public ConversionEvent updateConversionEvent(UpdateConversionEventRequest request)

Deprecated.

 Deprecated: Use `UpdateKeyEvent` instead.
 Updates a conversion event with the specified attributes.
 

getConversionEvent

@Deprecated
public ConversionEvent getConversionEvent(GetConversionEventRequest request)

Deprecated.

 Deprecated: Use `GetKeyEvent` instead.
 Retrieve a single conversion event.
 

deleteConversionEvent

@Deprecated
public com.google.protobuf.Empty deleteConversionEvent(DeleteConversionEventRequest request)

Deprecated.

 Deprecated: Use `DeleteKeyEvent` instead.
 Deletes a conversion event in a property.
 

listConversionEvents

@Deprecated
public ListConversionEventsResponse listConversionEvents(ListConversionEventsRequest request)

Deprecated.

 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.
 

createKeyEvent

public KeyEvent createKeyEvent(CreateKeyEventRequest request)

 Creates a Key Event.
 

updateKeyEvent

public KeyEvent updateKeyEvent(UpdateKeyEventRequest request)

 Updates a Key Event.
 

getKeyEvent

public KeyEvent getKeyEvent(GetKeyEventRequest request)

 Retrieve a single Key Event.
 

deleteKeyEvent

public com.google.protobuf.Empty deleteKeyEvent(DeleteKeyEventRequest request)

 Deletes a Key Event.
 

listKeyEvents

public ListKeyEventsResponse listKeyEvents(ListKeyEventsRequest request)

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

createCustomDimension

public CustomDimension createCustomDimension(CreateCustomDimensionRequest request)

 Creates a CustomDimension.
 

updateCustomDimension

public CustomDimension updateCustomDimension(UpdateCustomDimensionRequest request)

 Updates a CustomDimension on a property.
 

listCustomDimensions

public ListCustomDimensionsResponse listCustomDimensions(ListCustomDimensionsRequest request)

 Lists CustomDimensions on a property.
 

archiveCustomDimension

public com.google.protobuf.Empty archiveCustomDimension(ArchiveCustomDimensionRequest request)

 Archives a CustomDimension on a property.
 

getCustomDimension

public CustomDimension getCustomDimension(GetCustomDimensionRequest request)

 Lookup for a single CustomDimension.
 

createCustomMetric

public CustomMetric createCustomMetric(CreateCustomMetricRequest request)

 Creates a CustomMetric.
 

updateCustomMetric

public CustomMetric updateCustomMetric(UpdateCustomMetricRequest request)

 Updates a CustomMetric on a property.
 

listCustomMetrics

public ListCustomMetricsResponse listCustomMetrics(ListCustomMetricsRequest request)

 Lists CustomMetrics on a property.
 

archiveCustomMetric

public com.google.protobuf.Empty archiveCustomMetric(ArchiveCustomMetricRequest request)

 Archives a CustomMetric on a property.
 

getCustomMetric

public CustomMetric getCustomMetric(GetCustomMetricRequest request)

 Lookup for a single CustomMetric.
 

getDataRetentionSettings

public DataRetentionSettings getDataRetentionSettings(GetDataRetentionSettingsRequest request)

 Returns the singleton data retention settings for this property.
 

updateDataRetentionSettings

public DataRetentionSettings updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

 Updates the singleton data retention settings for this property.
 

createDataStream

public DataStream createDataStream(CreateDataStreamRequest request)

 Creates a DataStream.
 

deleteDataStream

public com.google.protobuf.Empty deleteDataStream(DeleteDataStreamRequest request)

 Deletes a DataStream on a property.
 

updateDataStream

public DataStream updateDataStream(UpdateDataStreamRequest request)

 Updates a DataStream on a property.
 

listDataStreams

public ListDataStreamsResponse listDataStreams(ListDataStreamsRequest request)

 Lists DataStreams on a property.
 

getDataStream

public DataStream getDataStream(GetDataStreamRequest request)

 Lookup for a single DataStream.
 

runAccessReport

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. 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 GA UI Reporting, GA UI Explorations,
 GA 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](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
 To give your feedback on this API, complete the [Google Analytics Access
 Reports
 feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform)
 form.