Method: properties.audienceLists.exportSheet

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

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

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

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

בקשת HTTP

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

בכתובת ה-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.

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

גוף התשובה

הגיליון האלקטרוני שנוצר ב-Google Sheets עם רשימת המשתמשים ברשימת החברים בקהל.

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

ייצוג JSON 
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
שדות
spreadsheetUri

string

URI שניתן לבקר בו בדפדפן כדי להציג את הגיליון האלקטרוני ב-Google Sheets.
spreadsheetId

string

מזהה שמזהה את המשאב שנוצר ב-Google Sheets.
rowCount

integer

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

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

object (AudienceList)

נתוני ההגדרה של רשימת הקהלים בייצוא. הוחזרה כדי לעזור בפירוש רשימת הקהלים בגיליון Google Sheets של התשובה הזו.

לדוגמה, יכול להיות שברשימת הקהלים יהיו יותר שורות ממה שיש בגיליון האלקטרוני ב-Google Sheets. במקרה כזה, כדאי לשלוח בקשה נוספת לייצוא גיליון עם ערך offset שונה כדי לאחזר את דף השורות הבא בגיליון אלקטרוני נוסף ב-Google Sheets.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets