Method: advertisers.locationLists.list

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

בקשת HTTP

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

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

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

פרמטרים
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 Overview.