REST Resource: properties.audienceLists

ทรัพยากร: AudienceList

รายการกลุ่มเป้าหมายคือรายการผู้ใช้ในกลุ่มเป้าหมาย ณ เวลาที่สร้างรายการ กลุ่มเป้าหมาย 1 กลุ่มอาจมีรายการกลุ่มเป้าหมายหลายรายการที่สร้างไว้สำหรับวันที่แตกต่างกัน

การแสดง JSON 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
ช่อง
name

string

เอาต์พุตเท่านั้น ตัวระบุ ชื่อทรัพยากรรายการกลุ่มเป้าหมายที่กำหนดไว้ในระหว่างการสร้าง ชื่อทรัพยากรนี้จะระบุ AudienceList นี้

รูปแบบ: properties/{property}/audienceLists/{audienceList}
audience

string

ต้องระบุ ชื่อทรัพยากรกลุ่มเป้าหมาย ชื่อทรัพยากรนี้จะระบุกลุ่มเป้าหมายที่แสดงอยู่และแชร์ระหว่าง Analytics Data และ Admin API

รูปแบบ: properties/{property}/audiences/{audience}
audienceDisplayName

string

เอาต์พุตเท่านั้น ชื่อที่แสดงที่สื่อความหมายสําหรับกลุ่มเป้าหมายนี้ เช่น "ผู้ซื้อ"
dimensions[]

object (AudienceDimension)

ต้องระบุ มิติข้อมูลที่ขอและแสดงในการตอบกลับการค้นหา
creationQuotaTokensCharged

integer

เอาต์พุตเท่านั้น โทเค็นโควต้าทั้งหมดที่เรียกเก็บในระหว่างการสร้าง AudienceList เนื่องจากจำนวนโทเค็นนี้อิงตามกิจกรรมจากสถานะ CREATING ระบบจะเรียกเก็บโทเค็นนี้แบบคงที่เมื่อ AudienceList เข้าสู่สถานะ ACTIVE หรือ FAILED
state

enum (State)

เอาต์พุตเท่านั้น สถานะปัจจุบันของ AudienceList นี้
beginCreatingTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่มีการเรียกใช้ audienceLists.create และ AudienceList เริ่มเข้าสู่สถานะ CREATING

การประทับเวลาในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและทศนิยมสูงสุด 9 หลัก ตัวอย่างเช่น "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
rowCount

integer

เอาต์พุตเท่านั้น จํานวนแถวทั้งหมดในผลลัพธ์ AudienceList
errorMessage

string

เอาต์พุตเท่านั้น ระบบจะแสดงข้อความแสดงข้อผิดพลาดเมื่อสร้างรายการกลุ่มเป้าหมายไม่สําเร็จ สาเหตุที่พบบ่อยของปัญหานี้คือโควต้าหมด
percentageCompleted

number

เอาต์พุตเท่านั้น เปอร์เซ็นต์การส่งออกกลุ่มเป้าหมายนี้ที่เสร็จสมบูรณ์จะอยู่ระหว่าง 0 ถึง 100
recurringAudienceList

string

เอาต์พุตเท่านั้น รายการกลุ่มเป้าหมายตามรอบที่สร้างรายการกลุ่มเป้าหมายนี้ รายการกลุ่มเป้าหมายที่เกิดซ้ำจะสร้างรายการกลุ่มเป้าหมายทุกวัน

หากสร้างรายการกลุ่มเป้าหมายโดยตรง รายการเหล่านั้นจะไม่มีรายการกลุ่มเป้าหมายตามรอบที่เกี่ยวข้อง และช่องนี้จะว่างเปล่า
webhookNotification

object (WebhookNotification)

ไม่บังคับ กําหนดค่าการแจ้งเตือนแบบเว็บฮุคที่จะส่งจาก Google Analytics Data API ไปยังเซิร์ฟเวอร์เว็บฮุค คุณจะใช้ Webhook หรือไม่ก็ได้ หากไม่ได้ใช้ คุณจะต้องทำการสำรวจ API นี้เพื่อดูว่ารายการกลุ่มเป้าหมายพร้อมใช้งานเมื่อใด Webhook ช่วยให้สามารถส่งการแจ้งเตือนไปยังเซิร์ฟเวอร์และไม่ต้องทำการสำรวจ

ระบบจะส่งคําขอ POST 1 หรือ 2 รายการไปยัง Webhook ระบบจะส่งคําขอ POST รายการแรกทันทีเพื่อแสดงรายการกลุ่มเป้าหมายที่สร้างขึ้นใหม่ในสถานะ "สร้าง" ระบบจะส่งคําขอ POST รายการที่ 2 หลังจากสร้างรายการกลุ่มเป้าหมายเสร็จสมบูรณ์ (สถานะ "ใช้งานอยู่" หรือ "ไม่สําเร็จ")

หากมีการขอรายการกลุ่มเป้าหมายที่เหมือนกันติดต่อกันหลายครั้ง ระบบจะแสดงรายการกลุ่มเป้าหมายที่ 2 และรายการต่อๆ ไปจากแคช ในกรณีนี้ วิธีการสร้างรายการกลุ่มเป้าหมายจะแสดงผลรายการกลุ่มเป้าหมายที่ "ใช้งานอยู่" อยู่แล้ว ในกรณีนี้ ระบบจะส่งคำขอ POST เพียงรายการเดียวไปยัง Webhook

รัฐ

ขณะนี้ AudienceList อยู่ในสถานะนี้

Enum
STATE_UNSPECIFIED ระบบจะไม่ใช้สถานะที่ไม่ระบุ
CREATING ขณะนี้ระบบกําลังสร้าง AudienceList และจะพร้อมใช้งานในอนาคต การสร้างจะเกิดขึ้นทันทีหลังจากการเรียกใช้ audienceLists.create
ACTIVE AudienceList สร้างเสร็จสมบูรณ์และพร้อมสําหรับการค้นหาแล้ว ระบบจะอัปเดต AudienceList เป็น "ใช้งานอยู่" แบบไม่พร้อมกันจากคําขอ ซึ่งจะเกิดขึ้นหลังจากการเรียกใช้การสร้างครั้งแรก (เช่น 15 นาที)
FAILED สร้าง AudienceList ไม่สำเร็จ การส่งคําขอรายการกลุ่มเป้าหมายนี้อีกครั้งอาจประสบความสําเร็จ

เมธอด

create

 สร้างรายการกลุ่มเป้าหมายเพื่อดึงข้อมูลภายหลัง

exportSheet

 ส่งออกรายการกลุ่มเป้าหมายของผู้ใช้ไปยัง Google ชีต

get

 รับข้อมูลเมตาการกําหนดค่าเกี่ยวกับรายการกลุ่มเป้าหมายที่เฉพาะเจาะจง

list

 แสดงรายการกลุ่มเป้าหมายทั้งหมดของพร็อพเพอร์ตี้

query

 เรียกข้อมูลรายการกลุ่มเป้าหมายของผู้ใช้