Method: organizations.list

הפונקציה מחזירה רשימה של ארגונים שלמשתמש יש גישה אליהם.

בקשת HTTP

GET https://marketingplatformadmin.googleapis.com/v1alpha/organizations

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

אופציונלי. המספר המקסימלי של ארגונים שיוחזרו בקריאה אחת. יכול להיות שהשירות יחזיר פחות מהערך הזה.

אם לא מציינים ערך, יוחזרו לכל היותר 50 ארגונים. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000.
pageToken

string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של organizations.list. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-organizations.list חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

הודעת התגובה לקריאה לשירות מרוחק (RPC) של organizations.list.

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

ייצוג ב-JSON 
{
  "organizations": [
    {
      object (Organization)
    }
  ],
  "nextPageToken": string
}
שדות
organizations[]

object (Organization)

משאב הארגון שלמשתמש יש גישה אליו, כולל מזהה הארגון והשם לתצוגה.
nextPageToken

string

טוקן שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

היקפי הרשאה

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

  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.update