Class AlphaAnalyticsDataClient (0.40.0)

public class AlphaAnalyticsDataClient 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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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.

Inheritance

java.lang.Object > AlphaAnalyticsDataClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final AlphaAnalyticsDataClient create()

Constructs an instance of AlphaAnalyticsDataClient with default settings.

Returns
Type	Description
`AlphaAnalyticsDataClient`

Exceptions
Type	Description
`IOException`

create(AlphaAnalyticsDataSettings settings)

public static final AlphaAnalyticsDataClient create(AlphaAnalyticsDataSettings settings)

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.

Parameter
Name	Description
`settings`	`AlphaAnalyticsDataSettings`

Returns
Type	Description
`AlphaAnalyticsDataClient`

Exceptions
Type	Description
`IOException`

create(AlphaAnalyticsDataStub stub)

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

Parameter
Name	Description
`stub`	`AlphaAnalyticsDataStub`

Returns
Type	Description
`AlphaAnalyticsDataClient`

Constructors

AlphaAnalyticsDataClient(AlphaAnalyticsDataSettings settings)

protected AlphaAnalyticsDataClient(AlphaAnalyticsDataSettings settings)

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.

Parameter
Name	Description
`settings`	`AlphaAnalyticsDataSettings`

AlphaAnalyticsDataClient(AlphaAnalyticsDataStub stub)

protected AlphaAnalyticsDataClient(AlphaAnalyticsDataStub stub)

Parameter
Name	Description
`stub`	`AlphaAnalyticsDataStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

createAudienceListAsync(CreateAudienceListRequest request)

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.

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.

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("[PROPERTYID]").toString())
           .setAudienceList(AudienceList.newBuilder().build())
           .build();
   AudienceList response = alphaAnalyticsDataClient.createAudienceListAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateAudienceListRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<AudienceList,AudienceListMetadata>`

createAudienceListAsync(PropertyName parent, AudienceList audienceList)

public final OperationFuture<AudienceList,AudienceListMetadata> createAudienceListAsync(PropertyName parent, AudienceList audienceList)

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("[PROPERTYID]");
   AudienceList audienceList = AudienceList.newBuilder().build();
   AudienceList response =
       alphaAnalyticsDataClient.createAudienceListAsync(parent, audienceList).get();
 }

Parameters
Name	Description
`parent`	`PropertyName` Required. The parent resource where this audience list will be created. Format: `properties/{propertyId}`
`audienceList`	`AudienceList` Required. The audience list to create.

Returns
Type	Description
`OperationFuture<AudienceList,AudienceListMetadata>`

createAudienceListAsync(String parent, AudienceList audienceList)

public final OperationFuture<AudienceList,AudienceListMetadata> createAudienceListAsync(String parent, AudienceList audienceList)

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("[PROPERTYID]").toString();
   AudienceList audienceList = AudienceList.newBuilder().build();
   AudienceList response =
       alphaAnalyticsDataClient.createAudienceListAsync(parent, audienceList).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where this audience list will be created. Format: `properties/{propertyId}`
`audienceList`	`AudienceList` Required. The audience list to create.

Returns
Type	Description
`OperationFuture<AudienceList,AudienceListMetadata>`

createAudienceListCallable()

public final UnaryCallable<CreateAudienceListRequest,Operation> createAudienceListCallable()

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("[PROPERTYID]").toString())
           .setAudienceList(AudienceList.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       alphaAnalyticsDataClient.createAudienceListCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateAudienceListRequest,Operation>`

createAudienceListOperationCallable()

public final OperationCallable<CreateAudienceListRequest,AudienceList,AudienceListMetadata> createAudienceListOperationCallable()

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("[PROPERTYID]").toString())
           .setAudienceList(AudienceList.newBuilder().build())
           .build();
   OperationFuture<AudienceList, AudienceListMetadata> future =
       alphaAnalyticsDataClient.createAudienceListOperationCallable().futureCall(request);
   // Do something.
   AudienceList response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateAudienceListRequest,AudienceList,AudienceListMetadata>`

getAudienceList(AudienceListName name)

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.

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("[PROPERTYID]", "[AUDIENCELISTID]");
   AudienceList response = alphaAnalyticsDataClient.getAudienceList(name);
 }

Parameter
Name	Description
`name`	`AudienceListName` Required. The audience list resource name. Format: `properties/{propertyId}/audienceLists/{audienceListId}`

Returns
Type	Description
`AudienceList`

