- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- AudienceRow
- AudienceDimensionValue
- רוצים לנסות?
אחזור של ייצוא קהלים של משתמשים. אחרי שיוצרים קהל, המשתמשים לא זמינים לייצוא מיידי. קודם כל, צריך לשלוח בקשה אל audienceExports.create
כדי ליצור ייצוא קהלים של משתמשים. בשלב השני, המערכת משתמשת בשיטה הזו כדי לאחזר את המשתמשים מייצוא הקהלים.
מבוא לייצוא קהלים עם דוגמאות זמין במאמר יצירת ייצוא קהלים.
קהלים ב-Google Analytics 4 מאפשרים לפלח את המשתמשים בדרכים בעלות משמעות לעסק. מידע נוסף זמין בכתובת https://support.google.com/analytics/answer/9267572.
ממשקי API לייצוא קהלים משתמשים בשיטות אלפא ובשיטות אחרות ביציבות של גרסת בטא. הכוונה היא לקדם את השיטות ליציבות גרסת הבטא לאחר קבלת משוב ואימוץ מסוים. כדי לשלוח משוב על ה-API הזה, אתם יכולים למלא את הטופס Google Analytics Audience Export API Feedback.
בקשת HTTP
POST https://analyticsdata.googleapis.com/v1beta/{name=properties/*/audienceExports/*}:query
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
name |
חובה. השם של ייצוא הקהלים שממנו רוצים לאחזר משתמשים. פורמט: |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "offset": string, "limit": string } |
שדות | |
---|---|
offset |
זה שינוי אופציונלי. מספר השורות בשורת ההתחלה. השורה הראשונה נספרת כשורה 0. במהלך החלוקה לדפים, הבקשה הראשונה לא מציינת היסט. או לחלופין, מגדירה היסט ל-0. הבקשה הראשונה מחזירה את מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד. |
limit |
זה שינוי אופציונלי. מספר השורות שיש להחזיר. אם לא צוין אחרת, יוחזרו 10,000 שורות. ה-API מחזיר עד 250,000 שורות לבקשה, ללא קשר לכמות שתבקש. הערך כמו כן, ה-API יכול להחזיר פחות שורות מהשדה מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד. |
גוף התשובה
רשימה של משתמשים בייצוא קהלים.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "audienceRows": [ { object ( |
שדות | |
---|---|
audienceRows[] |
שורות של כל משתמש בייצוא קהלים. מספר השורות בתגובה הזו יהיה שווה לגודל דף הבקשה או קטן ממנו. |
audienceExport |
נתוני ההגדרה של השאילתה לגבי AudienceExport. הוחזרו כדי לעזור בפירוש שורות הקהלים בתשובה הזו. לדוגמה, המאפיינים ב-AudienceExport הזה תואמים לעמודות ב-AudienceRows. |
rowCount |
המספר הכולל של השורות בתוצאה של AudienceExport. הערך מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של 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 |
ערך כמחרוזת אם סוג המאפיין הוא מחרוזת. |