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 Overview をご覧ください。

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

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

string

この広告ユニットが関連付けられているアプリの外部に公開される ID。例: ca-app-pub-9876543210987654~0123456789
displayName

string

AdMob UI に表示される広告ユニットの表示名（ユーザーが指定）。最大文字数は 80 文字です。
adFormat

string

広告ユニットの AdFormat。次の値を指定できます。

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

string

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

「RICH_MEDIA」 - テキスト、画像、動画以外のメディア。「VIDEO」 - 動画メディア。