Method: partners.list

בתיבת הדו-שיח הזו מפורטים שותפים שהמשתמש יכול לגשת אליהם.

הסדר מוגדר על ידי הפרמטר orderBy.

בקשת HTTP

GET https://displayvideo.googleapis.com/v1/partners

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

  • displayName

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

string

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

תחביר נתמך:

  • ביטויי סינון מורכבים מהגבלה אחת או יותר.
  • אפשר לשלב את ההגבלות באמצעות אופרטורים לוגיים AND או OR. רצף של הגבלות משתמש באופן לא מפורש ב-AND.
  • ההגבלה יכולה להיות {field} {operator} {value}.
  • בכל השדות יש להשתמש באופרטור EQUALS (=).

שדות נתמכים:

  • entityStatus

דוגמאות:

  • כל השותפים הפעילים: entityStatus="ENTITY_STATUS_ACTIVE"

האורך המקסימלי של השדה הזה הוא 500 תווים.

מידע נוסף זמין במדריך שלנו בנושא סינון בקשות LIST.

גוף הבקשה

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

גוף התגובה

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

ייצוג JSON 
{
  "partners": [
    {
      object (Partner)
    }
  ],
  "nextPageToken": string
}
שדות
partners[]

object (Partner)

רשימת השותפים.

אם הרשימה ריקה, היא לא תופיע.
nextPageToken

string

אסימון לאחזור של דף התוצאות הבא. יש להעביר את הערך הזה בשדה pageToken בקריאה הבאה לשיטה partners.list כדי לאחזר את דף התוצאות הבא.

היקפי הרשאות

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

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

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