- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- AudienceRow
- AudienceDimensionValue
- רוצים לנסות?
אחזור של רשימת החברים בקהל. אחרי שיוצרים קהל, המשתמשים לא זמינים מיד לרישום. קודם כול, צריך לשלוח בקשה אל 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 |
חובה. השם של רשימת החברים בקהל שרוצים לאחזר ממנה משתמשים. פורמט: |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "offset": string, "limit": string } |
שדות | |
---|---|
offset |
זה שינוי אופציונלי. מספר השורות בשורת ההתחלה. השורה הראשונה נספרת כשורה 0. במהלך החלוקה לדפים, הבקשה הראשונה לא מציינת קיזוז. או באופן שווה, מגדיר את ההיסט ל-0; הבקשה הראשונה מחזירה את מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד. |
limit |
זה שינוי אופציונלי. מספר השורות שיש להחזיר. אם לא מציינים שום אפשרות, יוחזרו 10,000 שורות. ה-API מחזיר עד 250,000 שורות לכל בקשה, לא משנה כמה מבקשים. הערך ה-API יכול גם להחזיר פחות שורות מהערך המבוקש של מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד. |
גוף התשובה
רשימה של משתמשים ברשימת חברים בקהל.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "audienceRows": [ { object ( |
שדות | |
---|---|
audienceRows[] |
שורות לכל משתמש ברשימת חברים בקהל. מספר השורות בתשובה הזו יהיה שווה לגודל הדף של הבקשה או קטן ממנו. |
audienceList |
נתוני ההגדרה של רשימת הקהלים שנשלחה לגביה שאילתה. הוחזרה כדי לעזור בפירוש שורות הקהל בתשובה הזו. לדוגמה, המאפיינים ב-AudienceList האלה תואמים לעמודות ב-AudienceRows. |
rowCount |
מספר השורות הכולל בתוצאה של AudienceList. הערך מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד. |
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
AudienceRow
מאפייני ערך המאפיין של שורת המשתמש בקהל.
ייצוג JSON |
---|
{
"dimensionValues": [
{
object ( |
שדות | |
---|---|
dimensionValues[] |
כל מאפיין של ערך מאפיין למשתמש בקהל. לכל עמודת מאפיין המבוקשת יתווסף ערך של מאפיין אחד. |
AudienceDimensionValue
הערך של מאפיין.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד one_value . סוג אחד של ערך מאפיין. one_value יכול להיות רק אחת מהאפשרויות הבאות: |
|
value |
הערך כמחרוזת אם סוג המאפיין הוא מחרוזת. |