Method: advertisers.adAssets.list

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

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

درخواست HTTP

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

این URL از سینتکس Transcoding در 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

مثال‌ها:

  • تمام دارایی‌های فعال تبلیغات ویدیویی یوتیوب تحت یک تبلیغ‌کننده: 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 .