Method: advertisers.creatives.list

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

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

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
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 בקריאה הבאה ל-method‏ ListCreativesRequest כדי לאחזר את דף התוצאות הבא. אם הערך בשדה הזה הוא null, זה אומר שזה הדף האחרון.

היקפי הרשאות

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

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.