REST Resource: properties.audienceLists

แหล่งข้อมูล: รายการกลุ่มเป้าหมาย

รายการกลุ่มเป้าหมายคือรายชื่อผู้ใช้ในกลุ่มเป้าหมายในขณะที่สร้างรายการ กลุ่มเป้าหมาย 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 และ Admin API

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

string

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

object (AudienceDimension)

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

integer

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

enum (State)

เอาต์พุตเท่านั้น สถานะปัจจุบันของรายการกลุ่มเป้าหมายนี้
beginCreatingTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่เกิดการเรียก AudienceLists.create และรายการกลุ่มเป้าหมายเริ่มสถานะ CREATING

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

integer

เอาต์พุตเท่านั้น จำนวนแถวทั้งหมดในผลลัพธ์รายการกลุ่มเป้าหมาย
errorMessage

string

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

number

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

string

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

หากสร้างรายการกลุ่มเป้าหมายโดยตรง รายการกลุ่มเป้าหมายดังกล่าวจะไม่มีรายการกลุ่มเป้าหมายที่เกิดซ้ำและฟิลด์นี้จะว่างเปล่า
webhookNotification

object (WebhookNotification)

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

ระบบจะส่งคำขอ POST 1-2 รายการไปยังเว็บฮุค คำขอ POST แรกจะถูกส่งโดยทันที ซึ่งแสดงรายการกลุ่มเป้าหมายที่สร้างขึ้นใหม่ในสถานะ "กำลังสร้าง" ระบบจะส่งคำขอ POST รายการที่ 2 หลังจากสร้างรายการกลุ่มเป้าหมายเสร็จแล้ว (สถานะ "ใช้งานอยู่" หรือ "ล้มเหลว")

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

รัฐ

ปัจจุบันรายการกลุ่มเป้าหมายมีอยู่ในสถานะนี้

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

เมธอด

create

 สร้างรายการกลุ่มเป้าหมายสำหรับการดึงข้อมูลในภายหลัง

exportSheet

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

get

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

list

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

query

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