Method: accounts.adSources.adapters.list
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
HTTP 要求
GET https://admob.googleapis.com/v1beta/{parent=accounts/*/adSources/*}/adapters
這個網址使用 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
用於設定 ListAdapterRequest 中的 pageToken ,以擷取下一頁。如果省略這個欄位,就不會有後續頁面。
|
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/admob.monetization
https://www.googleapis.com/auth/admob.readonly
詳情請參閱 OAuth 2.0 總覽。
變壓器
說明每個中介服務廣告來源支援的轉接程式。
轉接程式會對應廣告來源的特定 SDK 導入方式,且每個轉接程式都與單一平台和支援的廣告單元格式清單相關聯。轉接程式可能還需要設定一些設定,才可執行廣告請求。您可以設定 adUnitConfigurations 鍵/值組合,在 AdUnitMapping 中指定設定。舉例來說,adUnitConfigurations 可用來將各種 ID 傳遞至轉接程式的第三方 SDK。
JSON 表示法 |
{
"name": string,
"adapterId": string,
"title": string,
"platform": string,
"formats": [
string
],
"adapterConfigMetadata": [
{
object (AdapterConfigMetadata )
}
]
} |
欄位 |
name |
string
僅供輸出。轉接程式的資源名稱。格式為: accounts/{publisherId}/adSources/{adSourceId}/adapters/{adapterId}.
|
adapterId |
string
僅供輸出。這個轉接程式的 ID。用於設定 adapterId。
|
title |
string
僅供輸出。這個轉接程式的顯示名稱。
|
platform |
string
僅供輸出。這個轉接程式支援的行動應用程式平台。 支援的值為:IOS、ANDROID、WINDOWS_PHONE
|
formats[] |
string
僅供輸出。指出這個轉接程式支援的廣告單元格式。
|
adapterConfigMetadata[] |
object (AdapterConfigMetadata )
僅供輸出。與這個轉接程式相關聯的設定中繼資料。
|
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 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. |"]]