Method: lookalikeAudiences.list

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

ترتیب با پارامتر orderBy تعریف می‌شود.

درخواست HTTP

GET https://displayvideo.googleapis.com/v5/lookalikeAudiences

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

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

پارامترها
pageSize

integer

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

string

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

string

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

  • lookalikeAudienceId (پیش‌فرض)
  • displayName

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

string

امکان فیلتر کردن براساس فیلدهای مخاطب «همسان» را فراهم می‌کند.

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

  • عبارت‌های فیلتر برای مخاطبان «همسان» فقط می‌توانند حداکثر یک محدودیت داشته باشند.
  • محدودیت به‌صورت {field} {operator} {value} است.
  • همه فیلدها باید از اپراتور HAS (:) استفاده کنند.

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

  • displayName

مثال‌ها:

  • همه مخاطبان «مشابه» که نام نمایشی آن‌ها حاوی «مشابه» است: displayName:"Lookalike".

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

برای اطلاعات بیشتر، به راهنمای درخواست‌های LIST فیلتر ما مراجعه کنید.
الزامی. مشخص می‌کند که درخواست در کدام نهاد DV360 انجام می‌شود. درخواست LIST فقط نهادهای مخاطب «مشابه» را برمی‌گرداند که برای نهاد DV360 شناسایی‌شده در accessor قابل‌دسترسی هستند. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
partnerId

string (int64 format)

شناسه شریکی که به مخاطبان «مشابه» واکشی‌شده دسترسی دارد.
advertiserId

string (int64 format)

شناسه آگهی‌دهنده‌ای که به مخاطبان «مشابه» واکشی‌شده دسترسی دارد.
پایان فیلدهای متقابلاً انحصاری.

متن درخواست

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

بدنه پاسخ

پیام پاسخ برای LookalikeAudienceService.ListLookalikeAudiences.

اگر موفقیت‌آمیز باشد، بدنه پاسخ حاوی داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "lookalikeAudiences": [
    {
      object (LookalikeAudience)
    }
  ],
  "nextPageToken": string
}
فیلدها
lookalikeAudiences[]

object (LookalikeAudience)

فهرست مخاطبان «مشابه».

اگر این فهرست خالی باشد، نمایش داده نخواهد شد.
nextPageToken

string

نشانه‌ای برای بازیابی صفحه بعدی نتایج. این مقدار را در فیلد pageToken در تماس بعدی با روش lookalikeAudiences.list ارسال کنید تا صفحه بعدی نتایج بازیابی شود.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به OAuth 2.0 Overview مراجعه کنید.