REST Resource: properties.audienceLists

משאב: רשימת קהלים

רשימת החברים בקהל היא רשימה של המשתמשים בקהל בזמן יצירת הרשימה. לקהל אחד יכולות להיות כמה רשימות קהלים שנוצרו בימים שונים.

ייצוג JSON 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
שדות
name

string

פלט בלבד. מזהה. שם המשאב של רשימת החברים בקהל שהוקצה במהלך היצירה. שם המשאב הזה מזהה את AudienceList.

פורמט: properties/{property}/audienceLists/{audienceList}
audience

string

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

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

string

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

object (AudienceDimension)

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

integer

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

enum (State)

פלט בלבד. המצב הנוכחי של רשימת הקהלים.
beginCreatingTime

string (Timestamp format)

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

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

integer

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

string

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

number

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

string

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

אם רשימות הקהלים נוצרות ישירות, לא תהיה להן רשימת חברים בקהל משויכת, והשדה הזה יהיה ריק.
webhookNotification

object (WebhookNotification)

זה שינוי אופציונלי. הגדרת שליחה של התראות webhook מ-Google Analytics Data API לשרת ה-webhook שלכם. השימוש ב-webhooks הוא אופציונלי. אם רשימת החברים בקהל לא בשימוש, צריך לערוך דגימה ל-API כדי לקבוע מתי רשימת החברים בקהל מוכנה לשימוש. תגובות לפעולה מאתר אחר (webhook) מאפשרות לשלוח התראה לשרתים שלכם להימנע מהצורך בסקרים.

בקשת POST אחת או שתיים יישלחו ל-webhook. בקשת ה-POST הראשונה תישלח באופן מיידי ותציג את רשימת החברים בקהל החדשה במצב 'יצירה'. בקשת ה-POST השנייה תישלח לאחר סיום היצירה של רשימת החברים בקהל (במצב 'פעיל' או 'נכשל').

אם נשלחת בקשה לרשימות קהלים זהות ברצף, הבקשה השנייה & אפשר להציג את רשימות הקהלים הבאות מהמטמון. במקרה כזה, שיטת היצירה של רשימת החברים בקהל יכולה להחזיר רשימת חברים בקהל כבר פעילה. בתרחיש הזה, רק בקשת POST אחת תישלח ל-webhook.

מדינה

AudienceList קיימת כרגע במצב הזה.

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

שיטות

create

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

exportSheet

 מייצאת רשימת חברים בקהל לגיליון אלקטרוני ב-Google Sheets.

get

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

list

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

query

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