Method: properties.audienceExports.query

擷取使用者的目標對象匯出資料。建立目標對象後，使用者無法立即匯出。首先，您必須向 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

string

必要欄位。要擷取使用者的目標對象匯出項目名稱。格式：properties/{property}/audienceExports/{audienceExport}

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "offset": string,
  "limit": string
}
欄位
offset

string (int64 format)

選用設定。起始資料列的列數。第一列會計為第 0 列。

分頁時，第一個要求不會指定偏移量，也就是將偏移量設為 0；第一個要求會傳回第一個 limit 資料列。第二個要求會將偏移量設為第一個要求的 limit；第二個要求會傳回資料列的第二個 limit。

如要進一步瞭解這個分頁參數，請參閱「分頁」。
limit

string (int64 format)

選用設定。代表要傳回的列數。如未指定，系統會傳回 10,000 列。無論您要求多少資料列，API 每項要求最多會傳回 250,000 列。limit 必須為正數。

如果維度值的數量不如 limit 多，API 傳回的資料列可能會比要求的 limit 少。

如要進一步瞭解這個分頁參數，請參閱「分頁」。

回應主體

目標對象匯出作業中的使用者清單。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceExport": {
    object (AudienceExport)
  },
  "rowCount": integer
}
欄位
audienceRows[]

object (AudienceRow)

目標對象匯出資料中的每位使用者資料列。這個回應中的資料列數量會小於或等於要求的頁面大小。
audienceExport

object (AudienceExport)

要查詢的 AudienceExport 設定資料。系統會傳回這項資料，協助您解讀此回應中的目標對象資料列。舉例來說，這個 AudienceExport 中的維度會對應到 AudienceRows 中的資料欄。
rowCount

integer

AudienceExport 結果中的資料列總數。rowCount 與回應中傳回的資料列數、limit 要求參數和 offset 要求參數無關。舉例來說，如果查詢傳回 175 列，且 API 要求中包含 limit 50，回應就會包含 rowCount 175，但只有 50 列。

如要進一步瞭解這個分頁參數，請參閱「分頁」。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

AudienceRow

目標對象使用者資料列的維度值屬性。

JSON 表示法 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
欄位
dimensionValues[]

object (AudienceDimensionValue)

目標對象使用者的每個維度值屬性。系統會為每個要求的維度欄新增一個維度值。

AudienceDimensionValue

維度的值。

JSON 表示法 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
欄位
聯集欄位 one_value。一種維度值。one_value 只能是下列其中一項：
value

string

如果維度類型為字串，則值為字串。