Interface AlphaAnalyticsDataGrpc.AsyncService (0.33.0)

public static interface AlphaAnalyticsDataGrpc.AsyncService

Google Analytics reporting data service.

Methods

createAudienceList(CreateAudienceListRequest request, StreamObserver<Operation> responseObserver)

public default void createAudienceList(CreateAudienceListRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
NameDescription
requestCreateAudienceListRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

getAudienceList(GetAudienceListRequest request, StreamObserver<AudienceList> responseObserver)

public default void getAudienceList(GetAudienceListRequest request, StreamObserver<AudienceList> responseObserver)

Gets configuration metadata about a specific audience list. This method can be used to understand an audience list after it has been created.

Parameters
NameDescription
requestGetAudienceListRequest
responseObserverio.grpc.stub.StreamObserver<AudienceList>

listAudienceLists(ListAudienceListsRequest request, StreamObserver<ListAudienceListsResponse> responseObserver)

public default void listAudienceLists(ListAudienceListsRequest request, StreamObserver<ListAudienceListsResponse> responseObserver)

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.

Parameters
NameDescription
requestListAudienceListsRequest
responseObserverio.grpc.stub.StreamObserver<ListAudienceListsResponse>

queryAudienceList(QueryAudienceListRequest request, StreamObserver<QueryAudienceListResponse> responseObserver)

public default void queryAudienceList(QueryAudienceListRequest request, StreamObserver<QueryAudienceListResponse> responseObserver)

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.

Parameters
NameDescription
requestQueryAudienceListRequest
responseObserverio.grpc.stub.StreamObserver<QueryAudienceListResponse>

runFunnelReport(RunFunnelReportRequest request, StreamObserver<RunFunnelReportResponse> responseObserver)

public default void runFunnelReport(RunFunnelReportRequest request, StreamObserver<RunFunnelReportResponse> responseObserver)

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.

Parameters
NameDescription
requestRunFunnelReportRequest
responseObserverio.grpc.stub.StreamObserver<RunFunnelReportResponse>