Package com.google.analytics.admin.v1beta

Class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingV2Stub

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

  • Method Details

    • build

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

    • getAccount

      public Account getAccount(GetAccountRequest request) throws io.grpc.StatusException
       Lookup for a single Account.
      Throws:
      io.grpc.StatusException

    • listAccounts

      public ListAccountsResponse listAccounts(ListAccountsRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • deleteAccount

      public com.google.protobuf.Empty deleteAccount(DeleteAccountRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • updateAccount

      public Account updateAccount(UpdateAccountRequest request) throws io.grpc.StatusException
       Updates an account.
      Throws:
      io.grpc.StatusException

    • provisionAccountTicket

      public ProvisionAccountTicketResponse provisionAccountTicket(ProvisionAccountTicketRequest request) throws io.grpc.StatusException
       Requests a ticket for creating an account.
      Throws:
      io.grpc.StatusException

    • listAccountSummaries

      public ListAccountSummariesResponse listAccountSummaries(ListAccountSummariesRequest request) throws io.grpc.StatusException
       Returns summaries of all accounts accessible by the caller.
      Throws:
      io.grpc.StatusException

    • getProperty

      public Property getProperty(GetPropertyRequest request) throws io.grpc.StatusException
       Lookup for a single GA Property.
      Throws:
      io.grpc.StatusException

    • listProperties

      public ListPropertiesResponse listProperties(ListPropertiesRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • createProperty

      public Property createProperty(CreatePropertyRequest request) throws io.grpc.StatusException
       Creates a Google Analytics property with the specified location and
 attributes.
      Throws:
      io.grpc.StatusException

    • deleteProperty

      public Property deleteProperty(DeletePropertyRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • updateProperty

      public Property updateProperty(UpdatePropertyRequest request) throws io.grpc.StatusException
       Updates a property.
      Throws:
      io.grpc.StatusException

    • createFirebaseLink

      public FirebaseLink createFirebaseLink(CreateFirebaseLinkRequest request) throws io.grpc.StatusException
       Creates a FirebaseLink.
 Properties can have at most one FirebaseLink.
      Throws:
      io.grpc.StatusException

    • deleteFirebaseLink

      public com.google.protobuf.Empty deleteFirebaseLink(DeleteFirebaseLinkRequest request) throws io.grpc.StatusException
       Deletes a FirebaseLink on a property
      Throws:
      io.grpc.StatusException

    • listFirebaseLinks

      public ListFirebaseLinksResponse listFirebaseLinks(ListFirebaseLinksRequest request) throws io.grpc.StatusException
       Lists FirebaseLinks on a property.
 Properties can have at most one FirebaseLink.
      Throws:
      io.grpc.StatusException

    • createGoogleAdsLink

      public GoogleAdsLink createGoogleAdsLink(CreateGoogleAdsLinkRequest request) throws io.grpc.StatusException
       Creates a GoogleAdsLink.
      Throws:
      io.grpc.StatusException

    • updateGoogleAdsLink

      public GoogleAdsLink updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request) throws io.grpc.StatusException
       Updates a GoogleAdsLink on a property
      Throws:
      io.grpc.StatusException

    • deleteGoogleAdsLink

      public com.google.protobuf.Empty deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request) throws io.grpc.StatusException
       Deletes a GoogleAdsLink on a property
      Throws:
      io.grpc.StatusException

    • listGoogleAdsLinks

      public ListGoogleAdsLinksResponse listGoogleAdsLinks(ListGoogleAdsLinksRequest request) throws io.grpc.StatusException
       Lists GoogleAdsLinks on a property.
      Throws:
      io.grpc.StatusException

    • getDataSharingSettings

      public DataSharingSettings getDataSharingSettings(GetDataSharingSettingsRequest request) throws io.grpc.StatusException
       Get data sharing settings on an account.
 Data sharing settings are singletons.
      Throws:
      io.grpc.StatusException

    • getMeasurementProtocolSecret

      public MeasurementProtocolSecret getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request) throws io.grpc.StatusException
       Lookup for a single MeasurementProtocolSecret.
      Throws:
      io.grpc.StatusException

    • listMeasurementProtocolSecrets

      public ListMeasurementProtocolSecretsResponse listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request) throws io.grpc.StatusException
       Returns child MeasurementProtocolSecrets under the specified parent
 Property.
      Throws:
      io.grpc.StatusException

    • createMeasurementProtocolSecret

      public MeasurementProtocolSecret createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request) throws io.grpc.StatusException
       Creates a measurement protocol secret.
      Throws:
      io.grpc.StatusException

    • deleteMeasurementProtocolSecret

      public com.google.protobuf.Empty deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request) throws io.grpc.StatusException
       Deletes target MeasurementProtocolSecret.
      Throws:
      io.grpc.StatusException

    • updateMeasurementProtocolSecret

      public MeasurementProtocolSecret updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request) throws io.grpc.StatusException
       Updates a measurement protocol secret.
      Throws:
      io.grpc.StatusException

    • acknowledgeUserDataCollection

      public AcknowledgeUserDataCollectionResponse acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • searchChangeHistoryEvents

      public SearchChangeHistoryEventsResponse searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • createConversionEvent

      @Deprecated public ConversionEvent createConversionEvent(CreateConversionEventRequest request) throws io.grpc.StatusException
      Deprecated.
       Deprecated: Use `CreateKeyEvent` instead.
 Creates a conversion event with the specified attributes.
      Throws:
      io.grpc.StatusException

    • updateConversionEvent

      @Deprecated public ConversionEvent updateConversionEvent(UpdateConversionEventRequest request) throws io.grpc.StatusException
      Deprecated.
       Deprecated: Use `UpdateKeyEvent` instead.
 Updates a conversion event with the specified attributes.
      Throws:
      io.grpc.StatusException

    • getConversionEvent

      @Deprecated public ConversionEvent getConversionEvent(GetConversionEventRequest request) throws io.grpc.StatusException
      Deprecated.
       Deprecated: Use `GetKeyEvent` instead.
 Retrieve a single conversion event.
      Throws:
      io.grpc.StatusException

    • deleteConversionEvent

      @Deprecated public com.google.protobuf.Empty deleteConversionEvent(DeleteConversionEventRequest request) throws io.grpc.StatusException
      Deprecated.
       Deprecated: Use `DeleteKeyEvent` instead.
 Deletes a conversion event in a property.
      Throws:
      io.grpc.StatusException

    • listConversionEvents

      @Deprecated public ListConversionEventsResponse listConversionEvents(ListConversionEventsRequest request) throws io.grpc.StatusException
      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.
      Throws:
      io.grpc.StatusException

    • createKeyEvent

      public KeyEvent createKeyEvent(CreateKeyEventRequest request) throws io.grpc.StatusException
       Creates a Key Event.
      Throws:
      io.grpc.StatusException

    • updateKeyEvent

      public KeyEvent updateKeyEvent(UpdateKeyEventRequest request) throws io.grpc.StatusException
       Updates a Key Event.
      Throws:
      io.grpc.StatusException

    • getKeyEvent

      public KeyEvent getKeyEvent(GetKeyEventRequest request) throws io.grpc.StatusException
       Retrieve a single Key Event.
      Throws:
      io.grpc.StatusException

    • deleteKeyEvent

      public com.google.protobuf.Empty deleteKeyEvent(DeleteKeyEventRequest request) throws io.grpc.StatusException
       Deletes a Key Event.
      Throws:
      io.grpc.StatusException

    • listKeyEvents

      public ListKeyEventsResponse listKeyEvents(ListKeyEventsRequest request) throws io.grpc.StatusException
       Returns a list of Key Events in the specified parent property.
 Returns an empty list if no Key Events are found.
      Throws:
      io.grpc.StatusException

    • createCustomDimension

      public CustomDimension createCustomDimension(CreateCustomDimensionRequest request) throws io.grpc.StatusException
       Creates a CustomDimension.
      Throws:
      io.grpc.StatusException

    • updateCustomDimension

      public CustomDimension updateCustomDimension(UpdateCustomDimensionRequest request) throws io.grpc.StatusException
       Updates a CustomDimension on a property.
      Throws:
      io.grpc.StatusException

    • listCustomDimensions

      public ListCustomDimensionsResponse listCustomDimensions(ListCustomDimensionsRequest request) throws io.grpc.StatusException
       Lists CustomDimensions on a property.
      Throws:
      io.grpc.StatusException

    • archiveCustomDimension

      public com.google.protobuf.Empty archiveCustomDimension(ArchiveCustomDimensionRequest request) throws io.grpc.StatusException
       Archives a CustomDimension on a property.
      Throws:
      io.grpc.StatusException

    • getCustomDimension

      public CustomDimension getCustomDimension(GetCustomDimensionRequest request) throws io.grpc.StatusException
       Lookup for a single CustomDimension.
      Throws:
      io.grpc.StatusException

    • createCustomMetric

      public CustomMetric createCustomMetric(CreateCustomMetricRequest request) throws io.grpc.StatusException
       Creates a CustomMetric.
      Throws:
      io.grpc.StatusException

    • updateCustomMetric

      public CustomMetric updateCustomMetric(UpdateCustomMetricRequest request) throws io.grpc.StatusException
       Updates a CustomMetric on a property.
      Throws:
      io.grpc.StatusException

    • listCustomMetrics

      public ListCustomMetricsResponse listCustomMetrics(ListCustomMetricsRequest request) throws io.grpc.StatusException
       Lists CustomMetrics on a property.
      Throws:
      io.grpc.StatusException

    • archiveCustomMetric

      public com.google.protobuf.Empty archiveCustomMetric(ArchiveCustomMetricRequest request) throws io.grpc.StatusException
       Archives a CustomMetric on a property.
      Throws:
      io.grpc.StatusException

    • getCustomMetric

      public CustomMetric getCustomMetric(GetCustomMetricRequest request) throws io.grpc.StatusException
       Lookup for a single CustomMetric.
      Throws:
      io.grpc.StatusException

    • getDataRetentionSettings

      public DataRetentionSettings getDataRetentionSettings(GetDataRetentionSettingsRequest request) throws io.grpc.StatusException
       Returns the singleton data retention settings for this property.
      Throws:
      io.grpc.StatusException

    • updateDataRetentionSettings

      public DataRetentionSettings updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request) throws io.grpc.StatusException
       Updates the singleton data retention settings for this property.
      Throws:
      io.grpc.StatusException

    • createDataStream

      public DataStream createDataStream(CreateDataStreamRequest request) throws io.grpc.StatusException
       Creates a DataStream.
      Throws:
      io.grpc.StatusException

    • deleteDataStream

      public com.google.protobuf.Empty deleteDataStream(DeleteDataStreamRequest request) throws io.grpc.StatusException
       Deletes a DataStream on a property.
      Throws:
      io.grpc.StatusException

    • updateDataStream

      public DataStream updateDataStream(UpdateDataStreamRequest request) throws io.grpc.StatusException
       Updates a DataStream on a property.
      Throws:
      io.grpc.StatusException

    • listDataStreams

      public ListDataStreamsResponse listDataStreams(ListDataStreamsRequest request) throws io.grpc.StatusException
       Lists DataStreams on a property.
      Throws:
      io.grpc.StatusException

    • getDataStream

      public DataStream getDataStream(GetDataStreamRequest request) throws io.grpc.StatusException
       Lookup for a single DataStream.
      Throws:
      io.grpc.StatusException

    • runAccessReport

      public RunAccessReportResponse runAccessReport(RunAccessReportRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException