Method: advertisers.adGroups.list

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

בקשת HTTP

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

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

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

פרמטרים
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 Overview.