Method: advertisers.campaigns.list

پویش‌ها را در آگهی‌دهنده فهرست می‌کند.

ترتیب با پارامتر orderBy تعریف می‌شود. اگر filter براساس entityStatus مشخص نشده باشد، پویش‌های دارای ENTITY_STATUS_ARCHIVED در نتایج گنجانده نخواهند شد.

درخواست HTTP

GET https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/campaigns

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

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

پارامترها
advertiserId

string (int64 format)

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

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

پارامترها
pageSize

integer

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

string

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

string

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

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

ترتیب مرتب‌سازی پیش‌فرض صعودی است. برای مشخص کردن ترتیب نزولی برای یک فیلد، باید پسوند «desc» به نام فیلد اضافه شود. مثال: displayName desc.
filter

string

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

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

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

فیلدهای پشتیبانی‌شده:

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

مثال‌ها:

  • همه پویش‌های ENTITY_STATUS_ACTIVE یا ENTITY_STATUS_PAUSED تحت یک آگهی‌دهنده: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • همه پویش‌هایی که زمان به‌روزرسانی آن‌ها کمتر یا مساوی با ‎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 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
فیلدها
campaigns[]

object (Campaign)

فهرست پویش‌ها.

اگر این فهرست خالی باشد، نمایش داده نخواهد شد.
nextPageToken

string

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

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

به یکی از دامنه‌های OAuth زیر نیاز دارد:

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

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