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

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

string

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

object (AudienceDimension)

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

integer

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

enum (State)

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

string (Timestamp format)

פלט בלבד. השעה שבה בוצעה הקריאה אל audienceLists.create והקהל התחיל את המצב 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

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

string

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

number

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

string

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

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

object (WebhookNotification)

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

בקשת POST אחת או שתיים יישלחו ל-webhook. בקשת ה-POST הראשונה תישלח באופן מיידי ותציג את רשימת הקהלים שנוצרה לאחרונה במצב CREATING. בקשת ה-POST השנייה תישלח אחרי שרשימת הקהלים תסיים את תהליך היצירה (במצב ACTIVE או FAILED).

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

מדינה (State)

הרשימה של חברי הקהל קיימת כרגע במצב הזה.

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

Methods

create

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

get

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

list

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

query

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