Package com.google.analytics.admin.v1beta

Interface AnalyticsAdminServiceGrpc.AsyncService

All Known Implementing Classes:
AnalyticsAdminServiceGrpc.AnalyticsAdminServiceImplBase
Enclosing class:
AnalyticsAdminServiceGrpc
public static interface AnalyticsAdminServiceGrpc.AsyncService
 Service Interface for the Google Analytics Admin API.

  • Method Details

    • getAccount

      default void getAccount(GetAccountRequest request, io.grpc.stub.StreamObserver<Account> responseObserver)
       Lookup for a single Account.

    • listAccounts

      default void listAccounts(ListAccountsRequest request, io.grpc.stub.StreamObserver<ListAccountsResponse> responseObserver)
       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

      default void deleteAccount(DeleteAccountRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> 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,
 AccessBindings) will be permanently purged.
 https://support.google.com/analytics/answer/6154772
 Returns an error if the target is not found.

    • updateAccount

      default void updateAccount(UpdateAccountRequest request, io.grpc.stub.StreamObserver<Account> responseObserver)
       Updates an account.

    • provisionAccountTicket

      default void provisionAccountTicket(ProvisionAccountTicketRequest request, io.grpc.stub.StreamObserver<ProvisionAccountTicketResponse> responseObserver)
       Requests a ticket for creating an account.

    • listAccountSummaries

      default void listAccountSummaries(ListAccountSummariesRequest request, io.grpc.stub.StreamObserver<ListAccountSummariesResponse> responseObserver)
       Returns summaries of all accounts accessible by the caller.

    • getProperty

      default void getProperty(GetPropertyRequest request, io.grpc.stub.StreamObserver<Property> responseObserver)
       Lookup for a single GA Property.

    • listProperties

      default void listProperties(ListPropertiesRequest request, io.grpc.stub.StreamObserver<ListPropertiesResponse> responseObserver)
       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

      default void createProperty(CreatePropertyRequest request, io.grpc.stub.StreamObserver<Property> responseObserver)
       Creates a Google Analytics property with the specified location and
 attributes.

    • deleteProperty

      default void deleteProperty(DeletePropertyRequest request, io.grpc.stub.StreamObserver<Property> 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, AccessBindings)
 will be permanently purged.
 https://support.google.com/analytics/answer/6154772
 Returns an error if the target is not found.

    • updateProperty

      default void updateProperty(UpdatePropertyRequest request, io.grpc.stub.StreamObserver<Property> responseObserver)
       Updates a property.

    • createFirebaseLink

      default void createFirebaseLink(CreateFirebaseLinkRequest request, io.grpc.stub.StreamObserver<FirebaseLink> responseObserver)
       Creates a FirebaseLink.
 Properties can have at most one FirebaseLink.

    • deleteFirebaseLink

      default void deleteFirebaseLink(DeleteFirebaseLinkRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes a FirebaseLink on a property

    • listFirebaseLinks

      default void listFirebaseLinks(ListFirebaseLinksRequest request, io.grpc.stub.StreamObserver<ListFirebaseLinksResponse> responseObserver)
       Lists FirebaseLinks on a property.
 Properties can have at most one FirebaseLink.

    • createGoogleAdsLink

      default void createGoogleAdsLink(CreateGoogleAdsLinkRequest request, io.grpc.stub.StreamObserver<GoogleAdsLink> responseObserver)
       Creates a GoogleAdsLink.

    • updateGoogleAdsLink

      default void updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request, io.grpc.stub.StreamObserver<GoogleAdsLink> responseObserver)
       Updates a GoogleAdsLink on a property

    • deleteGoogleAdsLink

      default void deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes a GoogleAdsLink on a property

    • listGoogleAdsLinks

      default void listGoogleAdsLinks(ListGoogleAdsLinksRequest request, io.grpc.stub.StreamObserver<ListGoogleAdsLinksResponse> responseObserver)
       Lists GoogleAdsLinks on a property.

    • getDataSharingSettings

      default void getDataSharingSettings(GetDataSharingSettingsRequest request, io.grpc.stub.StreamObserver<DataSharingSettings> responseObserver)
       Get data sharing settings on an account.
 Data sharing settings are singletons.

    • getMeasurementProtocolSecret

      default void getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, io.grpc.stub.StreamObserver<MeasurementProtocolSecret> responseObserver)
       Lookup for a single MeasurementProtocolSecret.

    • listMeasurementProtocolSecrets

      default void listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, io.grpc.stub.StreamObserver<ListMeasurementProtocolSecretsResponse> responseObserver)
       Returns child MeasurementProtocolSecrets under the specified parent
 Property.

    • createMeasurementProtocolSecret

      default void createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, io.grpc.stub.StreamObserver<MeasurementProtocolSecret> responseObserver)
       Creates a measurement protocol secret.

    • deleteMeasurementProtocolSecret

      default void deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes target MeasurementProtocolSecret.

    • updateMeasurementProtocolSecret

      default void updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, io.grpc.stub.StreamObserver<MeasurementProtocolSecret> responseObserver)
       Updates a measurement protocol secret.

    • acknowledgeUserDataCollection

      default void acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, io.grpc.stub.StreamObserver<AcknowledgeUserDataCollectionResponse> responseObserver)
       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

      default void searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request, io.grpc.stub.StreamObserver<SearchChangeHistoryEventsResponse> responseObserver)
       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 default void createConversionEvent(CreateConversionEventRequest request, io.grpc.stub.StreamObserver<ConversionEvent> responseObserver)
      Deprecated.
       Deprecated: Use `CreateKeyEvent` instead.
 Creates a conversion event with the specified attributes.

    • updateConversionEvent

      @Deprecated default void updateConversionEvent(UpdateConversionEventRequest request, io.grpc.stub.StreamObserver<ConversionEvent> responseObserver)
      Deprecated.
       Deprecated: Use `UpdateKeyEvent` instead.
 Updates a conversion event with the specified attributes.

    • getConversionEvent

      @Deprecated default void getConversionEvent(GetConversionEventRequest request, io.grpc.stub.StreamObserver<ConversionEvent> responseObserver)
      Deprecated.
       Deprecated: Use `GetKeyEvent` instead.
 Retrieve a single conversion event.

    • deleteConversionEvent

      @Deprecated default void deleteConversionEvent(DeleteConversionEventRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
      Deprecated.
       Deprecated: Use `DeleteKeyEvent` instead.
 Deletes a conversion event in a property.

    • listConversionEvents

      @Deprecated default void listConversionEvents(ListConversionEventsRequest request, io.grpc.stub.StreamObserver<ListConversionEventsResponse> responseObserver)
      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

      default void createKeyEvent(CreateKeyEventRequest request, io.grpc.stub.StreamObserver<KeyEvent> responseObserver)
       Creates a Key Event.

    • updateKeyEvent

      default void updateKeyEvent(UpdateKeyEventRequest request, io.grpc.stub.StreamObserver<KeyEvent> responseObserver)
       Updates a Key Event.

    • getKeyEvent

      default void getKeyEvent(GetKeyEventRequest request, io.grpc.stub.StreamObserver<KeyEvent> responseObserver)
       Retrieve a single Key Event.

    • deleteKeyEvent

      default void deleteKeyEvent(DeleteKeyEventRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes a Key Event.

    • listKeyEvents

      default void listKeyEvents(ListKeyEventsRequest request, io.grpc.stub.StreamObserver<ListKeyEventsResponse> responseObserver)
       Returns a list of Key Events in the specified parent property.
 Returns an empty list if no Key Events are found.

    • createCustomDimension

      default void createCustomDimension(CreateCustomDimensionRequest request, io.grpc.stub.StreamObserver<CustomDimension> responseObserver)
       Creates a CustomDimension.

    • updateCustomDimension

      default void updateCustomDimension(UpdateCustomDimensionRequest request, io.grpc.stub.StreamObserver<CustomDimension> responseObserver)
       Updates a CustomDimension on a property.

    • listCustomDimensions

      default void listCustomDimensions(ListCustomDimensionsRequest request, io.grpc.stub.StreamObserver<ListCustomDimensionsResponse> responseObserver)
       Lists CustomDimensions on a property.

    • archiveCustomDimension

      default void archiveCustomDimension(ArchiveCustomDimensionRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Archives a CustomDimension on a property.

    • getCustomDimension

      default void getCustomDimension(GetCustomDimensionRequest request, io.grpc.stub.StreamObserver<CustomDimension> responseObserver)
       Lookup for a single CustomDimension.

    • createCustomMetric

      default void createCustomMetric(CreateCustomMetricRequest request, io.grpc.stub.StreamObserver<CustomMetric> responseObserver)
       Creates a CustomMetric.

    • updateCustomMetric

      default void updateCustomMetric(UpdateCustomMetricRequest request, io.grpc.stub.StreamObserver<CustomMetric> responseObserver)
       Updates a CustomMetric on a property.

    • listCustomMetrics

      default void listCustomMetrics(ListCustomMetricsRequest request, io.grpc.stub.StreamObserver<ListCustomMetricsResponse> responseObserver)
       Lists CustomMetrics on a property.

    • archiveCustomMetric

      default void archiveCustomMetric(ArchiveCustomMetricRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Archives a CustomMetric on a property.

    • getCustomMetric

      default void getCustomMetric(GetCustomMetricRequest request, io.grpc.stub.StreamObserver<CustomMetric> responseObserver)
       Lookup for a single CustomMetric.

    • getDataRetentionSettings

      default void getDataRetentionSettings(GetDataRetentionSettingsRequest request, io.grpc.stub.StreamObserver<DataRetentionSettings> responseObserver)
       Returns the singleton data retention settings for this property.

    • updateDataRetentionSettings

      default void updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, io.grpc.stub.StreamObserver<DataRetentionSettings> responseObserver)
       Updates the singleton data retention settings for this property.

    • createDataStream

      default void createDataStream(CreateDataStreamRequest request, io.grpc.stub.StreamObserver<DataStream> responseObserver)
       Creates a DataStream.

    • deleteDataStream

      default void deleteDataStream(DeleteDataStreamRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes a DataStream on a property.

    • updateDataStream

      default void updateDataStream(UpdateDataStreamRequest request, io.grpc.stub.StreamObserver<DataStream> responseObserver)
       Updates a DataStream on a property.

    • listDataStreams

      default void listDataStreams(ListDataStreamsRequest request, io.grpc.stub.StreamObserver<ListDataStreamsResponse> responseObserver)
       Lists DataStreams on a property.

    • getDataStream

      default void getDataStream(GetDataStreamRequest request, io.grpc.stub.StreamObserver<DataStream> responseObserver)
       Lookup for a single DataStream.

    • runAccessReport

      default void runAccessReport(RunAccessReportRequest request, io.grpc.stub.StreamObserver<RunAccessReportResponse> responseObserver)
       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.