Method: firstAndThirdPartyAudiences.list

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

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

درخواست HTTP

GET https://displayvideo.googleapis.com/v3/firstAndThirdPartyAudiences

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
page Size

integer

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

page Token

string

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

order By

string

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

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

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

filter

string

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

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

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

زمینه های پشتیبانی شده:

  • displayName

مثال ها:

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

طول این فیلد نباید بیشتر از 500 کاراکتر باشد.

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

accessor پارامتر اتحادیه مورد نیاز. مشخص می کند که درخواست در کدام نهاد DV360 در حال انجام است. درخواست LIST فقط موجودیت های مخاطب اول و شخص ثالث را برمی گرداند که برای موجودیت DV360 شناسایی شده در accessor قابل دسترسی هستند. accessor می تواند تنها یکی از موارد زیر باشد:
partner Id

string ( int64 format)

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

advertiser Id

string ( int64 format)

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

درخواست بدن

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

بدن پاسخگو

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

نمایندگی JSON 
{
  "firstAndThirdPartyAudiences": [
    {
      object (FirstAndThirdPartyAudience)
    }
  ],
  "nextPageToken": string
}
فیلدها
first And Third Party Audiences[]

object ( FirstAndThirdPartyAudience )

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

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

next Page Token

string

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

محدوده مجوز

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

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

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

،

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

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

درخواست HTTP

GET https://displayvideo.googleapis.com/v3/firstAndThirdPartyAudiences

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
page Size

integer

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

page Token

string

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

order By

string

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

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

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

filter

string

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

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

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

زمینه های پشتیبانی شده:

  • displayName

مثال ها:

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

طول این فیلد نباید بیشتر از 500 کاراکتر باشد.

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

accessor پارامتر اتحادیه مورد نیاز. مشخص می کند که درخواست در کدام نهاد DV360 در حال انجام است. درخواست LIST فقط موجودیت های مخاطب اول و شخص ثالث را برمی گرداند که برای موجودیت DV360 شناسایی شده در accessor قابل دسترسی هستند. accessor می تواند تنها یکی از موارد زیر باشد:
partner Id

string ( int64 format)

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

advertiser Id

string ( int64 format)

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

درخواست بدن

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

بدن پاسخگو

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

نمایندگی JSON 
{
  "firstAndThirdPartyAudiences": [
    {
      object (FirstAndThirdPartyAudience)
    }
  ],
  "nextPageToken": string
}
فیلدها
first And Third Party Audiences[]

object ( FirstAndThirdPartyAudience )

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

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

next Page Token

string

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

محدوده مجوز

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

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

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