Method: advertisers.creatives.list

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

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v3/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 (קודם מיון לפי רוחב ואחר כך לפי גובה)

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