Method: advertisers.locationLists.list

הצגת רשימות של מיקומים על סמך מזהה מפרסם נתון.

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

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

string

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

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

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