class PropertiesAudienceExports extends Resource (View source)

The "audienceExports" collection of methods.

Typical usage is:

 $analyticsdataService = new Google\Service\AnalyticsData(...);
 $audienceExports = $analyticsdataService->properties_audienceExports;

Methods

create(string $parent, AudienceExport $postBody, array $optParams = [])

Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the QueryAudienceExport method. See Creating an Audience Export for an introduction to Audience Exports with examples. An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports 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 exports contain the users in each audience. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form. (audienceExports.create)

get(string $name, array $optParams = [])

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. See Creating an Audience Export for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form. (audienceExports.get)

listPropertiesAudienceExports(string $parent, array $optParams = [])

Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days. See Creating an Audience Export for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

query(string $name, QueryAudienceExportRequest $postBody, array $optParams = [])

Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to CreateAudienceExport is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export. See Creating an Audience Export for an introduction to Audience Exports 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. Audience Export APIs have some methods at alpha and other methods at beta stability.

Details

Operation create(string $parent, AudienceExport $postBody, array $optParams = [])

Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the QueryAudienceExport method. See Creating an Audience Export for an introduction to Audience Exports with examples. An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports 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 exports contain the users in each audience. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form. (audienceExports.create)

Parameters

string $parent

Required. The parent resource where this audience export will be created. Format: properties/{property}

AudienceExport $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

AudienceExport get(string $name, array $optParams = [])

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. See Creating an Audience Export for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form. (audienceExports.get)

Parameters

string $name

Required. The audience export resource name. Format: properties/{property}/audienceExports/{audience_export}

array $optParams

Optional parameters.

Return Value

AudienceExport

Exceptions

Exception

ListAudienceExportsResponse listPropertiesAudienceExports(string $parent, array $optParams = [])

Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days. See Creating an Audience Export for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

(audienceExports.listPropertiesAudienceExports)

Parameters

string $parent

Required. All audience exports for this property will be listed in the response. Format: properties/{property}

array $optParams

Optional parameters.

Return Value

ListAudienceExportsResponse

Exceptions

Exception

QueryAudienceExportResponse query(string $name, QueryAudienceExportRequest $postBody, array $optParams = [])

Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to CreateAudienceExport is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export. See Creating an Audience Export for an introduction to Audience Exports 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. Audience Export APIs have some methods at alpha and other methods at beta stability.

The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form. (audienceExports.query)

Parameters

string $name

Required. The name of the audience export to retrieve users from. Format: properties/{property}/audienceExports/{audience_export}

QueryAudienceExportRequest $postBody
array $optParams

Optional parameters.

Return Value

QueryAudienceExportResponse

Exceptions

Exception