Method: properties.audienceLists.list

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

למבוא לרשימות קהלים עם דוגמאות, ראו יצירת רשימת קהלים.

השיטה הזו זמינה בגרסת בטא ב-audienceExports.list. כדי לתת משוב על ה-API הזה, יש למלא את טופס המשוב על Google Analytics Audience Export API.

בקשת HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{parent=properties/*}/audienceLists

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. כל רשימות הקהלים לנכס הזה יופיעו בתשובה. פורמט: properties/{property}

פרמטרים של שאילתה

פרמטרים
pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של רשימות קהלים שצריך להחזיר. ייתכן שהשירות יחזיר פחות מהערך הזה. אם לא צויין ערך, יוחזרו 200 רשימות קהלים לכל היותר. הערך המקסימלי הוא 1,000 (ערכים גבוהים יותר ייגזרו לערך המקסימלי).
pageToken

string

זה שינוי אופציונלי. אסימון דף, שהתקבל מקריאה קודמת ב-audienceLists.list. צריך לספק את הכתובת הזו כדי לאחזר את הדף הבא.

במהלך החלוקה לדפים, כל שאר הפרמטרים שסופקו ל-audienceLists.list חייבים להתאים לקריאה שסיפקה את אסימון הדף.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

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

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "audienceLists": [
    {
      object (AudienceList)
    }
  ],
  "nextPageToken": string
}
שדות
audienceLists[]

object (AudienceList)

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

string

אסימון, שניתן לשלוח בתור pageToken כדי לאחזר את הדף הבא. אם השדה הזה יושמט, אין דפים נוספים.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics