Package com.google.analytics.admin.v1beta

Class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub>
com.google.analytics.admin.v1beta.AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub
Enclosing class:
AnalyticsAdminServiceGrpc
public static final class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub extends io.grpc.stub.AbstractFutureStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service AnalyticsAdminService. 
 Service Interface for the Google Analytics Admin API.

  • Method Details

    • build

      protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub>

    • getAccount

      public com.google.common.util.concurrent.ListenableFuture<Account> getAccount(GetAccountRequest request)
       Lookup for a single Account.

    • listAccounts

      public com.google.common.util.concurrent.ListenableFuture<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.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<Account> updateAccount(UpdateAccountRequest request)
       Updates an account.

    • provisionAccountTicket

      public com.google.common.util.concurrent.ListenableFuture<ProvisionAccountTicketResponse> provisionAccountTicket(ProvisionAccountTicketRequest request)
       Requests a ticket for creating an account.

    • listAccountSummaries

      public com.google.common.util.concurrent.ListenableFuture<ListAccountSummariesResponse> listAccountSummaries(ListAccountSummariesRequest request)
       Returns summaries of all accounts accessible by the caller.

    • getProperty

      public com.google.common.util.concurrent.ListenableFuture<Property> getProperty(GetPropertyRequest request)
       Lookup for a single GA Property.

    • listProperties

      public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<Property> createProperty(CreatePropertyRequest request)
       Creates a Google Analytics property with the specified location and
 attributes.

    • deleteProperty

      public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<Property> updateProperty(UpdatePropertyRequest request)
       Updates a property.

    • createFirebaseLink

      public com.google.common.util.concurrent.ListenableFuture<FirebaseLink> createFirebaseLink(CreateFirebaseLinkRequest request)
       Creates a FirebaseLink.
 Properties can have at most one FirebaseLink.

    • deleteFirebaseLink

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteFirebaseLink(DeleteFirebaseLinkRequest request)
       Deletes a FirebaseLink on a property

    • listFirebaseLinks

      public com.google.common.util.concurrent.ListenableFuture<ListFirebaseLinksResponse> listFirebaseLinks(ListFirebaseLinksRequest request)
       Lists FirebaseLinks on a property.
 Properties can have at most one FirebaseLink.

    • createGoogleAdsLink

      public com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink> createGoogleAdsLink(CreateGoogleAdsLinkRequest request)
       Creates a GoogleAdsLink.

    • updateGoogleAdsLink

      public com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink> updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)
       Updates a GoogleAdsLink on a property

    • deleteGoogleAdsLink

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)
       Deletes a GoogleAdsLink on a property

    • listGoogleAdsLinks

      public com.google.common.util.concurrent.ListenableFuture<ListGoogleAdsLinksResponse> listGoogleAdsLinks(ListGoogleAdsLinksRequest request)
       Lists GoogleAdsLinks on a property.

    • getDataSharingSettings

      public com.google.common.util.concurrent.ListenableFuture<DataSharingSettings> getDataSharingSettings(GetDataSharingSettingsRequest request)
       Get data sharing settings on an account.
 Data sharing settings are singletons.

    • getMeasurementProtocolSecret

      public com.google.common.util.concurrent.ListenableFuture<MeasurementProtocolSecret> getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)
       Lookup for a single MeasurementProtocolSecret.

    • listMeasurementProtocolSecrets

      public com.google.common.util.concurrent.ListenableFuture<ListMeasurementProtocolSecretsResponse> listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)
       Returns child MeasurementProtocolSecrets under the specified parent
 Property.

    • createMeasurementProtocolSecret

      public com.google.common.util.concurrent.ListenableFuture<MeasurementProtocolSecret> createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)
       Creates a measurement protocol secret.

    • deleteMeasurementProtocolSecret

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)
       Deletes target MeasurementProtocolSecret.

    • updateMeasurementProtocolSecret

      public com.google.common.util.concurrent.ListenableFuture<MeasurementProtocolSecret> updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)
       Updates a measurement protocol secret.

    • acknowledgeUserDataCollection

      public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<ConversionEvent> createConversionEvent(CreateConversionEventRequest request)
      Deprecated.
       Deprecated: Use `CreateKeyEvent` instead.
 Creates a conversion event with the specified attributes.

    • updateConversionEvent

      @Deprecated public com.google.common.util.concurrent.ListenableFuture<ConversionEvent> updateConversionEvent(UpdateConversionEventRequest request)
      Deprecated.
       Deprecated: Use `UpdateKeyEvent` instead.
 Updates a conversion event with the specified attributes.

    • getConversionEvent

      @Deprecated public com.google.common.util.concurrent.ListenableFuture<ConversionEvent> getConversionEvent(GetConversionEventRequest request)
      Deprecated.
       Deprecated: Use `GetKeyEvent` instead.
 Retrieve a single conversion event.

    • deleteConversionEvent

      @Deprecated public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteConversionEvent(DeleteConversionEventRequest request)
      Deprecated.
       Deprecated: Use `DeleteKeyEvent` instead.
 Deletes a conversion event in a property.

    • listConversionEvents

      @Deprecated public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<KeyEvent> createKeyEvent(CreateKeyEventRequest request)
       Creates a Key Event.

    • updateKeyEvent

      public com.google.common.util.concurrent.ListenableFuture<KeyEvent> updateKeyEvent(UpdateKeyEventRequest request)
       Updates a Key Event.

    • getKeyEvent

      public com.google.common.util.concurrent.ListenableFuture<KeyEvent> getKeyEvent(GetKeyEventRequest request)
       Retrieve a single Key Event.

    • deleteKeyEvent

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteKeyEvent(DeleteKeyEventRequest request)
       Deletes a Key Event.

    • listKeyEvents

      public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<CustomDimension> createCustomDimension(CreateCustomDimensionRequest request)
       Creates a CustomDimension.

    • updateCustomDimension

      public com.google.common.util.concurrent.ListenableFuture<CustomDimension> updateCustomDimension(UpdateCustomDimensionRequest request)
       Updates a CustomDimension on a property.

    • listCustomDimensions

      public com.google.common.util.concurrent.ListenableFuture<ListCustomDimensionsResponse> listCustomDimensions(ListCustomDimensionsRequest request)
       Lists CustomDimensions on a property.

    • archiveCustomDimension

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> archiveCustomDimension(ArchiveCustomDimensionRequest request)
       Archives a CustomDimension on a property.

    • getCustomDimension

      public com.google.common.util.concurrent.ListenableFuture<CustomDimension> getCustomDimension(GetCustomDimensionRequest request)
       Lookup for a single CustomDimension.

    • createCustomMetric

      public com.google.common.util.concurrent.ListenableFuture<CustomMetric> createCustomMetric(CreateCustomMetricRequest request)
       Creates a CustomMetric.

    • updateCustomMetric

      public com.google.common.util.concurrent.ListenableFuture<CustomMetric> updateCustomMetric(UpdateCustomMetricRequest request)
       Updates a CustomMetric on a property.

    • listCustomMetrics

      public com.google.common.util.concurrent.ListenableFuture<ListCustomMetricsResponse> listCustomMetrics(ListCustomMetricsRequest request)
       Lists CustomMetrics on a property.

    • archiveCustomMetric

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> archiveCustomMetric(ArchiveCustomMetricRequest request)
       Archives a CustomMetric on a property.

    • getCustomMetric

      public com.google.common.util.concurrent.ListenableFuture<CustomMetric> getCustomMetric(GetCustomMetricRequest request)
       Lookup for a single CustomMetric.

    • getDataRetentionSettings

      public com.google.common.util.concurrent.ListenableFuture<DataRetentionSettings> getDataRetentionSettings(GetDataRetentionSettingsRequest request)
       Returns the singleton data retention settings for this property.

    • updateDataRetentionSettings

      public com.google.common.util.concurrent.ListenableFuture<DataRetentionSettings> updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)
       Updates the singleton data retention settings for this property.

    • createDataStream

      public com.google.common.util.concurrent.ListenableFuture<DataStream> createDataStream(CreateDataStreamRequest request)
       Creates a DataStream.

    • deleteDataStream

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteDataStream(DeleteDataStreamRequest request)
       Deletes a DataStream on a property.

    • updateDataStream

      public com.google.common.util.concurrent.ListenableFuture<DataStream> updateDataStream(UpdateDataStreamRequest request)
       Updates a DataStream on a property.

    • listDataStreams

      public com.google.common.util.concurrent.ListenableFuture<ListDataStreamsResponse> listDataStreams(ListDataStreamsRequest request)
       Lists DataStreams on a property.

    • getDataStream

      public com.google.common.util.concurrent.ListenableFuture<DataStream> getDataStream(GetDataStreamRequest request)
       Lookup for a single DataStream.

    • runAccessReport

      public com.google.common.util.concurrent.ListenableFuture<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.