Method: organizations.list

لیستی از سازمان‌هایی که کاربر به آنها دسترسی دارد را برمی‌گرداند.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای پرس و جو

پارامترها
pageSize

integer

اختیاری. حداکثر تعداد سازمان‌هایی که در یک فراخوانی برمی‌گردند. سرویس ممکن است کمتر از این مقدار را برگرداند.

اگر مشخص نشود، حداکثر ۵۰ سازمان بازگردانده می‌شود. حداکثر مقدار ۱۰۰۰ است؛ مقادیر بالای ۱۰۰۰ به ۱۰۰۰ کاهش می‌یابند.

pageToken

string

اختیاری. یک توکن صفحه، که از فراخوانی قبلی organizations.list دریافت شده است. این را برای بازیابی صفحه بعدی ارائه دهید.

هنگام صفحه‌بندی، تمام پارامترهای دیگر ارائه شده به organizations.list باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشند.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پیام پاسخ برای سازمان‌ها.لیست RPC.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش 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