Method: advertisers.creatives.list

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

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v1/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 בקריאה הבאה לשיטה ListCreativesRequest כדי לאחזר את דף התוצאות הבא. אם השדה הזה הוא null, זה אומר שזה הדף האחרון.

היקפי הרשאות

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

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

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