Method: partners.channels.sites.list

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

בקשת HTTP

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

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

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

פרמטרים
channelId

string (int64 format)

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

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

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

string

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

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

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

string

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

תחביר נתמך:

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

שדות נתמכים:

  • urlOrAppId

דוגמאות:

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

האורך של השדה הזה צריך להיות עד 500 תווים.

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

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאה

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

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

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