Method: advertisers.list

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

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

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

בקשת HTTP

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

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

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

פרמטרים
partnerId

string (int64 format)

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

integer

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

string

אסימון שמזהה את דף התוצאות שהשרת צריך להחזיר. בדרך כלל, זה הערך של nextPageToken שמוחזר מהקריאה הקודמת ל-method‏ 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 בקריאה הבאה ל-method‏ advertisers.list כדי לאחזר את דף התוצאות הבא.

היקפי הרשאות

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

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

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