Method: accounts.adSources.adapters.list
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
آداپتورهای منبع آگهی را فهرست کنید.
درخواست HTTP
GET https://admob.googleapis.com/v1beta/{parent=accounts/*/adSources/*}/adapters
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
parent | string مورد نیاز. والدینی که این مجموعه آداپتورها را دارند. قالب: حساب‌ها/{publisherId}/adSources/{adSourceId} |
پارامترهای پرس و جو
| پارامترها |
|---|
pageSize | integer حداکثر تعداد آداپتورهایی که باید برگردند. اگر نامشخص یا 0 باشد، حداکثر 10000 آداپتور برگردانده می شود. حداکثر مقدار 20000 است. مقادیر بالای 20000 به 20000 اجباری می شود. |
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 مراجعه کنید.
آداپتور
آداپتورهای پشتیبانی شده توسط هر منبع تبلیغ واسطه را شرح می دهد.
آداپتورها با اجرای 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 ) فقط خروجی فراداده پیکربندی مرتبط با این آداپتور. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-08-21 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-21 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eLists available adapters for a given ad source, including details like platform, supported ad formats, and required configurations.\u003c/p\u003e\n"],["\u003cp\u003eProvides details on how to make the API request, including required parameters and authorization scopes.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of adapters, each with its unique ID, display name, and configuration metadata.\u003c/p\u003e\n"],["\u003cp\u003eAdapter configuration metadata defines the necessary settings for integrating the adapter with ad units.\u003c/p\u003e\n"],["\u003cp\u003ePagination is supported to retrieve large lists of adapters using page tokens.\u003c/p\u003e\n"]]],["To list adapters, send a `GET` request to `https://admob.googleapis.com/v1beta/{parent=accounts/*/adSources/*}/adapters`. The `parent` path parameter specifies the ad source. Use `pageSize` and `pageToken` query parameters to manage the number of results. The request body should be empty. A successful response returns a JSON object containing an array of `adapters` and `nextPageToken` for pagination. Each adapter has details such as `name`, `adapterId`, `title`, `platform`, supported `formats`, and `adapterConfigMetadata`.\n"],null,["# Method: accounts.adSources.adapters.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAdaptersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Adapter](#Adapter)\n - [JSON representation](#Adapter.SCHEMA_REPRESENTATION)\n- [AdapterConfigMetadata](#AdapterConfigMetadata)\n - [JSON representation](#AdapterConfigMetadata.SCHEMA_REPRESENTATION)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nList the adapters of the ad source.\n\n### HTTP request\n\n`GET https://admob.googleapis.com/v1beta/{parent=accounts/*/adSources/*}/adapters`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent which owns this collection of adapters. Format: accounts/{publisherId}/adSources/{adSourceId} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of adapters to return. If unspecified or 0, at most 10,000 adapters will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000. |\n| `pageToken` | `string` A page token, received from a previous `adapters.list` call. Provide this to retrieve the subsequent page. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse for the ListAdaptersRequest.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"adapters\": [ { object (/admob/api/reference/rest/v1beta/accounts.adSources.adapters/list#Adapter) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adapters[]` | `object (`[Adapter](/admob/api/reference/rest/v1beta/accounts.adSources.adapters/list#Adapter)`)` The adapter. |\n| `nextPageToken` | `string` Used to set the `pageToken` in the `ListAdapterRequest` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admob.monetization`\n- `\n https://www.googleapis.com/auth/admob.readonly`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nAdapter\n-------\n\nDescribes adapters supported by each mediation ad source.\n\nAdapters correspond to a specific SDK implementation of the ad source, and are each associated with a single platform and a list of supported ad unit formats. Adapters may also require setting some configurations to perform ad requests. Configurations can be specified in the AdUnitMapping by setting the [adUnitConfigurations](#AdUnitMapping.ad_unit_configurations) key/value pairs. For example, the adUnitConfigurations can be used to pass various IDs to the adapter's third-party SDK.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"adapterId\": string, \"title\": string, \"platform\": string, \"formats\": [ string ], \"adapterConfigMetadata\": [ { object (/admob/api/reference/rest/v1beta/accounts.adSources.adapters/list#AdapterConfigMetadata) } ] } ``` |\n\n| Fields ||\n|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name of the adapter. Format is: accounts/{publisherId}/adSources/{adSourceId}/adapters/{adapterId}. |\n| `adapterId` | `string` Output only. ID of this adapter. It is used to set [adapterId](#AdUnitMapping.adapter_id). |\n| `title` | `string` Output only. The display name of this adapter. |\n| `platform` | `string` Output only. Mobile application platform supported by this adapter. Supported values are: IOS, ANDROID, WINDOWS_PHONE |\n| `formats[]` | `string` Output only. Indicates the formats of the ad units supported by this adapter. |\n| `adapterConfigMetadata[]` | `object (`[AdapterConfigMetadata](/admob/api/reference/rest/v1beta/accounts.adSources.adapters/list#AdapterConfigMetadata)`)` Output only. Configuration metadata associated with this adapter. |\n\nAdapterConfigMetadata\n---------------------\n\nConfiguration metadata associated with this adapter. They are used to define the adUnitConfigurations associated with AdUnitMappings for the this adapter.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------|\n| ``` { \"adapterConfigMetadataId\": string, \"adapterConfigMetadataLabel\": string, \"isRequired\": boolean } ``` |\n\n| Fields ||\n|------------------------------|-------------------------------------------------------------------------------------------------------------|\n| `adapterConfigMetadataId` | `string` This is used to fill the key of the [adUnitConfigurations](#AdUnitMapping.ad_unit_configurations). |\n| `adapterConfigMetadataLabel` | `string` Name of the adapter configuration metadata. |\n| `isRequired` | `boolean` Whether this metadata is required for configuring the AdUnitMappings. |"]]
