Method: accounts.adSources.adapters.list

آداپتورهای منبع تبلیغ را فهرست کنید.

درخواست HTTP

GET https://admob.googleapis.com/v1beta/{parent=accounts/*/adSources/*}/adapters

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
parent

string

الزامی. والدی که مالک این مجموعه از آداپتورها است. قالب: accounts/{publisherId}/adSources/{adSourceId}

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

پارامترها
pageSize

integer

حداکثر تعداد آداپتورهایی که باید برگردانده شوند. اگر مشخص نشود یا 0 باشد، حداکثر 10،000 آداپتور برگردانده خواهد شد. حداکثر مقدار 20،000 است؛ مقادیر بالاتر از 20،000 به 20،000 محدود می‌شوند.

pageToken

string

یک توکن صفحه، که از فراخوانی قبلی adapters.list دریافت شده است. این توکن را برای بازیابی صفحه بعدی ارائه دهید.

درخواست بدنه

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

بدنه پاسخ

پاسخ برای ListAdaptersRequest.

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

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

object ( Adapter )

آداپتور.

nextPageToken

string

برای تنظیم pageToken در ListAdapterRequest برای بازیابی صفحه بعدی استفاده می‌شود. اگر این فیلد حذف شود، صفحات بعدی وجود نخواهند داشت.

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

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

  • https://www.googleapis.com/auth/admob.monetization
  • https://www.googleapis.com/auth/admob.readonly

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

آداپتور

آداپتورهای پشتیبانی شده توسط هر منبع تبلیغ میانجیگری را شرح می‌دهد.

آداپتورها با یک پیاده‌سازی SDK خاص از منبع تبلیغ مطابقت دارند و هر کدام با یک پلتفرم واحد و لیستی از قالب‌های واحد تبلیغ پشتیبانی‌شده مرتبط هستند. آداپتورها همچنین ممکن است برای انجام درخواست‌های تبلیغ نیاز به تنظیم برخی پیکربندی‌ها داشته باشند. پیکربندی‌ها را می‌توان در AdUnitMapping با تنظیم جفت‌های کلید/مقدار adUnitConfigurations مشخص کرد. به عنوان مثال، adUnitConfigurations می‌تواند برای ارسال شناسه‌های مختلف به SDK شخص ثالث آداپتور استفاده شود.

نمایش JSON 
{
  "name": string,
  "adapterId": string,
  "title": string,
  "platform": string,
  "formats": [
    string
  ],
  "adapterConfigMetadata": [
    {
      object (AdapterConfigMetadata)
    }
  ]
}
فیلدها
name

string

فقط خروجی. نام منبع آداپتور. فرمت:

حساب‌ها/{publisherId}/adSources/{adSourceId}/adapters/{adapterId}.

adapterId

string

فقط خروجی. شناسه این آداپتور. برای تنظیم adapterId استفاده می‌شود.

title

string

فقط خروجی. نام نمایشی این آداپتور.

platform

string

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

مقادیر پشتیبانی شده عبارتند از: IOS، ANDROID، WINDOWS_PHONE

formats[]

string

فقط خروجی. فرمت‌های واحدهای تبلیغاتی پشتیبانی‌شده توسط این آداپتور را نشان می‌دهد.

adapterConfigMetadata[]

object ( AdapterConfigMetadata )

فقط خروجی. فراداده پیکربندی مرتبط با این آداپتور.

متادیتای AdapterConfig

فراداده‌های پیکربندی مرتبط با این آداپتور. آن‌ها برای تعریف adUnitConfigurations مرتبط با AdUnitMappings برای این آداپتور استفاده می‌شوند.

نمایش JSON 
{
  "adapterConfigMetadataId": string,
  "adapterConfigMetadataLabel": string,
  "isRequired": boolean
}
فیلدها
adapterConfigMetadataId

string

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

adapterConfigMetadataLabel

string

نام فراداده پیکربندی آداپتور.

isRequired

boolean

اینکه آیا این فراداده برای پیکربندی AdUnitMappings مورد نیاز است یا خیر.