Method: partners.channels.list

בתיבת הדו-שיח הזו מפורטים הערוצים של שותף או מפרסם.

בקשת HTTP

GET https://displayvideo.googleapis.com/v2/partners/{partnerId}/channels

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

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

פרמטרים
פרמטר איחוד owner. חובה. מזהה הישות ב-DV360 שבבעלותה הערוצים. זה יכול להיות שותף או מפרסם. owner יכול להיות רק אחד מהבאים:
partnerId

string (int64 format)

המזהה של השותף שהוא הבעלים של הערוצים.

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

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

תחביר נתמך:

  • ביטויי סינון לערוצים יכולים להכיל הגבלה אחת בלבד.
  • המונח של הגבלה הוא {field} {operator} {value}.
  • יש להשתמש באופרטור HAS (:) בכל השדות.

שדות נתמכים:

  • displayName

דוגמאות:

  • כל הערוצים שהשם המוצג שלהם מכיל את "google": displayName : "google".

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

למידע נוסף, אפשר לעיין במדריך שלנו בנושא סינון בקשות LIST.
פרמטר איחוד owner. חובה. מזהה הישות ב-DV360 שבבעלותה הערוצים. זה יכול להיות שותף או מפרסם. owner יכול להיות רק אחד מהבאים:
advertiserId

string (int64 format)

המזהה של המפרסם שהוא הבעלים של הערוצים.

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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