REST Resource: properties.audienceLists

แหล่งข้อมูล: AudienceList

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

การแสดง 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 และ 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 ไปยังเซิร์ฟเวอร์เว็บฮุค คุณจะใช้เว็บฮุคหรือไม่ก็ได้ หากไม่มีการใช้งาน คุณจะต้องสำรวจ API นี้เพื่อดูว่ารายการกลุ่มเป้าหมายพร้อมใช้งานเมื่อใด เว็บฮุคช่วยให้ระบบส่งการแจ้งเตือนไปยังเซิร์ฟเวอร์ของคุณได้และไม่จำเป็นต้องใช้แบบสำรวจ

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

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

รัฐ

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

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

วิธีการ

create

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

exportSheet

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

get

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

list

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

query

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