Method: advertisers.adGroupAds.list

הצגת המודעות בקבוצת המודעות.

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

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

תחביר נתמך:

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

השדות הנתמכים:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

דוגמאות:

  • כל המודעות בקבוצת מודעות מסוימת: adGroupId="1234"
  • כל המודעות בקבוצת מודעות בקבוצת מודעות עם סטטוס ישות של ENTITY_STATUS_ACTIVE או ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

האורך של השדה הזה צריך להיות עד 500 תווים.

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

גוף הבקשה

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

גוף התשובה

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

ייצוג ב-JSON 
{
  "adGroupAds": [
    {
      object (AdGroupAd)
    }
  ],
  "nextPageToken": string
}
שדות
adGroupAds[]

object (AdGroupAd)

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

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

string

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

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.