Method: advertisers.list

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

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

נדרש partnerId יחיד. אין תמיכה בהצגת רשימה של שותפים שונים.

בקשת HTTP

GET https://displayvideo.googleapis.com/v3/advertisers

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

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

פרמטרים
partnerId

string (int64 format)

חובה. המזהה של השותף שאליו כל המפרסמים המאוחזרים צריכים להשתייך. המערכת תומכת ברישום של מפרסמים עבור שותף אחד בלבד בכל פעם.
pageSize

integer

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

string

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

string

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

  • ‫advertiserId (ברירת מחדל)
  • displayName
  • entityStatus
  • updateTime

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

string

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

תחביר נתמך:

  • ביטויי הסינון מורכבים מהגבלה אחת או יותר.
  • אפשר לשלב את ההגבלות באמצעות אופרטורים לוגיים AND או OR.
  • הגבלה יכולה להיות בפורמט {field} {operator} {value}.
  • השדה updateTime חייב להשתמש באופרטורים GREATER THAN OR EQUAL TO (>=) או LESS THAN OR EQUAL TO (<=).
  • בכל שאר השדות צריך להשתמש באופרטור EQUALS (=).

שדות נתמכים:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (קלט בפורמט ISO 8601 או YYYY-MM-DDTHH:MM:SSZ)

דוגמאות:

  • כל המפרסמים הפעילים במסגרת שותף: entityStatus="ENTITY_STATUS_ACTIVE"
  • כל המפרסמים שמועד העדכון שלהם הוא פחות מ-2020-11-04T18:54:47Z (בפורמט ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • כל המפרסמים שמועד העדכון שלהם גדול מ-2020-11-04T18:54:47Z (בפורמט ISO 8601): updateTime>="2020-11-04T18:54:47Z"

האורך של השדה הזה לא יעלה על 500 תווים.

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

גוף הבקשה

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

גוף התשובה

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

ייצוג ב-JSON 
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
שדות
advertisers[]

object (Advertiser)

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

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

string

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

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.