Method: advertisers.creatives.list

רשימה של קריאייטיבים במפרסם.

הסדר מוגדר על ידי הפרמטר orderBy. אם לא מציינים filter עד entityStatus, קריאייטיבים עם ENTITY_STATUS_ARCHIVED לא ייכללו בתוצאות.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
advertiserId

string (int64 format)

חובה. המזהה של המפרסם שעבורו רוצים להציג את נכסי הקריאייטיב.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

גודל הדף המבוקש. חייב להיות בין 1 ל-200. אם לא צוין ערך, ברירת המחדל תהיה 100. הפונקציה מחזירה את קוד השגיאה INVALID_ARGUMENT אם צוין ערך לא חוקי.
pageToken

string

אסימון שמזהה דף של תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת ל-method creatives.list. אם לא מציינים שום אפשרות, יוחזר דף התוצאות הראשון.
orderBy

string

שדה שלפיו ממיינים את הרשימה. הערכים הקבילים הם:

  • creativeId (ברירת מחדל)
  • createTime
  • mediaDuration
  • dimensions (מיון לפי רוחב קודם ואז לפי גובה)

סדר המיון שמוגדר כברירת מחדל הוא בסדר עולה. כדי לציין סדר יורד של שדה, צריך להוסיף סיומת 'description' לשם השדה. דוגמה: 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 בקריאה הבאה ל-method של ListCreativesRequest כדי לאחזר את דף התוצאות הבא. אם השדה הזה ריק, המשמעות היא שזה הדף האחרון.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.