Method: advertisers.list

רשימה של מפרסמים שהמשתמש הנוכחי יכול לגשת אליהם.

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

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

בקשת HTTP

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

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

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

פרמטרים
partnerId

string (int64 format)

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

integer

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

string

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

string

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

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

סדר המיון שמוגדר כברירת מחדל הוא סדר עולה. כדי לציין סדר יורד בשדה, צריך להוסיף את הסיומת 'desc' לשם השדה. לדוגמה, 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.