Method: properties.audienceExports.query

擷取使用者匯出的使用者資料。建立目標對象後，使用者無法立即匯出內容。首先，您必須向 audienceExports.create 發出要求，才能建立目標對象匯出內容，然後再使用此方法擷取目標對象匯出檔案中的使用者。

如需目標對象匯出功能的簡介，請參閱「建立目標對象匯出」一文。

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

Audience Export API 在 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 要求中包含 50 的 limit，則回應中會包含 175 的 rowCount，但只有 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

如果維度類型是字串，則會顯示字串的值。