Method: advertisers.creatives.list

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

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
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"
  • همه خلاقیت‌های فعال با ابعاد 300x400 یا 50x100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • همه خلاقیت‌های پویا که توسط AdX یا AppNexus تأیید شده‌اند، با حداقل مدت زمان 5 ثانیه و 200 میلی‌ثانیه: dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • همه خلاقیت‌های ویدیویی که با شناسه مورد خط 1 یا 2 مرتبط هستند: 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"

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

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

درخواست بدن

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

بدن پاسخگو

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

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

object ( Creative )

لیست خلاقیت ها

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

nextPageToken

string

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

محدوده مجوز

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

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

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