בתיבת הדו-שיח הזו מפורטים מפרסמים שהמשתמש הנוכחי יכול לגשת אליהם.
הסדר מוגדר על ידי הפרמטר orderBy
.
יש צורך ב-partnerId
יחיד. אין תמיכה ברישומים חוצי-שותפים.
בקשת HTTP
GET https://displayvideo.googleapis.com/v2/advertisers
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
partnerId |
חובה. המזהה של השותף שכל המפרסמים שאוחזרו צריכים להשתייך אליו. המערכת תומכת רק במפרסמים של כרטיסי מוצר עבור שותף אחד בכל פעם. |
pageSize |
גודל הדף המבוקש. חייב להיות בין |
pageToken |
אסימון שמזהה דף של תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של |
orderBy |
שדה שלפיו ממיינים את הרשימה. הערכים הקבילים הם:
סדר המיון שמוגדר כברירת מחדל הוא בסדר עולה. כדי לציין סדר יורד של שדה, צריך להוסיף סיומת 'description' לשם השדה. לדוגמה, |
filter |
מאפשר סינון לפי שדות מפרסם. תחביר נתמך:
שדות נתמכים:
דוגמאות:
האורך של השדה הזה לא יעלה על 500 תווים. למידע נוסף, אפשר לעיין במדריך שלנו בנושא סינון בקשות |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"advertisers": [
{
object ( |
שדות | |
---|---|
advertisers[] |
רשימת המפרסמים. אם הרשימה ריקה, היא לא תופיע. |
nextPageToken |
אסימון לאחזור של דף התוצאות הבא. צריך להעביר את הערך הזה בשדה |
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/display-video
למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.