Method: advertisers.adGroupAds.list

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

درخواست HTTP

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

نشانی وب از نحو تراتبدیل 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
  • parentCreativeId

مثال‌ها:

  • همه آگهی‌های گروه آگهی تحت گروه آگهی: adGroupId="1234"
  • همه آگهی‌های گروه آگهی تحت گروه آگهی با entityStatus از ENTITY_STATUS_ACTIVE یا ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"
  • همه آگهی‌های گروه آگهی تحت طرح‌آگهی اصلی: parentCreativeId="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 مراجعه کنید.