Method: advertisers.locationLists.assignedLocations.list

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

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

locationListId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

pageToken

string

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

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

orderBy

string

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

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

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

filter

string

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

תחביר נתמך:

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

האורך המקסימלי של השדה הזה הוא 500 תווים.

גוף הבקשה

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

גוף התגובה

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

הודעת תגובה ל- AssignedLocationService.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.