Method: advertisers.manualTriggers.list

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

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

נדרש advertiserId יחיד.

אזהרה: פריטים שהוגדרו להם טריגרים ידניים לא מוצגים יותר בקמפיינים לרשת המדיה וידאו 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

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