Method: advertisers.creatives.list

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

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

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

ברירת המחדל של סדר המיון היא בסדר עולה. כדי לציין סדר יורד בשדה, הסיומת 'תיאור' יש להוסיף לשם השדה. דוגמה: createTime desc
filter

string

מאפשר סינון לפי מאפייני קריאייטיב.

תחביר נתמך:

  • ביטויי הסינון מורכבים מהגבלה אחת או יותר.
  • צריך לשלב את ההגבלה על אותו השדה באמצעות OR.
  • צריך לשלב את ההגבלה בשדות השונים באמצעות AND.
  • בין ( ל-) יכולות להיות רק הגבלות בשילוב של OR עבור אותו שדה.
  • הגבלה היא בפורמט {field} {operator} {value}.
  • האופרטור חייב להיות EQUALS (=) בשדות הבאים:
    • entityStatus
    • creativeType.
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • האופרטור חייב להיות HAS (:) בשדות הבאים:
    • lineItemIds
  • האופרטור חייב להיות GREATER THAN OR EQUAL TO (>=) או LESS THAN OR EQUAL TO (<=) בשדות הבאים:
    • updateTime (קלט בפורמט ISO 8601 או YYYY-MM-DDTHH:MM:SSZ)
  • ב-entityStatus, ב-minDuration, ב-maxDuration, ב-updateTime וב-dynamic, יכולה להיות הגבלה אחת לכל היותר.
  • בשביל dimensions, הערך הוא בצורה של "{width}x{height}".
  • בשביל exchangeReviewStatus, הערך הוא בצורה של {exchange}-{reviewStatus}.
  • בשביל minDuration ו-maxDuration, הערך הוא בצורה "{duration}s". רק שניות נתמכות ברמת פירוט של אלפית שנייה.
  • לגבי updateTime, ערך השדה של משאב קריאייטיב משקף את הפעם האחרונה שבה קריאייטיב עודכן, כולל עדכונים שבוצעו על ידי המערכת (למשל, עדכונים שבוצעו במהלך הבדיקה של הקריאייטיב).
  • יכול להיות שיחולו מספר הגבלות על lineItemIds כדי לחפש לפי מספר מזהי פריטים אפשריים.
  • יכול להיות שיחולו כמה הגבלות על creativeId כדי לחפש לפי מספר מזהי קריאייטיב אפשריים.

דוגמאות:

  • כל הקריאייטיבים המותאמים: 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 (format of ISO 8601) ומעלה: updateTime>="2020-11-04T18:54:47Z" האורך של השדה הזה לא יעלה על 500 תווים.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג 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.