Method: advertisers.adAssets.list

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

فقط از بازیابی دارایی‌های AdAssetType AD_ASSET_TYPE_YOUTUBE_VIDEO پشتیبانی می‌کند.

درخواست HTTP

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

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

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

پارامترها
advertiserId

string (int64 format)

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

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

پارامترها
pageSize

integer

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

string

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

string

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

  • entityStatus
  • youtubeVideoAsset.youtubeVideoId
  • adAssetId (پیش‌فرض)

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

string

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

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

  • محدودیت به‌صورت {field} {operator} {value} است.
  • همه فیلدها باید از اپراتور EQUALS (=) استفاده کنند.

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

  • youtubeVideoAsset.youtubeVideoId
  • entityStatus

مثال‌ها:

  • همه دارایی‌های آگهی ویدیویی YouTube فعال تحت یک آگهی‌دهنده: entityStatus=ENTITY_STATUS_ACTIVE

متن درخواست

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

بدنه پاسخ

پیام پاسخ برای adAssets.list.

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

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

object (AdAsset)

فهرست دارایی‌های آگهی. این فهرست فقط شامل دارایی‌های AdAssetType AD_ASSET_TYPE_YOUTUBE_VIDEO خواهد بود.

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

string

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

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

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

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

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