Method: partners.channels.list

הצגת רשימה של ערוצים של שותף או מפרסם.

בקשת HTTP

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

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

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

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

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

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

תחביר נתמך:

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

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

  • displayName

דוגמאות:

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

האורך של השדה הזה לא יכול להיות יותר מ-500 תווים.

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

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.