Method: properties.audienceLists.query

אחזור של רשימת החברים בקהל. אחרי שיוצרים קהל, המשתמשים לא זמינים מיד לרישום. קודם כול, צריך לשלוח בקשה אל audienceLists.create כדי ליצור רשימת חברים בקהל, ואז להשתמש בשיטה הזו כדי לאחזר את המשתמשים מרשימת החברים בקהל.

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

קהלים ב-Google Analytics 4 מאפשרים לפלח את המשתמשים בדרכים שהן בעלות משמעות מבחינת העסק. מידע נוסף זמין בכתובת https://support.google.com/analytics/answer/9267572.

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

בקשת HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query

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

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

פרמטרים
name

string

חובה. השם של רשימת החברים בקהל שרוצים לאחזר ממנה משתמשים. פורמט: properties/{property}/audienceLists/{audienceList}

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "offset": string,
  "limit": string
}
שדות
offset

string (int64 format)

זה שינוי אופציונלי. מספר השורות בשורת ההתחלה. השורה הראשונה נספרת כשורה 0.

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

מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד.
limit

string (int64 format)

זה שינוי אופציונלי. מספר השורות שיש להחזיר. אם לא מציינים שום אפשרות, יוחזרו 10,000 שורות. ה-API מחזיר עד 250,000 שורות לכל בקשה, לא משנה כמה מבקשים. הערך limit חייב להיות חיובי.

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

מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד.

גוף התשובה

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

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

ייצוג JSON 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
שדות
audienceRows[]

object (AudienceRow)

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

object (AudienceList)

נתוני ההגדרה של רשימת הקהלים שנשלחה לגביה שאילתה. הוחזרה כדי לעזור בפירוש שורות הקהל בתשובה הזו. לדוגמה, המאפיינים ב-AudienceList האלה תואמים לעמודות ב-AudienceRows.
rowCount

integer

מספר השורות הכולל בתוצאה של AudienceList. הערך rowCount לא תלוי במספר השורות שהוחזרו בתשובה, בפרמטר limit ובפרמטר offset של הבקשה. לדוגמה, אם שאילתה מחזירה 175 שורות וכוללת limit של 50 בבקשת ה-API, התגובה תכיל rowCount מתוך 175 שורות אבל רק 50 שורות.

מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד.

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

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

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

AudienceRow

מאפייני ערך המאפיין של שורת המשתמש בקהל.

ייצוג JSON 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
שדות
dimensionValues[]

object (AudienceDimensionValue)

כל מאפיין של ערך מאפיין למשתמש בקהל. לכל עמודת מאפיין המבוקשת יתווסף ערך של מאפיין אחד.

AudienceDimensionValue

הערך של מאפיין.

ייצוג JSON 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
שדות
שדה איחוד one_value. סוג אחד של ערך מאפיין. one_value יכול להיות רק אחת מהאפשרויות הבאות:
value

string

הערך כמחרוזת אם סוג המאפיין הוא מחרוזת.