Method: advertisers.adGroups.list

בתיבת הדו-שיח הזו מוצגים קבוצות של מודעות.

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

אפשרות. מאפשר סינון לפי שדות מותאמים אישית של קבוצות מודעות.

תחביר נתמך:

  • ביטויי סינון מורכבים מהגבלה אחת או יותר.
  • אפשר לשלב את ההגבלות באמצעות AND ו-OR. רצף של הגבלות משתמש באופן לא מפורש ב-AND.
  • ההגבלה יכולה להיות {field} {operator} {value}.
  • בכל השדות יש להשתמש באופרטור EQUALS (=).

מאפיינים נתמכים:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

דוגמאות:

  • כל קבוצות המודעות שנכללות בפריט: lineItemId="1234"
  • כל ENTITY_STATUS_ACTIVE או ENTITY_STATUS_PAUSED קבוצות המודעות AD_GROUP_FORMAT_IN_STREAM של מפרסם: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

האורך המקסימלי של השדה הזה הוא 500 תווים.

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

גוף הבקשה

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

גוף התגובה

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

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

object (AdGroup)

רשימת הקבוצות של המודעות.

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

string

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

היקפי הרשאות

נדרש היקף OAuth הבא:

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

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