Method: advertisers.list

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

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

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

درخواست HTTP

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

نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

پارامترهای پُرسمان

پارامترها
partnerId

string (int64 format)

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

integer

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

string

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

string

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

  • advertiserId (پیش‌فرض)
  • 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"

طول این فیلد نباید بیشتر از ۵۰۰ نویسه باشد.

برای اطلاعات بیشتر، به راهنمای درخواست‌های 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 Overview مراجعه کنید.