Method: properties.audienceLists.query

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

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

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

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

בקשת 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 שנשלחת לגביו שאילתה. הוחזרו כדי לעזור בפירוש שורות הקהלים בתשובה הזו. לדוגמה, המאפיינים ברשימת הקהלים הזו תואמים לעמודות שבשורות הקהלים.
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

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