Interface AlphaAnalyticsDataGrpc.AsyncService (0.55.0)

Version latest

• 0.55.0 (latest)
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.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. See Creating an Audience List 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. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

Parameters
Name	Description
request	CreateAudienceListRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

createRecurringAudienceList(CreateRecurringAudienceListRequest request, StreamObserver<RecurringAudienceList> responseObserver)

public default void createRecurringAudienceList(CreateRecurringAudienceListRequest request, StreamObserver<RecurringAudienceList> responseObserver)

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

Parameters
Name	Description
request	CreateRecurringAudienceListRequest
responseObserver	io.grpc.stub.StreamObserver<RecurringAudienceList>

createReportTask(CreateReportTaskRequest request, StreamObserver<Operation> responseObserver)

public default void createReportTask(CreateReportTaskRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	CreateReportTaskRequest
responseObserver	io.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. See Creating an Audience List for an introduction to Audience Lists with examples. This method is available at beta stability at audienceExports.get. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

Parameters
Name	Description
request	GetAudienceListRequest
responseObserver	io.grpc.stub.StreamObserver<AudienceList>

getRecurringAudienceList(GetRecurringAudienceListRequest request, StreamObserver<RecurringAudienceList> responseObserver)

public default void getRecurringAudienceList(GetRecurringAudienceListRequest request, StreamObserver<RecurringAudienceList> responseObserver)

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

Parameters
Name	Description
request	GetRecurringAudienceListRequest
responseObserver	io.grpc.stub.StreamObserver<RecurringAudienceList>

getReportTask(GetReportTaskRequest request, StreamObserver<ReportTask> responseObserver)

public default void getReportTask(GetReportTaskRequest request, StreamObserver<ReportTask> responseObserver)

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.

Parameters
Name	Description
request	GetReportTaskRequest
responseObserver	io.grpc.stub.StreamObserver<ReportTask>

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. See Creating an Audience List for an introduction to Audience Lists with examples. This method is available at beta stability at audienceExports.list. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

Parameters
Name	Description
request	ListAudienceListsRequest
responseObserver	io.grpc.stub.StreamObserver<ListAudienceListsResponse>

listRecurringAudienceLists(ListRecurringAudienceListsRequest request, StreamObserver<ListRecurringAudienceListsResponse> responseObserver)

public default void listRecurringAudienceLists(ListRecurringAudienceListsRequest request, StreamObserver<ListRecurringAudienceListsResponse> responseObserver)

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

Parameters
Name	Description
request	ListRecurringAudienceListsRequest
responseObserver	io.grpc.stub.StreamObserver<ListRecurringAudienceListsResponse>

listReportTasks(ListReportTasksRequest request, StreamObserver<ListReportTasksResponse> responseObserver)

public default void listReportTasks(ListReportTasksRequest request, StreamObserver<ListReportTasksResponse> responseObserver)

Lists all report tasks for a property.

Parameters
Name	Description
request	ListReportTasksRequest
responseObserver	io.grpc.stub.StreamObserver<ListReportTasksResponse>

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 list. See Creating an Audience List 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. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

Parameters
Name	Description
request	QueryAudienceListRequest
responseObserver	io.grpc.stub.StreamObserver<QueryAudienceListResponse>

queryReportTask(QueryReportTaskRequest request, StreamObserver<QueryReportTaskResponse> responseObserver)

public default void queryReportTask(QueryReportTaskRequest request, StreamObserver<QueryReportTaskResponse> responseObserver)

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.

Parameters
Name	Description
request	QueryReportTaskRequest
responseObserver	io.grpc.stub.StreamObserver<QueryReportTaskResponse>

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
Name	Description
request	RunFunnelReportRequest
responseObserver	io.grpc.stub.StreamObserver<RunFunnelReportResponse>

sheetExportAudienceList(SheetExportAudienceListRequest request, StreamObserver<SheetExportAudienceListResponse> responseObserver)

public default void sheetExportAudienceList(SheetExportAudienceListRequest request, StreamObserver<SheetExportAudienceListResponse> responseObserver)

Exports an audience list of users to a Google Sheet. 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 export those users in the audience list to a Google Sheet. See Creating an Audience List 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 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 form.

Parameters
Name	Description
request	SheetExportAudienceListRequest
responseObserver	io.grpc.stub.StreamObserver<SheetExportAudienceListResponse>