Method: advertisers.adGroups.list

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

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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