Method: accounts.adUnits.list

指定した AdMob アカウントの広告ユニットのリストを表示します。

HTTP リクエスト

GET https://admob.googleapis.com/v1/{parent=accounts/*}/adUnits

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

パスパラメータ

パラメータ
parent

string

必須。広告ユニットを一覧表示するアカウントのリソース名。例: accounts/pub-9876543210987654

クエリ パラメータ

パラメータ
pageSize

integer

返される広告ユニットの最大数。指定しないか 0 にすると、最大で 10,000 の広告ユニットが返されます。最大値は 20,000 です。20,000 を超える値は 20,000 に強制変換されます。
pageToken

string

最後の ListAdUnitsResponse で返された値は、これが前の adUnits.list 呼び出しの続きであり、システムがデータの次のページを返す必要があることを示しています。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

広告ユニットリスト リクエストに対するレスポンス。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
フィールド
adUnits[]

object (AdUnit)

リクエストされたアカウントで生成された広告ユニット。
nextPageToken

string

空でない場合は、リクエストに対してさらに広告ユニットがある可能性があることを示します。この値は新しい ListAdUnitsRequest で渡す必要があります。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 の概要をご覧ください。

AdUnit

AdMob の広告ユニットについて説明します。

JSON 表現 
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ]
}
フィールド
name

string

この広告ユニットのリソース名。形式は accounts/{publisherId}/adUnits/{ad_unit_id_fragment} です。例: accounts/pub-9876543210987654/adUnits/0123456789
adUnitId

string

外部から見える広告ユニットの ID。AdMob SDK との統合に使用できます。これは読み取り専用のプロパティです。例: ca-app-pub-9876543210987654/0123456789
appId

string

この広告ユニットが関連付けられているアプリの外部から閲覧可能な ID です。例: ca-app-pub-9876543210987654~0123456789
displayName

string

AdMob 管理画面に表示される広告ユニットの表示名で、ユーザーが指定します。最大文字数は 80 文字です。
adFormat

string

広告ユニットの広告フォーマット。指定できる値は次のとおりです。

「APP_OPEN」 - アプリ起動時広告フォーマット。"BANNER" - バナー広告フォーマット。「BANNER_INTERSTITIAL」 - バナーまたはインタースティシャルとして使用できる従来のフォーマットです。このフォーマットは作成できなくなりましたが、メディエーション グループでターゲットを設定できます。「INTERSTITIAL」 - フルスクリーン広告。サポートされている広告タイプは「RICH_MEDIA」と「VIDEO」です。「NATIVE」 - ネイティブ広告フォーマット。「リワード広告」 - 広告が視聴されると、ユーザーに報酬を提供するために、視聴を確認するコールバックが受けられます。サポートされている広告タイプは、「RICH_MEDIA」（インタラクティブ）と、動画を除外できない動画です。"REWARDED_INTERSTITIAL" - リワード インタースティシャル広告フォーマット。動画広告タイプにのみ対応しています。https://support.google.com/admob/answer/9884467 をご覧ください。
adTypes[]

string

この広告ユニットでサポートされている広告メディア タイプです。有効な値は次のとおりです。

"RICH_MEDIA" - テキスト、画像など、動画以外のメディア。"VIDEO" - 動画メディア。