Method: advertisers.channels.sites.list

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

בקשת HTTP

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

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

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

פרמטרים
channelId

string (int64 format)

חובה. המזהה של ערוץ ההורה שאליו שייכים האתרים המבוקשים.
חובה. מזהה את הישות ב-DV360 שהיא הבעלים של ערוץ האב. הוא יכול להיות שותף או מפרסם. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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.
חובה. מזהה את הישות ב-DV360 שהיא הבעלים של ערוץ האב. הוא יכול להיות שותף או מפרסם. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
partnerId

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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