Reference documentation and code samples for the Google Analytics Data V1beta Client class AudienceExport.
An audience export is a list of users in an audience at the time of the
list's creation. One audience may have multiple audience exports created for
different days.
Generated from protobuf messagegoogle.analytics.data.v1beta.AudienceExport
Namespace
Google \ Analytics \ Data \ V1beta
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies thisAudienceExport. Format:properties/{property}/audienceExports/{audience_export}
↳ audience
string
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}
↳ audience_display_name
string
Output only. The descriptive display name for this audience. For example, "Purchasers".
Output only. The time when CreateAudienceExport was called and the AudienceExport began theCREATINGstate.
↳ creation_quota_tokens_charged
int
Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from theCREATINGstate, this tokens charged will be fixed once an AudienceExport enters theACTIVEorFAILEDstates.
↳ row_count
int
Output only. The total number of rows in the AudienceExport result.
↳ error_message
string
Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.
↳ percentage_completed
float
Output only. The percentage completed for this audience export ranging between 0 to 100.
getName
Output only. Identifier. The audience export resource name assigned during
creation. This resource name identifies thisAudienceExport.
Output only. The total quota tokens charged during creation of the
AudienceExport. Because this token count is based on activity from theCREATINGstate, this tokens charged will be fixed once an AudienceExport
enters theACTIVEorFAILEDstates.
Returns
Type
Description
int
setCreationQuotaTokensCharged
Output only. The total quota tokens charged during creation of the
AudienceExport. Because this token count is based on activity from theCREATINGstate, this tokens charged will be fixed once an AudienceExport
enters theACTIVEorFAILEDstates.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getRowCount
Output only. The total number of rows in the AudienceExport result.
Returns
Type
Description
int
hasRowCount
clearRowCount
setRowCount
Output only. The total number of rows in the AudienceExport result.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getErrorMessage
Output only. Error message is populated when an audience export fails
during creation. A common reason for such a failure is quota exhaustion.
Returns
Type
Description
string
hasErrorMessage
clearErrorMessage
setErrorMessage
Output only. Error message is populated when an audience export fails
during creation. A common reason for such a failure is quota exhaustion.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPercentageCompleted
Output only. The percentage completed for this audience export ranging
between 0 to 100.
Returns
Type
Description
float
hasPercentageCompleted
clearPercentageCompleted
setPercentageCompleted
Output only. The percentage completed for this audience export ranging
between 0 to 100.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Analytics Data V1beta Client - Class AudienceExport (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1beta.AudienceExport)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1beta.AudienceExport)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1beta.AudienceExport)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1beta.AudienceExport)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1beta.AudienceExport)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1beta.AudienceExport)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1beta.AudienceExport)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1beta.AudienceExport)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1beta.AudienceExport)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1beta.AudienceExport)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1beta.AudienceExport)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1beta.AudienceExport)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1beta.AudienceExport)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1beta.AudienceExport) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Data V1beta Client class AudienceExport.\n\nAn audience export is a list of users in an audience at the time of the\nlist's creation. One audience may have multiple audience exports created for\ndifferent days.\n\nGenerated from protobuf message `google.analytics.data.v1beta.AudienceExport`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1beta\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. Identifier. The audience export resource name assigned during\ncreation. This resource name identifies this `AudienceExport`.\n\nFormat: `properties/{property}/audienceExports/{audience_export}`\n\n### setName\n\nOutput only. Identifier. The audience export resource name assigned during\ncreation. This resource name identifies this `AudienceExport`.\n\nFormat: `properties/{property}/audienceExports/{audience_export}`\n\n### getAudience\n\nRequired. The audience resource name. This resource name identifies the\naudience being listed and is shared between the Analytics Data \\& Admin\nAPIs.\n\nFormat: `properties/{property}/audiences/{audience}`\n\n### setAudience\n\nRequired. The audience resource name. This resource name identifies the\naudience being listed and is shared between the Analytics Data \\& Admin\nAPIs.\n\nFormat: `properties/{property}/audiences/{audience}`\n\n### getAudienceDisplayName\n\nOutput only. The descriptive display name for this audience. For example,\n\"Purchasers\".\n\n### setAudienceDisplayName\n\nOutput only. The descriptive display name for this audience. For example,\n\"Purchasers\".\n\n### getDimensions\n\nRequired. The dimensions requested and displayed in the query response.\n\n### setDimensions\n\nRequired. The dimensions requested and displayed in the query response.\n\n### getState\n\nOutput only. The current state for this AudienceExport.\n\n### hasState\n\n### clearState\n\n### setState\n\nOutput only. The current state for this AudienceExport.\n\n### getBeginCreatingTime\n\nOutput only. The time when CreateAudienceExport was called and the\nAudienceExport began the `CREATING` state.\n\n### hasBeginCreatingTime\n\n### clearBeginCreatingTime\n\n### setBeginCreatingTime\n\nOutput only. The time when CreateAudienceExport was called and the\nAudienceExport began the `CREATING` state.\n\n### getCreationQuotaTokensCharged\n\nOutput only. The total quota tokens charged during creation of the\nAudienceExport. Because this token count is based on activity from the\n`CREATING` state, this tokens charged will be fixed once an AudienceExport\nenters the `ACTIVE` or `FAILED` states.\n\n### setCreationQuotaTokensCharged\n\nOutput only. The total quota tokens charged during creation of the\nAudienceExport. Because this token count is based on activity from the\n`CREATING` state, this tokens charged will be fixed once an AudienceExport\nenters the `ACTIVE` or `FAILED` states.\n\n### getRowCount\n\nOutput only. The total number of rows in the AudienceExport result.\n\n### hasRowCount\n\n### clearRowCount\n\n### setRowCount\n\nOutput only. The total number of rows in the AudienceExport result.\n\n### getErrorMessage\n\nOutput only. Error message is populated when an audience export fails\nduring creation. A common reason for such a failure is quota exhaustion.\n\n### hasErrorMessage\n\n### clearErrorMessage\n\n### setErrorMessage\n\nOutput only. Error message is populated when an audience export fails\nduring creation. A common reason for such a failure is quota exhaustion.\n\n### getPercentageCompleted\n\nOutput only. The percentage completed for this audience export ranging\nbetween 0 to 100.\n\n### hasPercentageCompleted\n\n### clearPercentageCompleted\n\n### setPercentageCompleted\n\nOutput only. The percentage completed for this audience export ranging\nbetween 0 to 100."]]
