Method: advertisers.adGroups.list

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

درخواست HTTP

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

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

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

پارامترها
advertiser Id

string ( int64 format)

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

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

پارامترها
page Size

integer

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

page Token

string

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

order By

string

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

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

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

filter

string

اختیاری. فیلتر کردن بر اساس فیلدهای گروه تبلیغات سفارشی را امکان پذیر می کند.

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

  • عبارات فیلتر از یک یا چند محدودیت تشکیل شده اند.
  • محدودیت ها را می توان با AND و OR ترکیب کرد. دنباله ای از محدودیت ها به طور ضمنی از AND استفاده می کند.
  • یک محدودیت به شکل {field} {operator} {value} است.
  • همه فیلدها باید از عملگر EQUALS (=) استفاده کنند.

ویژگی های پشتیبانی شده:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

مثال ها:

  • همه گروه‌های تبلیغاتی زیر یک آیتم خط: lineItemId="1234"
  • همه گروه‌های تبلیغاتی ENTITY_STATUS_ACTIVE یا ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM تحت یک تبلیغ‌کننده: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

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

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

درخواست بدن

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

بدن پاسخگو

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

نمایندگی JSON 
{
  "adGroups": [
    {
      object (AdGroup)
    }
  ],
  "nextPageToken": string
}
فیلدها
ad Groups[]

object ( AdGroup )

لیست گروه های تبلیغاتی

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

next Page Token

string

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

محدوده مجوز

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

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

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