REST Resource: properties.audienceExports

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

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

การแสดง 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 Data API และ Admin API

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

string

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

object (AudienceDimension)

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

integer

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

enum (State)

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

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่เรียกใช้ audienceExports.create และ AudienceExport เริ่มสถานะ 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

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

string

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

number

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

AudienceDimension

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

การแสดง JSON 
{
  "dimensionName": string
}
ฟิลด์
dimensionName

string

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

รัฐ

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

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

เมธอด

create

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

get

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

list

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

query

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