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 API และ 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

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
rowCount

integer

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

string

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

number

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

string

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

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

object (WebhookNotification)

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

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

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

รัฐ

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

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

เมธอด

create

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

get

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

list

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

query

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