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 לנתונים ולאדמין.

פורמט: 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 והמצב CREATING התחיל ב-AudienceExport.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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.

מדינה

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

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

Methods

create

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

get

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

list

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

query

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