Method: properties.audienceLists.exportSheet

將使用者的目標對象名單匯出至 Google 試算表。建立目標對象後，該名使用者就無法立即顯示在商店資訊中。首先，您必須向 audienceLists.create 發出要求，才能建立使用者目標對象名單，然後再使用這個方法將目標對象名單中的這些使用者匯出至 Google 試算表。

如需目標對象名單和範例，請參閱「建立目標對象名單」一文。

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

這種方法在 Alpha 版穩定性階段推出，用意是在進入 Beta 版前，先收集有關語法和功能的意見回饋。如要針對這個 API 提出意見，請填寫 Google Analytics (分析) Audience Export API 意見回饋表單。

HTTP 要求

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:exportSheet

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

必要欄位。待擷取使用者的目標對象名單名稱。格式︰properties/{property}/audienceLists/{audienceList}

要求主體

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

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 列數。

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

回應主體

已建立的 Google 試算表，其中含有目標對象名單中的使用者清單。

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

JSON 表示法 
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
欄位
spreadsheetUri

string

您可以使用瀏覽器前往查看 Google 試算表的 URI。
spreadsheetId

string

用於識別所建立 Google 試算表資源的 ID。
rowCount

integer

AudienceList 結果中的總列數。rowCount 與回應中傳回的資料列數量、limit 要求參數和 offset 要求參數不同。舉例來說，如果查詢傳回 175 列，並在 API 要求中包含 50 的 limit，則回應中會包含 175 的 rowCount，但只有 50 列。

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

object (AudienceList)

所匯出 AudienceList 的設定資料。回傳這份回覆以協助您解讀這則回覆在 Google 試算表中提供的目標對象名單。

舉例來說，AudienceList 中所含的資料列數量可能超過 Google 試算表中的列數。在這種情況下，建議你傳送另一個工作表匯出要求，並加上不同的 offset 值，以擷取其他 Google 試算表中的資料列。

授權範圍

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

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets