Method: advertisers.locationLists.assignedLocations.list

مکان‌های اختصاص‌داده‌شده به فهرست مکان را فهرست می‌کند.

درخواست HTTP

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

نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
advertiserId

string (int64 format)

الزامی. شناسه آگهی‌دهنده DV360 که فهرست مکان به آن تعلق دارد.

locationListId

string (int64 format)

الزامی. شناسه فهرست مکان که این واگذاری‌ها به آن واگذار شده است.

پارامترهای پُرسمان

پارامترها
pageSize

integer

اندازه صفحه درخواست‌شده. باید بین 1 و 200 باشد. اگر مشخص نشده باشد، به‌طور پیش‌فرض روی 100 تنظیم می‌شود. اگر مقدار نامعتبری مشخص شده باشد، کد خطای INVALID_ARGUMENT را برمی‌گرداند.

pageToken

string

نشانه‌ای که صفحه‌ای از نتایج را که سرور باید برگرداند شناسایی می‌کند.

معمولاً این مقدار nextPageToken است که از تماس قبلی با روش assignedLocations.list برگردانده شده است. اگر مشخص نشده باشد، اولین صفحه نتایج برگردانده خواهد شد.

orderBy

string

فیلدی که فهرست براساس آن مرتب می‌شود. مقادیر پذیرفتنی عبارت‌اند از:

  • assignedLocationId (پیش‌فرض)

ترتیب مرتب‌سازی پیش‌فرض صعودی است. برای مشخص کردن ترتیب نزولی برای یک فیلد، باید پسوند « desc» به نام فیلد اضافه شود. مثال: assignedLocationId desc.

filter

string

فیلتر کردن براساس فیلدهای واگذاری فهرست مکان را مجاز می‌کند.

نحو پشتیبانی‌شده:

  • عبارت‌های فیلتر از یک یا چند محدودیت تشکیل شده‌اند.
  • محدودیت‌ها را می‌توان با عملگر منطقی OR ترکیب کرد.
  • محدودیت به‌صورت {field} {operator} {value} است.
  • همه فیلدها باید از اپراتور EQUALS (=) استفاده کنند.

فیلدهای پشتیبانی‌شده:

  • assignedLocationId

طول این فیلد نباید بیشتر از ۵۰۰ نویسه باشد.

برای اطلاعات بیشتر، به راهنمای درخواست‌های LIST فیلتر ما مراجعه کنید.

متن درخواست

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پیام پاسخ برای 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 Overview مراجعه کنید.