Method: advertisers.youtubeAdGroupAds.list

בתיבת הדו-שיח הזו מפורטים מודעות ברמת קבוצת המודעות ב-YouTube.

בקשת HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroupAds

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

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

תחביר נתמך:

  • ביטויי הסינון מורכבים מהגבלה אחת או יותר.
  • אפשר לשלב את ההגבלות באמצעות 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
{
  "youtubeAdGroupAds": [
    {
      object (YoutubeAdGroupAd)
    }
  ],
  "nextPageToken": string
}
שדות
youtubeAdGroupAds[]

object (YoutubeAdGroupAd)

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

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

nextPageToken

string

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

היקפי ההרשאות

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

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

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