Method: properties.audienceExports.query

擷取使用者的目標對象匯出資料。建立目標對象後，使用者不會立即匯出。首先，您必須向 audienceExports.create 發出要求，建立使用者目標對象匯出項目，然後使用這個方法擷取目標對象匯出項目中的使用者。

如需目標對象匯出功能的簡介和範例，請參閱「建立目標對象匯出項目」。

Google Analytics 4 的目標對象功能可讓您根據自家業務需求區隔使用者。詳情請參閱 https://support.google.com/analytics/answer/9267572。

目標對象匯出 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 表示法 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
欄位
一種維度值。以下列出互斥的欄位。回應中最多只會設定一個欄位：
value

string

如果維度類型為字串，則值為字串。
互斥欄位的結尾。