Method: advertisers.creatives.list

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

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v3/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 Overview.