REST Resource: properties.audienceLists

משאב: AudienceList

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

ייצוג ב-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

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

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

string

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

object (AudienceDimension)

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

integer

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

enum (State)

פלט בלבד. המצב הנוכחי של AudienceList הזה.
beginCreatingTime

string (Timestamp format)

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

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

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

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

מדינה

רשימת הקהלים נמצאת כרגע במצב הזה.

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

Methods

create

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

exportSheet

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

get

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

list

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

query

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