Method: advertisers.channels.list

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

בקשת HTTP

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

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

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

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

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 יכול להיות רק אחד מהבאים:
partnerId

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאה

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

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

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