Method: firstPartyAndPartnerAudiences.list

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

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

درخواست HTTP

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

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

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

پارامترها
pageSize

integer

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

string

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

string

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

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

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

string

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

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

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

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

  • displayName

مثال‌ها:

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

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

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

string (int64 format)

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

string (int64 format)

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

متن درخواست

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

بدنه پاسخ

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

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

object (FirstPartyAndPartnerAudience)

فهرست مخاطبان طرف اول و شریک. ویژگی‌های اندازه مخاطب اضافه نخواهد شد.

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

string

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

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

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

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

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