Method: advertisers.channels.sites.list

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/channels/{channelId}/sites

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

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

פרמטרים
channelId

string (int64 format)

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

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

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

היקפי ההרשאות

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

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

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.