Method: firstPartyAndPartnerAudiences.list

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

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

درخواست HTTP

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

این URL از سینتکس Transcoding در 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 .