Method: firstAndThirdPartyAudiences.list
مخاطبان شخص اول و سوم را فهرست می کند.
ترتیب با پارامتر orderBy
تعریف می شود.
درخواست HTTP
GET https://displayvideo.googleapis.com/v3/firstAndThirdPartyAudiences
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
پارامترها |
---|
pageSize | integer اندازه صفحه درخواستی باید بین 1 تا 5000 باشد. اگر مشخص نشده باشد، این مقدار به طور پیش فرض 5000 . اگر مقدار نامعتبری مشخص شده باشد، کد خطا INVALID_ARGUMENT را برمیگرداند. |
pageToken | string نشانه ای که صفحه ای از نتایجی را که سرور باید برگرداند، شناسایی کند. به طور معمول، این مقدار nextPageToken است که از فراخوانی قبلی به روش firstAndThirdPartyAudiences.list برگردانده می شود. اگر مشخص نشده باشد، صفحه اول نتایج برگردانده خواهد شد. |
orderBy | string فیلدی که بر اساس آن لیست مرتب می شود. مقادیر قابل قبول عبارتند از: -
firstAndThirdPartyAudienceId (پیشفرض) -
displayName
ترتیب مرتب سازی پیش فرض صعودی است. برای تعیین ترتیب نزولی برای یک فیلد، پسوند "desc" باید به نام فیلد اضافه شود. مثال: displayName desc . |
filter | string امکان فیلتر کردن بر اساس فیلدهای مخاطب اول و ثالث را فراهم می کند. نحو پشتیبانی شده: - عبارات فیلتر برای مخاطبان شخص اول و ثالث فقط می توانند حداکثر یک محدودیت داشته باشند.
- یک محدودیت به شکل
{field} {operator} {value} است. - همه فیلدها باید از عملگر
HAS (:) استفاده کنند.
زمینه های پشتیبانی شده: مثال ها: - همه مخاطبان شخص اول و سوم که نام نمایشی آنها حاوی "Google" است:
displayName:"Google" .
طول این فیلد نباید بیشتر از 500 کاراکتر باشد. برای اطلاعات بیشتر به راهنمای درخواست های LIST فیلتر ما مراجعه کنید. |
accessor پارامتر اتحادیه مورد نیاز. مشخص می کند که درخواست در کدام نهاد DV360 در حال انجام است. درخواست LIST فقط موجودیت های مخاطب اول و شخص ثالث را برمی گرداند که برای موجودیت DV360 شناسایی شده در accessor قابل دسترسی هستند. accessor می تواند تنها یکی از موارد زیر باشد: |
partnerId | string ( int64 format) شناسه شریکی که به مخاطبان شخص اول و سوم واکشی شده دسترسی دارد. |
advertiserId | string ( int64 format) شناسه تبلیغکنندهای که به مخاطبان شخص اول و سوم واکشی شده دسترسی دارد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
فیلدها |
---|
firstAndThirdPartyAudiences[] | object ( FirstAndThirdPartyAudience ) فهرست مخاطبان شخص اول و سوم. ویژگی های اندازه مخاطب شامل نمی شود. در صورت خالی بودن این لیست وجود نخواهد داشت. |
nextPageToken | string نشانه ای برای بازیابی صفحه بعدی نتایج. این مقدار را در قسمت pageToken در فراخوانی بعدی به روش firstAndThirdPartyAudiences.list ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/display-video
برای اطلاعات بیشتر، بهOAuth 2.0 Overview .
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-03-07 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-03-07 بهوقت ساعت هماهنگ جهانی."],[[["Lists first and third party audiences, providing options to filter, sort, and paginate the results."],["The request must specify either a partner ID or an advertiser ID to define the scope of accessible audiences."],["Responses include a list of first and third party audiences and a token for retrieving subsequent pages, if available."],["The API uses a standard HTTP GET request and requires authorization with the `display-video` scope."]]],["This API endpoint lists first and third-party audiences via a `GET` request to `https://displayvideo.googleapis.com/v3/firstAndThirdPartyAudiences`. Query parameters include `pageSize` (defaults to 100, increasing to 5000 in 2025), `pageToken` for pagination, `orderBy` to sort by audience ID or display name, and `filter` to refine results by display name. Access requires either `partnerId` or `advertiserId`. The response includes an array of audience objects and a `nextPageToken` for further pagination. The request body is empty, and authorization requires the `https://www.googleapis.com/auth/display-video` OAuth scope.\n"]]