Method: advertisers.list

تبلیغ‌کنندگانی را فهرست می‌کند که برای کاربر فعلی قابل دسترسی هستند.

ترتیب با پارامتر orderBy تعریف می شود.

یک partnerId واحد مورد نیاز است. فهرست بین شرکا پشتیبانی نمی شود.

درخواست HTTP

GET https://displayvideo.googleapis.com/v3/advertisers

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
partnerId

string ( int64 format)

مورد نیاز. شناسه شریکی که تبلیغ‌کنندگان واکشی شده همه باید متعلق به آن باشند. این سیستم تنها از فهرست کردن تبلیغ‌کنندگان برای یک شریک در یک زمان پشتیبانی می‌کند.

pageSize

integer

اندازه صفحه درخواستی باید بین 1 تا 200 باشد. اگر نامشخص باشد به طور پیش فرض 100 خواهد بود.

pageToken

string

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

orderBy

string

فیلدی که بر اساس آن لیست مرتب می شود. مقادیر قابل قبول عبارتند از:

  • displayName (پیش‌فرض)
  • entityStatus
  • updateTime

ترتیب مرتب سازی پیش فرض صعودی است. برای تعیین ترتیب نزولی برای یک فیلد، پسوند "desc" باید به نام فیلد اضافه شود. برای مثال displayName desc .

filter

string

امکان فیلتر کردن بر اساس فیلدهای تبلیغ کننده را می دهد.

نحو پشتیبانی شده:

  • عبارات فیلتر از یک یا چند محدودیت تشکیل شده اند.
  • محدودیت ها را می توان با عملگرهای منطقی AND یا OR ترکیب کرد.
  • یک محدودیت به شکل {field} {operator} {value} است.
  • فیلد updateTime باید از عملگرهای GREATER THAN OR EQUAL TO (>=) یا LESS THAN OR EQUAL TO (<=) استفاده کند.
  • تمام فیلدهای دیگر باید از عملگر EQUALS (=) استفاده کنند.

زمینه های پشتیبانی شده:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (ورودی در قالب ISO 8601 یا YYYY-MM-DDTHH:MM:SSZ )

مثال ها:

  • همه تبلیغ‌کنندگان فعال تحت یک شریک: entityStatus="ENTITY_STATUS_ACTIVE"
  • همه تبلیغ‌کنندگان با زمان به‌روزرسانی کمتر یا مساوی 2020-11-04T18:54:47Z (قالب ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • همه تبلیغ‌کنندگان با زمان به‌روزرسانی بیشتر یا مساوی 2020-11-04T18:54:47Z (قالب ISO 8601): updateTime>="2020-11-04T18:54:47Z"

طول این فیلد نباید بیشتر از 500 کاراکتر باشد.

برای اطلاعات بیشتر به راهنمای درخواست های LIST فیلتر ما مراجعه کنید.

درخواست بدن

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

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
فیلدها
advertisers[]

object ( Advertiser )

لیست آگهی دهندگان.

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

nextPageToken

string

نشانه ای برای بازیابی صفحه بعدی نتایج. این مقدار را در قسمت pageToken در روش تماس بعدی با advertisers.list ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید.

محدوده مجوز

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

  • https://www.googleapis.com/auth/display-video

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.