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 & ממשקי API לניהול.

פורמט: properties/{property}/audiences/{audience}
audienceDisplayName

string

פלט בלבד. השם המוצג התיאורי של הקהל הזה. לדוגמה, 'רוכשים'.
dimensions[]

object (AudienceDimension)

חובה. המאפיינים המבוקשים ומוצגים בתגובת השאילתה.
creationQuotaTokensCharged

integer

פלט בלבד. סך כל אסימוני המכסה שחויבו במהלך יצירת AudienceExport. ספירת האסימונים הזו מבוססת על פעילות מהמצב CREATING, ולכן החיוב על האסימונים האלה יתוקן ברגע שייצוא הקהלים יעבור למצב ACTIVE או FAILED.
state

enum (State)

פלט בלבד. המצב הנוכחי של AudienceExport (ייצוא הקהל הזה).
beginCreatingTime

string (Timestamp format)

פלט בלבד. השעה שבה בוצעה קריאה אל audienceExports.create, ו-AudienceExport התחיל את המצב CREATING.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
rowCount

integer

פלט בלבד. מספר השורות הכולל בתוצאה של AudienceExport.
errorMessage

string

פלט בלבד. הודעת השגיאה מאוכלסת כשייצוא הקהלים נכשל במהלך היצירה. אחת הסיבות הנפוצות לכשל כזה היא מיצוי של המכסה.
percentageCompleted

number

פלט בלבד. האחוז שהושלם עבור ייצוא הקהל הזה, בטווח בין 0 ל-100.

AudienceDimension

מאפיין קהל הוא מאפיין משתמש. מוצגת בקשה לשיוך משתמש ספציפי, ולאחר מכן היא מוחזרת בקטע QueryAudienceExportResponse.

ייצוג JSON 
{
  "dimensionName": string
}
שדות
dimensionName

string

זה שינוי אופציונלי. שם ה-API של המאפיין. הרשימה של שמות המאפיינים מופיעה במאמר מאפייני API.

מדינה

ייצוא הקהלים קיים כרגע במצב הזה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED המערכת אף פעם לא תשתמש במצב שלא צוין.
CREATING המערכת יוצרת עכשיו את Audience Export, ותהיה זמינה בעתיד. היצירה מתבצעת מיד לאחר הקריאה של audienceExports.create.
ACTIVE ייצוא הקהלים נוצר במלואו ומוכן לשאילתות. ייצוא קהלים מתעדכן ומופעל באופן אסינכרוני מבקשה. הדבר מתרחש זמן מה (למשל, 15 דקות) לאחר יצירת הקריאה הראשונית.
FAILED היצירה של AudienceExport נכשלה. ייתכן שבקשה חוזרת של ייצוא הקהלים הזה תצליח.

שיטות

create

 ייווצר ייצוא קהל לאחזור מאוחר יותר.

get

 קבלת מטא-נתונים של הגדרות לגבי ייצוא קהלים ספציפי.

list

 רשימה של כל אירועי הייצוא של קהלים בנכס מסוים.

query

 אחזור של ייצוא קהלים של משתמשים.