Method: mediaPlanners.list

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

برای متصدیان، این گزینه تمام برنامه‌ریزان رسانه‌ای که شرایط متصدی را پذیرفته‌اند، برمی‌گرداند.

برای سایر حساب‌ها، تلاش برای فهرست کردن برنامه‌ریزان رسانه با خطا مواجه خواهد شد.

درخواست HTTP

GET https://curationpartners.googleapis.com/v1/mediaPlanners

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

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

پارامترها
pageSize

integer

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

pageToken

string

اختیاری. توکنی که صفحه‌ای از نتایج را که سرور باید برگرداند، مشخص می‌کند. این مقدار از فراخوانی قبلی mediaPlanners.list در ListMediaPlannersResponse.nextPageToken دریافت شده است.

filter

string

رشته پرس و جوی اختیاری با استفاده از سینتکس فیلترینگ لیست Cloud API . ستون‌های پشتیبانی شده برای فیلترینگ عبارتند از:

  • name
  • displayName
  • ancestorNames

درخواست بدنه

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

بدنه پاسخ

پاسخی حاوی اطلاعات حساب برنامه‌ریز رسانه.

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

نمایش JSON 
{
  "mediaPlanners": [
    {
      object (MediaPlanner)
    }
  ],
  "nextPageToken": string
}
فیلدها
mediaPlanners[]

object ( MediaPlanner )

فهرست برنامه‌ریزان رسانه

nextPageToken

string

یک توکن که می‌تواند به فراخوانی بعدی متد mediaPlanners.list برای بازیابی صفحه بعدی نتایج در ListMediaPlannersRequest.page_token ارسال شود.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/curation-partners

مدیاپلنر

نشان دهنده یک حساب برنامه ریز رسانه است.

نمایش JSON 
{
  "accountId": string,
  "name": string,
  "displayName": string,
  "ancestorNames": [
    string
  ]
}
فیلدها
accountId
(deprecated)

string

فقط خروجی. شناسه حساب برنامه‌ریز رسانه.

name

string

شناسه. نام منبع منحصر به فرد برنامه‌ریز رسانه. قالب: mediaPlanners/{mediaPlannerAccountId} . می‌تواند برای فیلتر کردن پاسخ متد mediaPlanners.list استفاده شود.

displayName

string

فقط خروجی. نام نمایشی برنامه‌ریز رسانه. می‌تواند برای فیلتر کردن پاسخ متد [mediaPlanners.list][google.ads.authorizedbuyers.marketplace.v1main.MediaPlanners.ListMediaPlanners] استفاده شود.

ancestorNames[]

string

فقط خروجی. نام‌های اجداد برنامه‌ریز رسانه. قالب: mediaPlanners/{mediaPlannerAccountId} . می‌تواند برای فیلتر کردن پاسخ متد mediaPlanners.list استفاده شود.