Method: partners.channels.sites.list

הצגת רשימה של אתרים בערוץ.

בקשת HTTP

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

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

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

פרמטרים
channelId

string (int64 format)

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

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

אסימון שמזהה את דף התוצאות שהשרת צריך להחזיר.

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

string

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

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

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

string

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

תחביר נתמך:

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

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

  • urlOrAppId

דוגמאות:

  • כל האתרים שכתובת ה-URL או מזהה האפליקציה שלהם מכילים את המילה google: ‏urlOrAppId : "google"

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

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

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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