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