Package com.google.analytics.data.v1alpha

Class AlphaAnalyticsDataGrpc.AlphaAnalyticsDataFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<AlphaAnalyticsDataGrpc.AlphaAnalyticsDataFutureStub>
com.google.analytics.data.v1alpha.AlphaAnalyticsDataGrpc.AlphaAnalyticsDataFutureStub
Enclosing class:
AlphaAnalyticsDataGrpc
public static final class AlphaAnalyticsDataGrpc.AlphaAnalyticsDataFutureStub extends io.grpc.stub.AbstractFutureStub<AlphaAnalyticsDataGrpc.AlphaAnalyticsDataFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service AlphaAnalyticsData. 
 Google Analytics reporting data service.

  • Method Details

    • build

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

    • runFunnelReport

      public com.google.common.util.concurrent.ListenableFuture<RunFunnelReportResponse> runFunnelReport(RunFunnelReportRequest request)
       Returns a customized funnel report of your Google Analytics event data. The
 data returned from the API is as a table with columns for the requested
 dimensions and metrics.
 Funnel exploration lets you visualize the steps your users take to complete
 a task and quickly see how well they are succeeding or failing at each
 step. For example, how do prospects become shoppers and then become buyers?
 How do one time buyers become repeat buyers? With this information, you can
 improve inefficient or abandoned customer journeys. To learn more, see [GA4
 Funnel Explorations](https://support.google.com/analytics/answer/9327974).
 This method is introduced at alpha stability with the intention of
 gathering feedback on syntax and capabilities before entering beta. To give
 your feedback on this API, complete the [Google Analytics Data API Funnel
 Reporting
 Feedback](https://docs.google.com/forms/d/e/1FAIpQLSdwOlQDJAUoBiIgUZZ3S_Lwi8gr7Bb0k1jhvc-DEg7Rol3UjA/viewform).

    • createAudienceList

      public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createAudienceList(CreateAudienceListRequest request)
       Creates an audience list for later retrieval. This method quickly returns
 the audience list's resource name and initiates a long running asynchronous
 request to form an audience list. To list the users in an audience list,
 first create the audience list through this method and then send the
 audience resource name to the `QueryAudienceList` method.
 See [Creating an Audience
 List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
 for an introduction to Audience Lists with examples.
 An audience list is a snapshot of the users currently in the audience at
 the time of audience list creation. Creating audience lists for one
 audience on different days will return different results as users enter and
 exit the audience.
 Audiences in Google Analytics 4 allow you to segment your users in the ways
 that are important to your business. To learn more, see
 https://support.google.com/analytics/answer/9267572. Audience lists contain
 the users in each audience.
 This method is available at beta stability at
 [audienceExports.create](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/create).
 To give your feedback on this API, complete the [Google Analytics Audience
 Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

    • queryAudienceList

      public com.google.common.util.concurrent.ListenableFuture<QueryAudienceListResponse> queryAudienceList(QueryAudienceListRequest request)
       Retrieves an audience list of users. After creating an audience, the users
 are not immediately available for listing. First, a request to
 `CreateAudienceList` is necessary to create an audience list of users, and
 then second, this method is used to retrieve the users in the audience
 list.
 See [Creating an Audience
 List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
 for an introduction to Audience Lists with examples.
 Audiences in Google Analytics 4 allow you to segment your users in the ways
 that are important to your business. To learn more, see
 https://support.google.com/analytics/answer/9267572.
 This method is available at beta stability at
 [audienceExports.query](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/query).
 To give your feedback on this API, complete the [Google Analytics Audience
 Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

    • getAudienceList

      public com.google.common.util.concurrent.ListenableFuture<AudienceList> getAudienceList(GetAudienceListRequest request)
       Gets configuration metadata about a specific audience list. This method
 can be used to understand an audience list after it has been created.
 See [Creating an Audience
 List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
 for an introduction to Audience Lists with examples.
 This method is available at beta stability at
 [audienceExports.get](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/get).
 To give your feedback on this API, complete the
 [Google Analytics Audience Export API
 Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

    • listAudienceLists

      public com.google.common.util.concurrent.ListenableFuture<ListAudienceListsResponse> listAudienceLists(ListAudienceListsRequest request)
       Lists all audience lists for a property. This method can be used for you to
 find and reuse existing audience lists rather than creating unnecessary new
 audience lists. The same audience can have multiple audience lists that
 represent the list of users that were in an audience on different days.
 See [Creating an Audience
 List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
 for an introduction to Audience Lists with examples.
 This method is available at beta stability at
 [audienceExports.list](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/list).
 To give your feedback on this API, complete the
 [Google Analytics Audience Export API
 Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

    • createRecurringAudienceList

      public com.google.common.util.concurrent.ListenableFuture<RecurringAudienceList> createRecurringAudienceList(CreateRecurringAudienceListRequest request)
       Creates a recurring audience list. Recurring audience lists produces new
 audience lists each day. Audience lists are users in an audience at the
 time of the list's creation.
 A recurring audience list ensures that you have audience list based on the
 most recent data available for use each day. If you manually create
 audience list, you don't know when an audience list based on an additional
 day's data is available. This recurring audience list automates the
 creation of an audience list when an additional day's data is available.
 You will consume fewer quota tokens by using recurring audience list versus
 manually creating audience list at various times of day trying to guess
 when an additional day's data is ready.
 This method is introduced at alpha stability with the intention of
 gathering feedback on syntax and capabilities before entering beta. To give
 your feedback on this API, complete the
 [Google Analytics Audience Export API
 Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

    • getRecurringAudienceList

      public com.google.common.util.concurrent.ListenableFuture<RecurringAudienceList> getRecurringAudienceList(GetRecurringAudienceListRequest request)
       Gets configuration metadata about a specific recurring audience list. This
 method can be used to understand a recurring audience list's state after it
 has been created. For example, a recurring audience list resource will
 generate audience list instances for each day, and this method can be used
 to get the resource name of the most recent audience list instance.
 This method is introduced at alpha stability with the intention of
 gathering feedback on syntax and capabilities before entering beta. To give
 your feedback on this API, complete the
 [Google Analytics Audience Export API
 Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

    • listRecurringAudienceLists

      public com.google.common.util.concurrent.ListenableFuture<ListRecurringAudienceListsResponse> listRecurringAudienceLists(ListRecurringAudienceListsRequest request)
       Lists all recurring audience lists for a property. This method can be used
 for you to find and reuse existing recurring audience lists rather than
 creating unnecessary new recurring audience lists. The same audience can
 have multiple recurring audience lists that represent different dimension
 combinations; for example, just the dimension `deviceId` or both the
 dimensions `deviceId` and `userId`.
 This method is introduced at alpha stability with the intention of
 gathering feedback on syntax and capabilities before entering beta. To give
 your feedback on this API, complete the
 [Google Analytics Audience Export API
 Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

    • getPropertyQuotasSnapshot

      public com.google.common.util.concurrent.ListenableFuture<PropertyQuotasSnapshot> getPropertyQuotasSnapshot(GetPropertyQuotasSnapshotRequest request)
       Get all property quotas organized by quota category for a given property.
 This will charge 1 property quota from the category with the most quota.

    • createReportTask

      public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createReportTask(CreateReportTaskRequest request)
       Initiates the creation of a report task. This method quickly
 returns a report task and initiates a long running
 asynchronous request to form a customized report of your Google Analytics
 event data.
 A report task will be retained and available for querying for 72 hours
 after it has been created.
 A report task created by one user can be listed and queried by all users
 who have access to the property.

    • queryReportTask

      public com.google.common.util.concurrent.ListenableFuture<QueryReportTaskResponse> queryReportTask(QueryReportTaskRequest request)
       Retrieves a report task's content. After requesting the `CreateReportTask`,
 you are able to retrieve the report content once the report is
 ACTIVE. This method will return an error if the report task's state is not
 `ACTIVE`. A query response will return the tabular row & column values of
 the report.

    • getReportTask

      public com.google.common.util.concurrent.ListenableFuture<ReportTask> getReportTask(GetReportTaskRequest request)
       Gets report metadata about a specific report task. After creating a report
 task, use this method to check its processing state or inspect its
 report definition.

    • listReportTasks

      public com.google.common.util.concurrent.ListenableFuture<ListReportTasksResponse> listReportTasks(ListReportTasksRequest request)
       Lists all report tasks for a property.

    • runReport

      public com.google.common.util.concurrent.ListenableFuture<RunReportResponse> runReport(RunReportRequest request)
       Returns a customized report of your Google Analytics event data. Reports
 contain statistics derived from data collected by the Google Analytics
 tracking code. The data returned from the API is as a table with columns
 for the requested dimensions and metrics. Metrics are individual
 measurements of user activity on your property, such as active users or
 event count. Dimensions break down metrics across some common criteria,
 such as country or event name.

    • getMetadata

      public com.google.common.util.concurrent.ListenableFuture<Metadata> getMetadata(GetMetadataRequest request)
       Returns metadata for dimensions and metrics available in reporting methods.
 Used to explore the dimensions and metrics. In this method, a Google
 Analytics property identifier is specified in the request, and
 the metadata response includes Custom dimensions and metrics as well as
 Universal metadata.
 For example if a custom metric with parameter name `levels_unlocked` is
 registered to a property, the Metadata response will contain
 `customEvent:levels_unlocked`. Universal metadata are dimensions and
 metrics applicable to any property such as `country` and `totalUsers`.