Method: advertisers.creatives.list

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

ترتیب با پارامتر orderBy تعریف می‌شود. اگر filter براساس entityStatus مشخص نشده باشد، طرح‌های آگهی با ENTITY_STATUS_ARCHIVED در نتایج گنجانده نخواهند شد.

درخواست HTTP

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

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

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

پارامترها
advertiserId

string (int64 format)

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

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

پارامترها
pageSize

integer

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

string

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

string

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

  • creativeId (پیش‌فرض)
  • createTime
  • mediaDuration
  • dimensions (ابتدا براساس عرض، سپس براساس ارتفاع مرتب می‌کند)

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

string

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

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

  • عبارت‌های فیلتر از یک یا چند محدودیت تشکیل شده‌اند.
  • محدودیت‌ها را می‌توان با عملگرهای منطقی AND یا OR ترکیب کرد. دنباله‌ای از محدودیت‌ها به‌طور ضمنی از AND استفاده می‌کند.
  • محدودیت به‌صورت {field} {operator} {value} است.
  • فیلد lineItemIds باید از عملگر HAS (:) استفاده کند.
  • فیلد updateTime باید از عملگرهای GREATER THAN OR EQUAL TO (>=) یا LESS THAN OR EQUAL TO (<=) استفاده کند.
  • همه فیلدهای دیگر باید از اپراتور EQUALS (=) استفاده کنند.
  • برای فیلدهای entityStatus،‏ minDuration،‏ maxDuration،‏ updateTime، و dynamic، حداکثر یک محدودیت می‌تواند وجود داشته باشد.

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

  • approvalStatus
  • creativeId
  • creativeType
  • dimensions (ورودی به‌شکل {width}x{height})
  • dynamic
  • entityStatus
  • exchangeReviewStatus (ورودی به‌شکل {exchange}-{reviewStatus})
  • lineItemIds
  • maxDuration (ورودی به‌شکل {duration}s. فقط ثانیه پشتیبانی می‌شود)
  • minDuration (ورودی به‌شکل {duration}s. فقط ثانیه پشتیبانی می‌شود)
  • updateTime (ورودی در قالب ISO 8601، یا YYYY-MM-DDTHH:MM:SSZ)

یادداشت‌ها:

  • برای updateTime، مقدار فیلد منبع طرح آگهی نشان‌دهنده آخرین باری است که طرح آگهی به‌روز شده است، که شامل به‌روزرسانی‌های انجام‌شده توسط سیستم (مثلاً به‌روزرسانی‌های بازبینی طرح آگهی) می‌شود.

مثال‌ها:

  • همه طرح‌آگهی‌های بومی: creativeType="CREATIVE_TYPE_NATIVE"
  • همه طرح‌آگهی‌های فعال با ابعاد ‎۳۰۰×۴۰۰ یا ‎۵۰×۱۰۰: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • همه طرح‌آگهی‌های پویایی که توسط AdX یا AppNexus تأیید شده‌اند، با حداقل مدت ۵ ثانیه و ۲۰۰ میلی‌ثانیه: dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • همه طرح‌آگهی‌های ویدیویی که با شناسه مورد سطری ۱ یا ۲ مرتبط هستند: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • یافتن طرح‌آگهی‌ها با چند شناسه طرح‌آگهی: creativeId=1 OR creativeId=2
  • همه طرح‌آگهی‌هایی که زمان به‌روزرسانی آن‌ها بزرگ‌تر یا مساوی با ‎2020-11-04T18:54:47Z (قالب ISO 8601) است: updateTime>="2020-11-04T18:54:47Z"

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

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

متن درخواست

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

بدنه پاسخ

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

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

object (Creative)

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

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

string

نشانه‌ای برای بازیابی صفحه بعدی نتایج. این مقدار را در فیلد pageToken در تماس بعدی با روش ListCreativesRequest ارسال کنید تا صفحه بعدی نتایج بازیابی شود. اگر این فیلد تهی باشد، یعنی این صفحه آخر است.

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

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

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

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