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

URI,您必須在瀏覽器中前往這個 URI 才能查看 Google 試算表。

spreadsheetId

string

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

rowCount

integer

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

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

audienceList

object (AudienceList)

匯出的目標對象名單設定資料。返回協助解讀這則回覆 Google 試算表中的目標對象名單。

舉例來說,與 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