Method: advertisers.adGroupAds.list

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

درخواست HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroupAds

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
advertiserId

string ( int64 format)

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

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

پارامترها
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

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

سینتکس پشتیبانی شده:

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

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

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

مثال‌ها:

  • همه تبلیغات گروه‌های تبلیغاتی تحت یک گروه تبلیغاتی: adGroupId="1234"
  • همه تبلیغات گروه‌های تبلیغاتی تحت یک گروه تبلیغاتی با entityStatus ENTITY_STATUS_ACTIVE یا ENTITY_STATUS_PAUSED : (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

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

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

درخواست بدنه

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

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "adGroupAds": [
    {
      object (AdGroupAd)
    }
  ],
  "nextPageToken": string
}
فیلدها
adGroupAds[]

object ( AdGroupAd )

فهرست آگهی‌ها.

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

nextPageToken

string

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

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

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

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .