擷取使用者匯出的目標對象。建立目標對象後,使用者無法立即匯出。首先,您必須向 audienceExports.create
要求建立使用者目標對象匯出作業,其次,這個方法會用來擷取目標對象匯出項目中的使用者。
如需目標對象匯出功能的簡介和範例,請參閱「建立目標對象匯出」一文。
Google Analytics 4 中的目標對像功能可讓您根據自家業務的需求區隔使用者。詳情請參閱:https://support.google.com/analytics/answer/9267572。
Audience Export API 可使用部分 Alpha 版方法,以及維持 Beta 版穩定性的其他方法。目的是在收到一些意見回饋並採用後,進一步推進 Beta 版穩定性的方法。如要針對這個 API 提供意見回饋,請填寫 Google Analytics Audience Export API 意見回饋表單。
HTTP 要求
POST https://analyticsdata.googleapis.com/v1beta/{name=properties/*/audienceExports/*}:query
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
必要欄位。要從哪個目標對象匯出的名稱擷取使用者。格式: |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "offset": string, "limit": string } |
欄位 | |
---|---|
offset |
選用設定。起始資料列的列數。第一列會計為第 0 列。 分頁時,第一個要求不會指定位移;或同等規則,將偏移值設為 0;第一個要求會傳回前 如要進一步瞭解這個分頁參數,請參閱「分頁」。 |
limit |
選用設定。要傳回的列數。如未指定,系統會傳回 10,000 列。無論您要求多少列,API 在每個要求最多只能傳回 250,000 列。 如果維度值數量不如 如要進一步瞭解這個分頁參數,請參閱「分頁」。 |
回應主體
目標對象匯出檔案中的使用者名單。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "audienceRows": [ { object ( |
欄位 | |
---|---|
audienceRows[] |
目標對象匯出作業中每位使用者的資料列。這個回應中的列數會小於或等於要求的頁面大小。 |
audienceExport |
正在查詢 Audience Export 的設定資料。返回協助解讀這則回覆中的目標對象資料列。舉例來說,此 AudienceExport 中的維度會與 AudienceRows 中的資料欄對應。 |
rowCount |
AudienceExport 結果中的資料列總數。 如要進一步瞭解這個分頁參數,請參閱「分頁」。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
AudienceRow
目標對象使用者列的維度值屬性。
JSON 表示法 |
---|
{
"dimensionValues": [
{
object ( |
欄位 | |
---|---|
dimensionValues[] |
目標對象使用者的每個維度值屬性。每個要求的維度欄都會新增一個維度值。 |
AudienceDimensionValue
維度的值。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 one_value 。其中一種維度值,one_value 只能是下列其中一項: |
|
value |
如果維度類型是字串,則做為字串的值。 |