Method: advertisers.campaigns.list

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

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

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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