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

חובה. השם של משאב הקהל. שם המשאב הזה מזהה את הקהל שמופיע ברשימה ומשותף בין ממשקי ה-API של Analytics Data ו-Admin.

פורמט: 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.

הפורמט הוא 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.

מדינה (State)

הקהל AudienceExport נמצא כרגע במצב הזה.

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

Methods

create

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

get

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

list

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

query

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