getAudienceList(GetAudienceListRequest request)

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.

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("[PROPERTYID]", "[AUDIENCELISTID]").toString())
           .build();
   AudienceList response = alphaAnalyticsDataClient.getAudienceList(request);
 }

Parameter
Name	Description
`request`	`GetAudienceListRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AudienceList`

getAudienceList(String name)

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.

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("[PROPERTYID]", "[AUDIENCELISTID]").toString();
   AudienceList response = alphaAnalyticsDataClient.getAudienceList(name);
 }

Parameter
Name	Description
`name`	`String` Required. The audience list resource name. Format: `properties/{propertyId}/audienceLists/{audienceListId}`

Returns
Type	Description
`AudienceList`

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.

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("[PROPERTYID]", "[AUDIENCELISTID]").toString())
           .build();
   ApiFuture<AudienceList> future =
       alphaAnalyticsDataClient.getAudienceListCallable().futureCall(request);
   // Do something.
   AudienceList response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetAudienceListRequest,AudienceList>`

getHttpJsonOperationsClient()

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.

Returns
Type	Description
`OperationsClient`

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.

Returns
Type	Description
`OperationsClient`

getSettings()

public final AlphaAnalyticsDataSettings getSettings()

Returns
Type	Description
`AlphaAnalyticsDataSettings`

getStub()

public AlphaAnalyticsDataStub getStub()

Returns
Type	Description
`AlphaAnalyticsDataStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listAudienceLists(ListAudienceListsRequest request)

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.

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("[PROPERTYID]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AudienceList element :
       alphaAnalyticsDataClient.listAudienceLists(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListAudienceListsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AlphaAnalyticsDataClient.ListAudienceListsPagedResponse`

listAudienceLists(PropertyName parent)

public final AlphaAnalyticsDataClient.ListAudienceListsPagedResponse listAudienceLists(PropertyName parent)

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("[PROPERTYID]");
   for (AudienceList element : alphaAnalyticsDataClient.listAudienceLists(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`PropertyName` Required. All audience lists for this property will be listed in the response. Format: `properties/{propertyId}`

Returns
Type	Description
`AlphaAnalyticsDataClient.ListAudienceListsPagedResponse`

listAudienceLists(String parent)

public final AlphaAnalyticsDataClient.ListAudienceListsPagedResponse listAudienceLists(String parent)

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("[PROPERTYID]").toString();
   for (AudienceList element : alphaAnalyticsDataClient.listAudienceLists(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. All audience lists for this property will be listed in the response. Format: `properties/{propertyId}`

Returns
Type	Description
`AlphaAnalyticsDataClient.ListAudienceListsPagedResponse`

listAudienceListsCallable()

public final UnaryCallable<ListAudienceListsRequest,ListAudienceListsResponse> listAudienceListsCallable()

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("[PROPERTYID]").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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListAudienceListsRequest,ListAudienceListsResponse>`

listAudienceListsPagedCallable()

public final UnaryCallable<ListAudienceListsRequest,AlphaAnalyticsDataClient.ListAudienceListsPagedResponse> listAudienceListsPagedCallable()

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("[PROPERTYID]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AudienceList> future =
       alphaAnalyticsDataClient.listAudienceListsPagedCallable().futureCall(request);
   // Do something.
   for (AudienceList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListAudienceListsRequest,ListAudienceListsPagedResponse>`

queryAudienceList(QueryAudienceListRequest request)

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.

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.

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);
 }

Parameter
Name	Description
`request`	`QueryAudienceListRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`QueryAudienceListResponse`

queryAudienceList(String name)

public final QueryAudienceListResponse queryAudienceList(String name)

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.

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);
 }

Parameter
Name	Description
`name`	`String` The name of the audience list to retrieve users from. Format: `properties/{propertyId}/audienceLists/{audienceListId}`

Returns
Type	Description
`QueryAudienceListResponse`

queryAudienceListCallable()

public final UnaryCallable<QueryAudienceListRequest,QueryAudienceListResponse> queryAudienceListCallable()

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.

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();
 }

Returns
Type	Description
`UnaryCallable<QueryAudienceListRequest,QueryAudienceListResponse>`

runFunnelReport(RunFunnelReportRequest request)

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.

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.

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);
 }

Parameter
Name	Description
`request`	`RunFunnelReportRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RunFunnelReportResponse`

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.

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();
 }

Returns
Type	Description
`UnaryCallable<RunFunnelReportRequest,RunFunnelReportResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()