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

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

string

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

object (AudienceDimension)

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

integer

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

enum (State)

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

string (Timestamp format)

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

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

ארץ

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

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

שיטות

create

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

exportSheet

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

get

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

list

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

query

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