Method: advertisers.youtubeAdGroups.list

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

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

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

תחביר נתמך:

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

מאפיינים נתמכים:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

דוגמאות:

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

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

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

גוף הבקשה

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

גוף התשובה

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

ייצוג JSON 
{
  "youtubeAdGroups": [
    {
      object (YoutubeAdGroup)
    }
  ],
  "nextPageToken": string
}
שדות
youtubeAdGroups[]

object (YoutubeAdGroup)

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

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

string

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

היקפי הרשאות

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

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

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