Method: partners.channels.list

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

בקשת HTTP

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

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

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

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

string (int64 format)

המזהה של המפרסם שמוגדר כבעלים של הערוצים.

גוף הבקשה

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

גוף התגובה

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

היקפי הרשאות

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

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

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