Method: partners.channels.list

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

בקשת HTTP

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

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

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

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

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

ברירת המחדל של סדר המיון היא בסדר עולה. כדי לציין סדר יורד בשדה, צריך להוסיף את הסיומת 'desc' לשם השדה. דוגמה: 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.