Method: advertisers.locationLists.list

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

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

חובה. המזהה של המפרסם ב-DV360 שאליו שייכות רשימות המיקומים שאוחזרו.

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

פרמטרים
pageSize

integer

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

string

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

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

string

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

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

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

string

מאפשר סינון לפי שדות של רשימת מיקומים.

תחביר נתמך:

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

שדות נתמכים:

  • locationType

דוגמאות:

  • כל רשימת המיקומים האזוריים: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • רשימה של כל מיקומי קירבה: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

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

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

גוף הבקשה

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

גוף התשובה

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

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

object (LocationList)

הרשימה של רשימות המיקומים.

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

string

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

צריך להעביר את הערך הזה בשדה pageToken בקריאה הבאה ל-method של locationLists.list כדי לאחזר את דף התוצאות הבא.

היקפי הרשאות

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

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

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