Method: googleAudiences.list

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

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

درخواست HTTP

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

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

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

پارامترها
page Size

integer

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

page Token

string

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

order By

string

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

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

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

filter

string

فیلتر کردن بر اساس فیلدهای مخاطب Google را امکان پذیر می کند.

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

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

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

  • displayName

مثال ها:

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

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

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

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

string ( int64 format)

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

advertiser Id

string ( int64 format)

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

درخواست بدن

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

بدن پاسخگو

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

نمایندگی JSON 
{
  "googleAudiences": [
    {
      object (GoogleAudience)
    }
  ],
  "nextPageToken": string
}
فیلدها
google Audiences[]

object ( GoogleAudience )

لیست مخاطبان گوگل

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

next Page Token

string

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

محدوده مجوز

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

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

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