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

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

  • ‫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.