בתיבת הדו-שיח הזו מוצגים הקמפיינים של המפרסם.
הסדר מוגדר על ידי הפרמטר orderBy
. אם לא מציינים filter
על entityStatus
, קמפיינים עם ENTITY_STATUS_ARCHIVED
לא ייכללו בתוצאות.
בקשת HTTP
GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/campaigns
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
advertiserId |
המזהה של המפרסם שעבורו יש לרשום את הקמפיינים. |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
גודל הדף המבוקש. חייב להיות בין |
pageToken |
אסימון שמזהה דף תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של |
orderBy |
שדה שלפיו תמיין את הרשימה. הערכים הקבילים הם:
סדר המיון המוגדר כברירת מחדל הוא עולה. כדי לציין סדר יורד לשדה מסוים, צריך להוסיף את הסיומת 'description' לשם השדה. דוגמה: |
filter |
מאפשר סינון לפי שדות קמפיין. תחביר נתמך:
שדות נתמכים:
דוגמאות:
האורך המקסימלי של השדה הזה הוא 500 תווים. מידע נוסף זמין במדריך שלנו בנושא סינון בקשות |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"campaigns": [
{
object ( |
שדות | |
---|---|
campaigns[] |
רשימת הקמפיינים. אם הרשימה ריקה, היא לא תופיע. |
nextPageToken |
אסימון לאחזור של דף התוצאות הבא. יש להעביר את הערך הזה בשדה |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/display-video
https://www.googleapis.com/auth/display-video-mediaplanning
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.