Package com.google.analytics.data.v1alpha

Class AlphaAnalyticsDataClient

java.lang.Object
com.google.analytics.data.v1alpha.AlphaAnalyticsDataClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class AlphaAnalyticsDataClient extends Object implements BackgroundResource
Service Description: Google Analytics reporting data service.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   RunFunnelReportRequest request =
       RunFunnelReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDateRanges(new ArrayList<DateRange>())
           .setFunnel(Funnel.newBuilder().build())
           .setFunnelBreakdown(FunnelBreakdown.newBuilder().build())
           .setFunnelNextAction(FunnelNextAction.newBuilder().build())
           .addAllSegments(new ArrayList<Segment>())
           .setLimit(102976443)
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setReturnPropertyQuota(true)
           .build();
   RunFunnelReportResponse response = alphaAnalyticsDataClient.runFunnelReport(request);
 }

Note: close() needs to be called on the AlphaAnalyticsDataClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

RunFunnelReport

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).

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • runFunnelReport(RunFunnelReportRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • runFunnelReportCallable()

CreateAudienceList

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createAudienceListAsync(CreateAudienceListRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • createAudienceListAsync(PropertyName parent, AudienceList audienceList)

  • createAudienceListAsync(String parent, AudienceList audienceList)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAudienceListOperationCallable()

  • createAudienceListCallable()

QueryAudienceList

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • queryAudienceList(QueryAudienceListRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • queryAudienceList(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • queryAudienceListCallable()

GetAudienceList

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAudienceList(GetAudienceListRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAudienceList(AudienceListName name)

  • getAudienceList(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAudienceListCallable()

ListAudienceLists

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAudienceLists(ListAudienceListsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listAudienceLists(PropertyName parent)

  • listAudienceLists(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAudienceListsPagedCallable()

  • listAudienceListsCallable()

CreateRecurringAudienceList

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createRecurringAudienceList(CreateRecurringAudienceListRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createRecurringAudienceList(PropertyName parent, RecurringAudienceList recurringAudienceList)

  • createRecurringAudienceList(String parent, RecurringAudienceList recurringAudienceList)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createRecurringAudienceListCallable()

GetRecurringAudienceList

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getRecurringAudienceList(GetRecurringAudienceListRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getRecurringAudienceList(RecurringAudienceListName name)

  • getRecurringAudienceList(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getRecurringAudienceListCallable()

ListRecurringAudienceLists

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listRecurringAudienceLists(ListRecurringAudienceListsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listRecurringAudienceLists(PropertyName parent)

  • listRecurringAudienceLists(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listRecurringAudienceListsPagedCallable()

  • listRecurringAudienceListsCallable()

GetPropertyQuotasSnapshot

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getPropertyQuotasSnapshot(GetPropertyQuotasSnapshotRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getPropertyQuotasSnapshot(PropertyQuotasSnapshotName name)

  • getPropertyQuotasSnapshot(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getPropertyQuotasSnapshotCallable()

CreateReportTask

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createReportTaskAsync(CreateReportTaskRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • createReportTaskAsync(PropertyName parent, ReportTask reportTask)

  • createReportTaskAsync(String parent, ReportTask reportTask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createReportTaskOperationCallable()

  • createReportTaskCallable()

QueryReportTask

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • queryReportTask(QueryReportTaskRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • queryReportTask(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • queryReportTaskCallable()

GetReportTask

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getReportTask(GetReportTaskRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getReportTask(ReportTaskName name)

  • getReportTask(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getReportTaskCallable()

ListReportTasks

Lists all report tasks for a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listReportTasks(ListReportTasksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listReportTasks(PropertyName parent)

  • listReportTasks(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listReportTasksPagedCallable()

  • listReportTasksCallable()

RunReport

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • runReport(RunReportRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • runReportCallable()

GetMetadata

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`.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getMetadata(GetMetadataRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getMetadata(MetadataName name)

  • getMetadata(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getMetadataCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AlphaAnalyticsDataSettings to create(). For example:

To customize credentials: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AlphaAnalyticsDataSettings alphaAnalyticsDataSettings =
     AlphaAnalyticsDataSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AlphaAnalyticsDataClient alphaAnalyticsDataClient =
     AlphaAnalyticsDataClient.create(alphaAnalyticsDataSettings);

To customize the endpoint: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AlphaAnalyticsDataSettings alphaAnalyticsDataSettings =
     AlphaAnalyticsDataSettings.newBuilder().setEndpoint(myEndpoint).build();
 AlphaAnalyticsDataClient alphaAnalyticsDataClient =
     AlphaAnalyticsDataClient.create(alphaAnalyticsDataSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AlphaAnalyticsDataSettings alphaAnalyticsDataSettings =
     AlphaAnalyticsDataSettings.newHttpJsonBuilder().build();
 AlphaAnalyticsDataClient alphaAnalyticsDataClient =
     AlphaAnalyticsDataClient.create(alphaAnalyticsDataSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

  • Constructor Details

    • AlphaAnalyticsDataClient

      protected AlphaAnalyticsDataClient(AlphaAnalyticsDataSettings settings) throws IOException
      Constructs an instance of AlphaAnalyticsDataClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
      Throws:
      IOException

    • AlphaAnalyticsDataClient

      protected AlphaAnalyticsDataClient(AlphaAnalyticsDataStub stub)

  • Method Details

    • create

      public static final AlphaAnalyticsDataClient create() throws IOException
      Constructs an instance of AlphaAnalyticsDataClient with default settings.
      Throws:
      IOException

    • create

      public static final AlphaAnalyticsDataClient create(AlphaAnalyticsDataSettings settings) throws IOException
      Constructs an instance of AlphaAnalyticsDataClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
      Throws:
      IOException

    • create

      public static final AlphaAnalyticsDataClient create(AlphaAnalyticsDataStub stub)
      Constructs an instance of AlphaAnalyticsDataClient, using the given stub for making calls. This is for advanced usage - prefer using create(AlphaAnalyticsDataSettings).

    • getSettings

      public final AlphaAnalyticsDataSettings getSettings()

    • getStub

      public AlphaAnalyticsDataStub getStub()

    • getOperationsClient

      public final OperationsClient getOperationsClient()
      Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

    • getHttpJsonOperationsClient

      @BetaApi public final OperationsClient getHttpJsonOperationsClient()
      Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

    • runFunnelReport

      public final 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).

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   RunFunnelReportRequest request =
       RunFunnelReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDateRanges(new ArrayList<DateRange>())
           .setFunnel(Funnel.newBuilder().build())
           .setFunnelBreakdown(FunnelBreakdown.newBuilder().build())
           .setFunnelNextAction(FunnelNextAction.newBuilder().build())
           .addAllSegments(new ArrayList<Segment>())
           .setLimit(102976443)
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setReturnPropertyQuota(true)
           .build();
   RunFunnelReportResponse response = alphaAnalyticsDataClient.runFunnelReport(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • runFunnelReportCallable

      public final UnaryCallable<RunFunnelReportRequest,RunFunnelReportResponse> runFunnelReportCallable()
      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).

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   RunFunnelReportRequest request =
       RunFunnelReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDateRanges(new ArrayList<DateRange>())
           .setFunnel(Funnel.newBuilder().build())
           .setFunnelBreakdown(FunnelBreakdown.newBuilder().build())
           .setFunnelNextAction(FunnelNextAction.newBuilder().build())
           .addAllSegments(new ArrayList<Segment>())
           .setLimit(102976443)
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setReturnPropertyQuota(true)
           .build();
   ApiFuture<RunFunnelReportResponse> future =
       alphaAnalyticsDataClient.runFunnelReportCallable().futureCall(request);
   // Do something.
   RunFunnelReportResponse response = future.get();
 }

    • createAudienceListAsync

      public final OperationFuture<AudienceList,AudienceListMetadata> createAudienceListAsync(PropertyName parent, AudienceList audienceList)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   AudienceList audienceList = AudienceList.newBuilder().build();
   AudienceList response =
       alphaAnalyticsDataClient.createAudienceListAsync(parent, audienceList).get();
 }
      Parameters:
      parent - Required. The parent resource where this audience list will be created. Format: `properties/{property}`
      audienceList - Required. The audience list to create.
      Throws:
      ApiException - if the remote call fails

    • createAudienceListAsync

      public final OperationFuture<AudienceList,AudienceListMetadata> createAudienceListAsync(String parent, AudienceList audienceList)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   AudienceList audienceList = AudienceList.newBuilder().build();
   AudienceList response =
       alphaAnalyticsDataClient.createAudienceListAsync(parent, audienceList).get();
 }
      Parameters:
      parent - Required. The parent resource where this audience list will be created. Format: `properties/{property}`
      audienceList - Required. The audience list to create.
      Throws:
      ApiException - if the remote call fails

    • createAudienceListAsync

      public final OperationFuture<AudienceList,AudienceListMetadata> createAudienceListAsync(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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   CreateAudienceListRequest request =
       CreateAudienceListRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setAudienceList(AudienceList.newBuilder().build())
           .build();
   AudienceList response = alphaAnalyticsDataClient.createAudienceListAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createAudienceListOperationCallable

      public final OperationCallable<CreateAudienceListRequest,AudienceList,AudienceListMetadata> createAudienceListOperationCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   CreateAudienceListRequest request =
       CreateAudienceListRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setAudienceList(AudienceList.newBuilder().build())
           .build();
   OperationFuture<AudienceList, AudienceListMetadata> future =
       alphaAnalyticsDataClient.createAudienceListOperationCallable().futureCall(request);
   // Do something.
   AudienceList response = future.get();
 }

    • createAudienceListCallable

      public final UnaryCallable<CreateAudienceListRequest,Operation> createAudienceListCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   CreateAudienceListRequest request =
       CreateAudienceListRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setAudienceList(AudienceList.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       alphaAnalyticsDataClient.createAudienceListCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

    • queryAudienceList

      public final QueryAudienceListResponse queryAudienceList(String name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String name = "name3373707";
   QueryAudienceListResponse response = alphaAnalyticsDataClient.queryAudienceList(name);
 }
      Parameters:
      name - Required. The name of the audience list to retrieve users from. Format: `properties/{property}/audienceLists/{audience_list}`
      Throws:
      ApiException - if the remote call fails

    • queryAudienceList

      public final 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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   QueryAudienceListRequest request =
       QueryAudienceListRequest.newBuilder()
           .setName("name3373707")
           .setOffset(-1019779949)
           .setLimit(102976443)
           .build();
   QueryAudienceListResponse response = alphaAnalyticsDataClient.queryAudienceList(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • queryAudienceListCallable

      public final UnaryCallable<QueryAudienceListRequest,QueryAudienceListResponse> queryAudienceListCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   QueryAudienceListRequest request =
       QueryAudienceListRequest.newBuilder()
           .setName("name3373707")
           .setOffset(-1019779949)
           .setLimit(102976443)
           .build();
   ApiFuture<QueryAudienceListResponse> future =
       alphaAnalyticsDataClient.queryAudienceListCallable().futureCall(request);
   // Do something.
   QueryAudienceListResponse response = future.get();
 }

    • getAudienceList

      public final AudienceList getAudienceList(AudienceListName name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   AudienceListName name = AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]");
   AudienceList response = alphaAnalyticsDataClient.getAudienceList(name);
 }
      Parameters:
      name - Required. The audience list resource name. Format: `properties/{property}/audienceLists/{audience_list}`
      Throws:
      ApiException - if the remote call fails

    • getAudienceList

      public final AudienceList getAudienceList(String name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String name = AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString();
   AudienceList response = alphaAnalyticsDataClient.getAudienceList(name);
 }
      Parameters:
      name - Required. The audience list resource name. Format: `properties/{property}/audienceLists/{audience_list}`
      Throws:
      ApiException - if the remote call fails

    • getAudienceList

      public final 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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   GetAudienceListRequest request =
       GetAudienceListRequest.newBuilder()
           .setName(AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString())
           .build();
   AudienceList response = alphaAnalyticsDataClient.getAudienceList(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getAudienceListCallable

      public final UnaryCallable<GetAudienceListRequest,AudienceList> getAudienceListCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   GetAudienceListRequest request =
       GetAudienceListRequest.newBuilder()
           .setName(AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString())
           .build();
   ApiFuture<AudienceList> future =
       alphaAnalyticsDataClient.getAudienceListCallable().futureCall(request);
   // Do something.
   AudienceList response = future.get();
 }

    • listAudienceLists

      public final AlphaAnalyticsDataClient.ListAudienceListsPagedResponse listAudienceLists(PropertyName parent)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (AudienceList element : alphaAnalyticsDataClient.listAudienceLists(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. All audience lists for this property will be listed in the response. Format: `properties/{property}`
      Throws:
      ApiException - if the remote call fails

    • listAudienceLists

      public final AlphaAnalyticsDataClient.ListAudienceListsPagedResponse listAudienceLists(String parent)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (AudienceList element : alphaAnalyticsDataClient.listAudienceLists(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. All audience lists for this property will be listed in the response. Format: `properties/{property}`
      Throws:
      ApiException - if the remote call fails

    • listAudienceLists

      public final AlphaAnalyticsDataClient.ListAudienceListsPagedResponse 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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   ListAudienceListsRequest request =
       ListAudienceListsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AudienceList element :
       alphaAnalyticsDataClient.listAudienceLists(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listAudienceListsPagedCallable

      public final UnaryCallable<ListAudienceListsRequest,AlphaAnalyticsDataClient.ListAudienceListsPagedResponse> listAudienceListsPagedCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   ListAudienceListsRequest request =
       ListAudienceListsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AudienceList> future =
       alphaAnalyticsDataClient.listAudienceListsPagedCallable().futureCall(request);
   // Do something.
   for (AudienceList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listAudienceListsCallable

      public final UnaryCallable<ListAudienceListsRequest,ListAudienceListsResponse> listAudienceListsCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   ListAudienceListsRequest request =
       ListAudienceListsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAudienceListsResponse response =
         alphaAnalyticsDataClient.listAudienceListsCallable().call(request);
     for (AudienceList element : response.getAudienceListsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • createRecurringAudienceList

      public final RecurringAudienceList createRecurringAudienceList(PropertyName parent, RecurringAudienceList recurringAudienceList)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   RecurringAudienceList recurringAudienceList = RecurringAudienceList.newBuilder().build();
   RecurringAudienceList response =
       alphaAnalyticsDataClient.createRecurringAudienceList(parent, recurringAudienceList);
 }
      Parameters:
      parent - Required. The parent resource where this recurring audience list will be created. Format: `properties/{property}`
      recurringAudienceList - Required. The recurring audience list to create.
      Throws:
      ApiException - if the remote call fails

    • createRecurringAudienceList

      public final RecurringAudienceList createRecurringAudienceList(String parent, RecurringAudienceList recurringAudienceList)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   RecurringAudienceList recurringAudienceList = RecurringAudienceList.newBuilder().build();
   RecurringAudienceList response =
       alphaAnalyticsDataClient.createRecurringAudienceList(parent, recurringAudienceList);
 }
      Parameters:
      parent - Required. The parent resource where this recurring audience list will be created. Format: `properties/{property}`
      recurringAudienceList - Required. The recurring audience list to create.
      Throws:
      ApiException - if the remote call fails

    • createRecurringAudienceList

      public final 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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   CreateRecurringAudienceListRequest request =
       CreateRecurringAudienceListRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setRecurringAudienceList(RecurringAudienceList.newBuilder().build())
           .build();
   RecurringAudienceList response =
       alphaAnalyticsDataClient.createRecurringAudienceList(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createRecurringAudienceListCallable

      public final UnaryCallable<CreateRecurringAudienceListRequest,RecurringAudienceList> createRecurringAudienceListCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   CreateRecurringAudienceListRequest request =
       CreateRecurringAudienceListRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setRecurringAudienceList(RecurringAudienceList.newBuilder().build())
           .build();
   ApiFuture<RecurringAudienceList> future =
       alphaAnalyticsDataClient.createRecurringAudienceListCallable().futureCall(request);
   // Do something.
   RecurringAudienceList response = future.get();
 }

    • getRecurringAudienceList

      public final RecurringAudienceList getRecurringAudienceList(RecurringAudienceListName name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   RecurringAudienceListName name =
       RecurringAudienceListName.of("[PROPERTY]", "[RECURRING_AUDIENCE_LIST]");
   RecurringAudienceList response = alphaAnalyticsDataClient.getRecurringAudienceList(name);
 }
      Parameters:
      name - Required. The recurring audience list resource name. Format: `properties/{property}/recurringAudienceLists/{recurring_audience_list}`
      Throws:
      ApiException - if the remote call fails

    • getRecurringAudienceList

      public final RecurringAudienceList getRecurringAudienceList(String name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String name =
       RecurringAudienceListName.of("[PROPERTY]", "[RECURRING_AUDIENCE_LIST]").toString();
   RecurringAudienceList response = alphaAnalyticsDataClient.getRecurringAudienceList(name);
 }
      Parameters:
      name - Required. The recurring audience list resource name. Format: `properties/{property}/recurringAudienceLists/{recurring_audience_list}`
      Throws:
      ApiException - if the remote call fails

    • getRecurringAudienceList

      public final 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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   GetRecurringAudienceListRequest request =
       GetRecurringAudienceListRequest.newBuilder()
           .setName(
               RecurringAudienceListName.of("[PROPERTY]", "[RECURRING_AUDIENCE_LIST]")
                   .toString())
           .build();
   RecurringAudienceList response = alphaAnalyticsDataClient.getRecurringAudienceList(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getRecurringAudienceListCallable

      public final UnaryCallable<GetRecurringAudienceListRequest,RecurringAudienceList> getRecurringAudienceListCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   GetRecurringAudienceListRequest request =
       GetRecurringAudienceListRequest.newBuilder()
           .setName(
               RecurringAudienceListName.of("[PROPERTY]", "[RECURRING_AUDIENCE_LIST]")
                   .toString())
           .build();
   ApiFuture<RecurringAudienceList> future =
       alphaAnalyticsDataClient.getRecurringAudienceListCallable().futureCall(request);
   // Do something.
   RecurringAudienceList response = future.get();
 }

    • listRecurringAudienceLists

      public final AlphaAnalyticsDataClient.ListRecurringAudienceListsPagedResponse listRecurringAudienceLists(PropertyName parent)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (RecurringAudienceList element :
       alphaAnalyticsDataClient.listRecurringAudienceLists(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. All recurring audience lists for this property will be listed in the response. Format: `properties/{property}`
      Throws:
      ApiException - if the remote call fails

    • listRecurringAudienceLists

      public final AlphaAnalyticsDataClient.ListRecurringAudienceListsPagedResponse listRecurringAudienceLists(String parent)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (RecurringAudienceList element :
       alphaAnalyticsDataClient.listRecurringAudienceLists(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. All recurring audience lists for this property will be listed in the response. Format: `properties/{property}`
      Throws:
      ApiException - if the remote call fails

    • listRecurringAudienceLists

      public final AlphaAnalyticsDataClient.ListRecurringAudienceListsPagedResponse 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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   ListRecurringAudienceListsRequest request =
       ListRecurringAudienceListsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (RecurringAudienceList element :
       alphaAnalyticsDataClient.listRecurringAudienceLists(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listRecurringAudienceListsPagedCallable

      public final UnaryCallable<ListRecurringAudienceListsRequest,AlphaAnalyticsDataClient.ListRecurringAudienceListsPagedResponse> listRecurringAudienceListsPagedCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   ListRecurringAudienceListsRequest request =
       ListRecurringAudienceListsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<RecurringAudienceList> future =
       alphaAnalyticsDataClient.listRecurringAudienceListsPagedCallable().futureCall(request);
   // Do something.
   for (RecurringAudienceList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listRecurringAudienceListsCallable

      public final UnaryCallable<ListRecurringAudienceListsRequest,ListRecurringAudienceListsResponse> listRecurringAudienceListsCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   ListRecurringAudienceListsRequest request =
       ListRecurringAudienceListsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListRecurringAudienceListsResponse response =
         alphaAnalyticsDataClient.listRecurringAudienceListsCallable().call(request);
     for (RecurringAudienceList element : response.getRecurringAudienceListsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getPropertyQuotasSnapshot

      public final PropertyQuotasSnapshot getPropertyQuotasSnapshot(PropertyQuotasSnapshotName name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   PropertyQuotasSnapshotName name = PropertyQuotasSnapshotName.of("[PROPERTY]");
   PropertyQuotasSnapshot response = alphaAnalyticsDataClient.getPropertyQuotasSnapshot(name);
 }
      Parameters:
      name - Required. Quotas from this property will be listed in the response. Format: `properties/{property}/propertyQuotasSnapshot`
      Throws:
      ApiException - if the remote call fails

    • getPropertyQuotasSnapshot

      public final PropertyQuotasSnapshot getPropertyQuotasSnapshot(String name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String name = PropertyQuotasSnapshotName.of("[PROPERTY]").toString();
   PropertyQuotasSnapshot response = alphaAnalyticsDataClient.getPropertyQuotasSnapshot(name);
 }
      Parameters:
      name - Required. Quotas from this property will be listed in the response. Format: `properties/{property}/propertyQuotasSnapshot`
      Throws:
      ApiException - if the remote call fails

    • getPropertyQuotasSnapshot

      public final 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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   GetPropertyQuotasSnapshotRequest request =
       GetPropertyQuotasSnapshotRequest.newBuilder()
           .setName(PropertyQuotasSnapshotName.of("[PROPERTY]").toString())
           .build();
   PropertyQuotasSnapshot response = alphaAnalyticsDataClient.getPropertyQuotasSnapshot(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getPropertyQuotasSnapshotCallable

      public final UnaryCallable<GetPropertyQuotasSnapshotRequest,PropertyQuotasSnapshot> getPropertyQuotasSnapshotCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   GetPropertyQuotasSnapshotRequest request =
       GetPropertyQuotasSnapshotRequest.newBuilder()
           .setName(PropertyQuotasSnapshotName.of("[PROPERTY]").toString())
           .build();
   ApiFuture<PropertyQuotasSnapshot> future =
       alphaAnalyticsDataClient.getPropertyQuotasSnapshotCallable().futureCall(request);
   // Do something.
   PropertyQuotasSnapshot response = future.get();
 }

    • createReportTaskAsync

      public final OperationFuture<ReportTask,ReportTaskMetadata> createReportTaskAsync(PropertyName parent, ReportTask reportTask)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   ReportTask reportTask = ReportTask.newBuilder().build();
   ReportTask response =
       alphaAnalyticsDataClient.createReportTaskAsync(parent, reportTask).get();
 }
      Parameters:
      parent - Required. The parent resource where this report task will be created. Format: `properties/{propertyId}`
      reportTask - Required. The report task configuration to create.
      Throws:
      ApiException - if the remote call fails

    • createReportTaskAsync

      public final OperationFuture<ReportTask,ReportTaskMetadata> createReportTaskAsync(String parent, ReportTask reportTask)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   ReportTask reportTask = ReportTask.newBuilder().build();
   ReportTask response =
       alphaAnalyticsDataClient.createReportTaskAsync(parent, reportTask).get();
 }
      Parameters:
      parent - Required. The parent resource where this report task will be created. Format: `properties/{propertyId}`
      reportTask - Required. The report task configuration to create.
      Throws:
      ApiException - if the remote call fails

    • createReportTaskAsync

      public final OperationFuture<ReportTask,ReportTaskMetadata> createReportTaskAsync(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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   CreateReportTaskRequest request =
       CreateReportTaskRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setReportTask(ReportTask.newBuilder().build())
           .build();
   ReportTask response = alphaAnalyticsDataClient.createReportTaskAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createReportTaskOperationCallable

      public final OperationCallable<CreateReportTaskRequest,ReportTask,ReportTaskMetadata> createReportTaskOperationCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   CreateReportTaskRequest request =
       CreateReportTaskRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setReportTask(ReportTask.newBuilder().build())
           .build();
   OperationFuture<ReportTask, ReportTaskMetadata> future =
       alphaAnalyticsDataClient.createReportTaskOperationCallable().futureCall(request);
   // Do something.
   ReportTask response = future.get();
 }

    • createReportTaskCallable

      public final UnaryCallable<CreateReportTaskRequest,Operation> createReportTaskCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   CreateReportTaskRequest request =
       CreateReportTaskRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setReportTask(ReportTask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       alphaAnalyticsDataClient.createReportTaskCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

    • queryReportTask

      public final QueryReportTaskResponse queryReportTask(String name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String name = "name3373707";
   QueryReportTaskResponse response = alphaAnalyticsDataClient.queryReportTask(name);
 }
      Parameters:
      name - Required. The report source name. Format: `properties/{property}/reportTasks/{report}`
      Throws:
      ApiException - if the remote call fails

    • queryReportTask

      public final 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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   QueryReportTaskRequest request =
       QueryReportTaskRequest.newBuilder()
           .setName("name3373707")
           .setOffset(-1019779949)
           .setLimit(102976443)
           .build();
   QueryReportTaskResponse response = alphaAnalyticsDataClient.queryReportTask(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • queryReportTaskCallable

      public final UnaryCallable<QueryReportTaskRequest,QueryReportTaskResponse> queryReportTaskCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   QueryReportTaskRequest request =
       QueryReportTaskRequest.newBuilder()
           .setName("name3373707")
           .setOffset(-1019779949)
           .setLimit(102976443)
           .build();
   ApiFuture<QueryReportTaskResponse> future =
       alphaAnalyticsDataClient.queryReportTaskCallable().futureCall(request);
   // Do something.
   QueryReportTaskResponse response = future.get();
 }

    • getReportTask

      public final ReportTask getReportTask(ReportTaskName name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   ReportTaskName name = ReportTaskName.of("[PROPERTY]", "[REPORT_TASK]");
   ReportTask response = alphaAnalyticsDataClient.getReportTask(name);
 }
      Parameters:
      name - Required. The report task resource name. Format: `properties/{property}/reportTasks/{report_task}`
      Throws:
      ApiException - if the remote call fails

    • getReportTask

      public final ReportTask getReportTask(String name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String name = ReportTaskName.of("[PROPERTY]", "[REPORT_TASK]").toString();
   ReportTask response = alphaAnalyticsDataClient.getReportTask(name);
 }
      Parameters:
      name - Required. The report task resource name. Format: `properties/{property}/reportTasks/{report_task}`
      Throws:
      ApiException - if the remote call fails

    • getReportTask

      public final 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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   GetReportTaskRequest request =
       GetReportTaskRequest.newBuilder()
           .setName(ReportTaskName.of("[PROPERTY]", "[REPORT_TASK]").toString())
           .build();
   ReportTask response = alphaAnalyticsDataClient.getReportTask(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getReportTaskCallable

      public final UnaryCallable<GetReportTaskRequest,ReportTask> getReportTaskCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   GetReportTaskRequest request =
       GetReportTaskRequest.newBuilder()
           .setName(ReportTaskName.of("[PROPERTY]", "[REPORT_TASK]").toString())
           .build();
   ApiFuture<ReportTask> future =
       alphaAnalyticsDataClient.getReportTaskCallable().futureCall(request);
   // Do something.
   ReportTask response = future.get();
 }

    • listReportTasks

      public final AlphaAnalyticsDataClient.ListReportTasksPagedResponse listReportTasks(PropertyName parent)
      Lists all report tasks for a property.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (ReportTask element : alphaAnalyticsDataClient.listReportTasks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. All report tasks for this property will be listed in the response. Format: `properties/{property}`
      Throws:
      ApiException - if the remote call fails

    • listReportTasks

      public final AlphaAnalyticsDataClient.ListReportTasksPagedResponse listReportTasks(String parent)
      Lists all report tasks for a property.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (ReportTask element : alphaAnalyticsDataClient.listReportTasks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. All report tasks for this property will be listed in the response. Format: `properties/{property}`
      Throws:
      ApiException - if the remote call fails

    • listReportTasks

      public final AlphaAnalyticsDataClient.ListReportTasksPagedResponse listReportTasks(ListReportTasksRequest request)
      Lists all report tasks for a property.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   ListReportTasksRequest request =
       ListReportTasksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ReportTask element : alphaAnalyticsDataClient.listReportTasks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listReportTasksPagedCallable

      public final UnaryCallable<ListReportTasksRequest,AlphaAnalyticsDataClient.ListReportTasksPagedResponse> listReportTasksPagedCallable()
      Lists all report tasks for a property.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   ListReportTasksRequest request =
       ListReportTasksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ReportTask> future =
       alphaAnalyticsDataClient.listReportTasksPagedCallable().futureCall(request);
   // Do something.
   for (ReportTask element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listReportTasksCallable

      public final UnaryCallable<ListReportTasksRequest,ListReportTasksResponse> listReportTasksCallable()
      Lists all report tasks for a property.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   ListReportTasksRequest request =
       ListReportTasksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListReportTasksResponse response =
         alphaAnalyticsDataClient.listReportTasksCallable().call(request);
     for (ReportTask element : response.getReportTasksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • runReport

      public final 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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   RunReportRequest request =
       RunReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .addAllDateRanges(new ArrayList<DateRange>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setOffset(-1019779949)
           .setLimit(102976443)
           .addAllMetricAggregations(new ArrayList<MetricAggregation>())
           .addAllOrderBys(new ArrayList<OrderBy>())
           .setCurrencyCode("currencyCode1004773790")
           .setCohortSpec(CohortSpec.newBuilder().build())
           .setKeepEmptyRows(true)
           .setReturnPropertyQuota(true)
           .addAllComparisons(new ArrayList<Comparison>())
           .setConversionSpec(ConversionSpec.newBuilder().build())
           .build();
   RunReportResponse response = alphaAnalyticsDataClient.runReport(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • runReportCallable

      public final UnaryCallable<RunReportRequest,RunReportResponse> runReportCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   RunReportRequest request =
       RunReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .addAllDateRanges(new ArrayList<DateRange>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setOffset(-1019779949)
           .setLimit(102976443)
           .addAllMetricAggregations(new ArrayList<MetricAggregation>())
           .addAllOrderBys(new ArrayList<OrderBy>())
           .setCurrencyCode("currencyCode1004773790")
           .setCohortSpec(CohortSpec.newBuilder().build())
           .setKeepEmptyRows(true)
           .setReturnPropertyQuota(true)
           .addAllComparisons(new ArrayList<Comparison>())
           .setConversionSpec(ConversionSpec.newBuilder().build())
           .build();
   ApiFuture<RunReportResponse> future =
       alphaAnalyticsDataClient.runReportCallable().futureCall(request);
   // Do something.
   RunReportResponse response = future.get();
 }

    • getMetadata

      public final Metadata getMetadata(MetadataName name)
      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`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   MetadataName name = MetadataName.of("[PROPERTY]");
   Metadata response = alphaAnalyticsDataClient.getMetadata(name);
 }
      Parameters:
      name - Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).

      Example: properties/1234/metadata

      Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

      Throws:
      ApiException - if the remote call fails

    • getMetadata

      public final Metadata getMetadata(String name)
      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`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   String name = MetadataName.of("[PROPERTY]").toString();
   Metadata response = alphaAnalyticsDataClient.getMetadata(name);
 }
      Parameters:
      name - Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).

      Example: properties/1234/metadata

      Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

      Throws:
      ApiException - if the remote call fails

    • getMetadata

      public final 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`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   GetMetadataRequest request =
       GetMetadataRequest.newBuilder().setName(MetadataName.of("[PROPERTY]").toString()).build();
   Metadata response = alphaAnalyticsDataClient.getMetadata(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getMetadataCallable

      public final UnaryCallable<GetMetadataRequest,Metadata> getMetadataCallable()
      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`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   GetMetadataRequest request =
       GetMetadataRequest.newBuilder().setName(MetadataName.of("[PROPERTY]").toString()).build();
   ApiFuture<Metadata> future =
       alphaAnalyticsDataClient.getMetadataCallable().futureCall(request);
   // Do something.
   Metadata response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException