Method: advertisers.locationLists.list

فهرست‌های مکان را بر اساس شناسه تبلیغ‌کننده معین فهرست می‌کند.

درخواست HTTP

GET https://displayvideo.googleapis.com/v1/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 مراجعه کنید.