Method: advertisers.reachForecast.retrievePlannableUserLists

הפעולה הזו מאחזרת רשימות משתמשים מאינטראקציה ישירה ומצד שלישי שזמינות לחיזוי.

בקשת HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

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

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

פרמטרים
advertiserId

string (int64 format)

חובה. המזהה של המפרסם שאליו רוצים לאחזר רשימות משתמשים שאפשר לתכנן עבורן קמפיינים.

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

פרמטרים
pageSize

integer

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

string

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

string

אופציונלי. מאפשר סינון לפי מאפיינים של רשימת משתמשים שאפשר לתכנן.

תחביר נתמך:

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

שדות נתמכים:

  • plannableStatus
  • displayName
  • userListType
  • name

דוגמאות:

  • כל רשימות המשתמשים שאפשר לתכנן: plannableStatus="PLANNABLE"
  • רשימות משתמשים שאפשר לתכנן להשתמש בהן ושם התצוגה שלהן מכיל את המילה 'שופינג': plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • רשימות משתמשים של צד ראשון: userListType="FIRST_PARTY"

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

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

גוף הבקשה

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

גוף התשובה

תשובה ל-reachForecast.retrievePlannableUserLists.

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

ייצוג ב-JSON 
{
  "plannableUserLists": [
    {
      object (PlannableUserList)
    }
  ],
  "nextPageToken": string
}
שדות
plannableUserLists[]

object (PlannableUserList)

פלט בלבד. רשימת רשימות המשתמשים שאפשר לתכנן.
nextPageToken

string

פלט בלבד. אסימון לאחזור של דף התוצאות הבא.

היקפי הרשאות

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

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

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

PlannableUserList

רשימת משתמשים שאפשר לתכנן את השימוש בה, ומשמשת לתחזית היקף החשיפה.

ייצוג ב-JSON 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
שדות
displayName

string

פלט בלבד. השם המוצג של רשימת המשתמשים.
userListType

enum (UserListType)

פלט בלבד. סוג רשימת המשתמשים.
name

string

פלט בלבד. שם המשאב שמזהה את רשימת המשתמשים.

פורמט: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

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

UserListType

סוגים של רשימות משתמשים.

טיפוסים בני מנייה (enum)
USER_LIST_TYPE_UNSPECIFIED סוג רשימת משתמשים לא צוין.
FIRST_PARTY רשימת משתמשים מצד ראשון.
THIRD_PARTY רשימת משתמשים של צד שלישי.

PlannableStatus

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

טיפוסים בני מנייה (enum)
PLANNABLE_STATUS_UNSPECIFIED לא צוין סטטוס התכנון.
PLANNABLE אפשר לתכנן את רשימת המשתמשים.
UNPLANNABLE אי אפשר לתכנן את השימוש ברשימת המשתמשים.