Method: advertisers.locationLists.list

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

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

גודל הדף המבוקש. חייב להיות בין 1 ל-100. אם המדיניות לא מוגדרת, ברירת המחדל היא 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"

גוף הבקשה

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

גוף התגובה

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

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

object (LocationList)

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

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

string

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

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

היקפי הרשאות

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

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

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