Method: accounts.adSources.adapters.list

広告ソースのアダプタのリストを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 実装に対応しており、それぞれ 1 つのプラットフォームとサポートされている広告ユニット フォーマットのリストに関連付けられます。アダプタでは、広告リクエストを実行するための設定も必要になる場合があります。広告ユニットのマッピングでは、adUnitConfigurations の Key-Value ペアを設定することで設定を指定できます。たとえば、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)

出力のみ。このアダプタに関連付けられている構成メタデータ。

AdapterConfigMetadata

このアダプタに関連付けられている構成メタデータ。このアダプタの gcpMappings に関連付けられている adUnitConfigurations の定義に使用されます。

JSON 表現 
{
  "adapterConfigMetadataId": string,
  "adapterConfigMetadataLabel": string,
  "isRequired": boolean
}
フィールド
adapterConfigMetadataId

string

adUnitConfigurations のキーの入力に使用されます。
adapterConfigMetadataLabel

string

アダプタ構成メタデータの名前。
isRequired

boolean

このメタデータが gcpMappings の設定に必要かどうか。