Method: advertisers.locationLists.assignedLocations.list

בתיבת הדו-שיח הזו מפורטים מיקומים שהוקצו לרשימת מיקומים.

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

string (int64 format)

חובה. המזהה של רשימת המיקומים שאליה ההקצאות האלה מוקצות.

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

פרמטרים
pageSize

integer

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

string

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

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

string

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

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

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

string

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

תחביר נתמך:

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

שדות נתמכים:

  • assignedLocationId

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

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

גוף הבקשה

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

גוף התשובה

הודעת תגובה ל-AssignLocationService.ListAssignedLocations.

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

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

object (AssignedLocation)

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

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

string

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

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

היקפי ההרשאות

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

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

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