Method: advertisers.adGroups.list

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

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

אופציונלי. אסימון שמזהה את דף התוצאות שהשרת צריך להחזיר. בדרך כלל, זה הערך של nextPageToken שמוחזר מהקריאה הקודמת ל-method‏ 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 בקריאה הבאה ל-method‏ adGroups.list כדי לאחזר את דף התוצאות הבא.

היקפי הרשאות

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

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.