擷取使用者的目標對象名單。建立目標對象後,該名使用者就無法立即顯示在商店資訊中。首先,您必須向 audienceLists.create
發出要求,才能建立使用者目標對象名單,然後再使用此方法擷取目標對象名單中的使用者。
如需目標對象名單和範例,請參閱「建立目標對象名單」一文。
Google Analytics (分析) 4 目標對像功能可讓您根據自家業務的需求區隔使用者。詳情請參閱 https://support.google.com/analytics/answer/9267572。
此方法適用於 audienceExports.query 的 Beta 版穩定性。如要針對這個 API 提出意見,請填寫 Google Analytics (分析) Audience Export API 意見回饋表單。
HTTP 要求
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
必要欄位。待擷取使用者的目標對象名單名稱。格式︰ |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "offset": string, "limit": string } |
欄位 | |
---|---|
offset |
選用設定。起始資料列的列數。第一列會計為第 0 列。 進行分頁時,第一個要求不會指定偏移值,或同樣地將偏移值設為 0;第一個要求會傳回資料列的前 如要進一步瞭解這個分頁參數,請參閱分頁。 |
limit |
選用設定。要傳回的列數。如果未指定,則會傳回 10,000 列。無論您要求的數量為何,API 每個要求最多只能傳回 250,000 個資料列。 如果維度值數量不是 如要進一步瞭解這個分頁參數,請參閱分頁。 |
回應主體
目標對象名單中的使用者清單。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{ "audienceRows": [ { object ( |
欄位 | |
---|---|
audienceRows[] |
目標對象名單中每位使用者的資料列。此回應中的列數會小於或等於要求的頁面大小。 |
audienceList |
所查詢 AudienceList 的設定資料。系統傳回這個欄位,以便解讀這則回覆中的目標對象資料列。舉例來說,這個 AudienceList 中的維度會與 AudienceRows 中的資料欄相對應。 |
rowCount |
AudienceList 結果中的總列數。 如要進一步瞭解這個分頁參數,請參閱分頁。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
AudienceRow
目標對象使用者列的維度值屬性。
JSON 表示法 |
---|
{
"dimensionValues": [
{
object ( |
欄位 | |
---|---|
dimensionValues[] |
目標對象使用者的每個維度值屬性。每個要求的維度欄都會加入一個維度值。 |
AudienceDimensionValue
維度的值。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 one_value 。一種維度值。one_value 只能是下列其中一項: |
|
value |
如果維度類型是字串,則會顯示字串的值。 |