Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13106885.0 KB
properties

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.

post/v1beta/{+parent}/audienceExports

Path parameters

parentstring required

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

Request body

percentageCompletednumber double

Output only. The percentage completed for this audience export ranging between 0 to 100.

namestring

Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this AudienceExport. Format: properties/{property}/audienceExports/{audience_export}

creationQuotaTokensChargedinteger

Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the CREATING state, this tokens charged will be fixed once an AudienceExport enters the ACTIVE or FAILED states.

audienceDisplayNamestring

Output only. The descriptive display name for this audience. For example, "Purchasers".

rowCountinteger

Output only. The total number of rows in the AudienceExport result.

audiencestring

Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: properties/{property}/audiences/{audience}

errorMessagestring

Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'FAILED'

Output only. The current state for this AudienceExport.

beginCreatingTimestring google-datetime

Output only. The time when CreateAudienceExport was called and the AudienceExport began the CREATING state.

Response

Successful response