REST Resource: properties.audienceExports

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

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

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

string

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

รูปแบบ: properties/{property}/audienceExports/{audienceExport}

audience

string

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

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

audienceDisplayName

string

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

dimensions[]

object (AudienceDimension)

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

creationQuotaTokensCharged

integer

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

state

enum (State)

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

beginCreatingTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่เรียก AudienceExports.create และ Audience Export เริ่มต้นสถานะ CREATING

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

rowCount

integer

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

errorMessage

string

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

percentageCompleted

number

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

AudienceDimension

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

การแสดง JSON
{
  "dimensionName": string
}
ช่อง
dimensionName

string

ไม่บังคับ ชื่อ API ของมิติข้อมูล โปรดดูรายการชื่อมิติข้อมูลที่มิติข้อมูล API

รัฐ

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

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

วิธีการ

create

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

get

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

list

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

query

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