Method: advertisers.campaigns.list

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

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

درخواست HTTP

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

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

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

پارامترها
advertiser Id

string ( int64 format)

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

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

پارامترها
page Size

integer

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

page Token

string

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

order By

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"

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

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

درخواست بدن

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

بدن پاسخگو

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

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

object ( Campaign )

لیست کمپین ها

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

next Page Token

string

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

محدوده مجوز

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

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

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