Method: advertisers.locationLists.list

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

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת לשיטה 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 בקריאה הבאה לשיטה locationLists.list.

היקפי הרשאה

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

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

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