Method: partners.channels.sites.list

בתיבת הדו-שיח הזו מפורטים האתרים בערוץ.

בקשת HTTP

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

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

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

פרמטרים
channelId

string (int64 format)

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

string (int64 format)

המזהה של השותף שבבעלותו נמצא ערוץ ההורה.

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

פרמטרים
pageSize

integer

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

string

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

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

string

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

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

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