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 ו-Admin APIs.

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

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

ארץ

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

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

שיטות

create

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

get

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

list

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

query

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