Method: properties.audienceLists.query

אחזור רשימת חברים בקהל של משתמשים. אחרי שיוצרים קהל, המשתמשים לא זמינים מיידית להוספה לרשימת תפוצה. ראשית, צריך לבצע בקשה ל-audienceLists.create כדי ליצור רשימת חברים בקהל של משתמשים, ושנית, ה-method הזה משמש לאחזור המשתמשים ברשימת החברים בקהל.

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

קהלים ב-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 משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
name

string

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

גוף הבקשה

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

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

string (int64 format)

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

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

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