Method: advertisers.campaigns.list

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

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/campaigns

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • displayName (ברירת מחדל)
  • entityStatus
  • updateTime

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

filter

string

מאפשר סינון לפי שדות קמפיין.

תחביר נתמך:

  • ביטויי הסינון מורכבים מהגבלה אחת או יותר.
  • אפשר לשלב את ההגבלות באמצעות אופרטורים לוגיים AND או OR. רצף של הגבלות משתמש באופן מרומז ב-AND.
  • הגבלה היא בפורמט {field} {operator} {value}.
  • השדה updateTime חייב להשתמש באופרטורים GREATER THAN OR EQUAL TO (>=) או LESS THAN OR EQUAL TO (<=).
  • בכל שאר השדות צריך להשתמש באופרטור EQUALS (=).

שדות נתמכים:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (קלט בפורמט ISO 8601 או YYYY-MM-DDTHH:MM:SSZ)

דוגמאות:

  • כל ENTITY_STATUS_ACTIVE או ENTITY_STATUS_PAUSED הקמפיינים שמשויכים למפרסם מסוים: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • כל הקמפיינים שמועד העדכון שלהם הוא 2020-11-04T18:54:47Z (בפורמט ISO 8601) או שווה לו: updateTime<="2020-11-04T18:54:47Z"
  • כל הקמפיינים שמועד העדכון שלהם גדול מ-2020-11-04T18:54:47Z (בפורמט ISO 8601) או שווה לו: updateTime>="2020-11-04T18:54:47Z"

האורך של השדה הזה לא יעלה על 500 תווים.

לקבלת מידע נוסף, אפשר לעיין במדריך שלנו בנושא בקשות לסינון LIST.

גוף הבקשה

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

גוף התשובה

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

ייצוג JSON
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
שדות
campaigns[]

object (Campaign)

רשימת הקמפיינים.

אם הרשימה ריקה, הרשימה תיעלם.

nextPageToken

string

אסימון לאחזור של דף התוצאות הבא. צריך להעביר את הערך הזה בשדה pageToken בקריאה הבאה לשיטה campaigns.list, כדי לאחזר את דף התוצאות הבא.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

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