Method: advertisers.manualTriggers.list

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

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

יש צורך ב-advertiserId יחיד.

אזהרה: פריטים שנעשה בהם שימוש בטריגרים ידניים לא מוצגים יותר ב-Display & Video 360. השיטה הזו תוצא משימוש ב-1 באוגוסט 2023. מידע נוסף זמין בהודעה שלנו על הוצאה משימוש של תכונות.

בקשת HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/manualTriggers

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

  • displayName (ברירת מחדל)
  • state

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

string

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

תחביר נתמך:

  • ביטויי סינון מורכבים מהגבלה אחת או יותר.
  • אפשר לשלב את ההגבלות באמצעות אופרטורים לוגיים AND או OR. רצף של הגבלות משתמש באופן לא מפורש ב-AND.
  • המונח של הגבלה הוא {field} {operator} {value}.
  • יש להשתמש באופרטור EQUALS (=) בכל השדות.

שדות נתמכים:

  • displayName
  • state

דוגמאות:

  • כל הטריגרים הידניים הפעילים אצל מפרסם: state="ACTIVE"

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

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

גוף הבקשה

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

גוף התשובה

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

ייצוג JSON 
{
  "manualTriggers": [
    {
      object (ManualTrigger)
    }
  ],
  "nextPageToken": string
}
שדות
manualTriggers[]

object (ManualTrigger)

רשימת הטריגרים הידניים.

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

string

אסימון לאחזור של דף התוצאות הבא. צריך להעביר את הערך הזה בשדה [pageToken][ListManualTriggersResponse.page_token] בקריאה הבאה ל-method של manualTriggers.list כדי לאחזר את דף התוצאות הבא.

היקפי הרשאות

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

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

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.