Google Mobile Ads React Native API

@google/mobile-ads モジュールは、Google Mobile Ads を React Native アプリケーションに統合するためのコア TypeScript インターフェース、クラス、トップレベル関数を提供します。

概要

型エイリアス
AdapterState
メディエーション アダプターの初期化状態を表します。
AdChoicesPlacement
広告ビュー内の AdChoices アイコンの位置。
AdFormat
リクエストされている広告のフォーマット。
AdInspectorError
広告インスペクタが失敗した理由に関するエラー情報。
AdInspectorErrorCode
広告インスペクタの起動や操作に影響するエラー。
AdOrientation
インライン アダプティブ バナー広告と大型アンカー アダプティブ バナー広告の向きのオプション。
AdSize
広告のサイズを表します。
AgeRestrictedTreatment
広告リクエストの年齢制限に応じた取り扱いオプションを定義します。
ConsentStatus
同意ステータスの値。
DebugGeography
地域をテストするためのデバッグ値。
FormErrorCode
User Messaging Platform（UMP）フォームのオペレーションの失敗のエラーコードを表します。
FullScreenContentErrorCode
LoadAdErrorCode
広告読み込みオペレーションの失敗のエラーコードを表します。
MaxAdContentRating
アプリの広告レーティングの上限を定義し、表示できる広告の種類を分類します。
NativeAdAssetNames
標準のネイティブ広告アセットの識別に使用される名前。
NativeAdType
読み込まれたネイティブ広告のフォーマットを識別します。
NativeMediaAspectRatio
返されるネイティブ広告メディアのアスペクト比に関する設定。
OnAdInspectorClosedListener
広告インスペクタの UI が閉じられたときに呼び出されるコールバックのインターフェース定義。
PrecisionType
報告された広告価値の精度。
PrivacyOptionsRequirementStatus
プライバシー オプションの要件ステータス。
PublisherPrivacyPersonalizationState
パブリッシャーのプライバシーに関する取り扱いのパーソナライズ状態を示します。
ResizeMode
NativeAdMediaView の画像コンテンツのサイズ変更モードをカスタマイズするためのオプション。
ResolvedAdSize
広告が読み込まれた後の広告サイズの最終的な解決状態を表します。
SwipeGestureDirection
カスタム クリック スワイプ操作の手順。
変数
AdSize
アダプティブ サイズとカスタム サイズを作成するための事前定義された広告サイズとヘルパー メソッド。
関数
canRequestAds
現在の同意ステータスで広告をリクエストできるかどうかを確認します。
getConsentStatus
ユーザーの現在の同意ステータスを取得します。
getInitializationStatus
SDK の初期化ステータスを取得します。
getPrivacyOptionsRequirementStatus
アプリにプライバシー オプションのエントリ ポイントが必要かどうかを確認します。
getRequestConfiguration
グローバル リクエスト構成を取得します。
initialize
Google Mobile Ads SDK を初期化します。
isConsentFormAvailable
同意フォームが利用可能かどうかを確認します。
loadAndShowConsentFormIfRequired
現在の同意ステータスで同意フォームが必要な場合（ステータスが REQUIRED など）、同意フォームを読み込んでユーザーに表示します。
openAdInspector
Google Mobile Ads SDK の広告インスペクタ オーバーレイを開きます。
openDebugMenu
デバッグ メニューを開きます。
parseLoadAdError
広告読み込み中にスローされたネイティブ エラーを解析し、LoadAdError でラップします。
requestConsentInfoUpdate
同意情報の更新をリクエストします。
reset
永続ストレージからすべての同意ステータスをクリアします。
setPublisherFirstPartyIdEnabled
パブリッシャーのファーストパーティ ID が有効かどうかを制御します。
setRequestConfiguration
コンプライアンスとターゲティングのグローバル リクエスト構成を設定します。
setUserControlledAppVolume
ユーザーが制御するアプリの音量を設定します。
setUserMutedApp
アプリがミュートされているかどうかを設定します。
showPrivacyOptionsForm
プライバシー オプション フォームを表示します。

型エイリアス

AdapterState

AdapterState: typeof AdapterState[keyof typeof AdapterState]
メディエーション アダプターの初期化状態を表します。
プロパティ
NOT_READY
メディエーション アダプターがまだ初期化されていないか、初期化に失敗したことを示します。
READY
メディエーション アダプターが正常に初期化され、広告を配信できる状態であることを示します。

AdChoicesPlacement

AdChoicesPlacement: typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
広告ビュー内の AdChoices アイコンの位置。
プロパティ
BOTTOM_LEFT
広告の左下の角。
BOTTOM_RIGHT
広告の右下の角。
TOP_LEFT
広告の左上隅。
TOP_RIGHT
広告の右上。

AdFormat

AdFormat: typeof AdFormat[keyof typeof AdFormat]
リクエストされている広告のフォーマット。
プロパティ
APP_OPEN
アプリ起動時広告フォーマット。
BANNER
バナー広告フォーマット。
INTERSTITIAL
インタースティシャル広告フォーマット。
NATIVE
ネイティブ広告フォーマット。
REWARDED
リワード広告フォーマット。
REWARDED_INTERSTITIAL
リワード インタースティシャル広告のフォーマット。

AdInspectorError

AdInspectorError: BaseError<AdInspectorErrorCode>
広告インスペクタが失敗した理由に関するエラー情報。

AdInspectorErrorCode

AdInspectorErrorCode: typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
広告インスペクタの起動や操作に影響するエラー。
プロパティ
ALREADY_OPEN
広告インスペクタはすでに開いているため、開けません。
FAILED_TO_LOAD
広告インスペクタを読み込めませんでした。
INTERNAL_ERROR
広告インスペクタで内部エラーが発生しました。
NOT_IN_TEST_MODE
デバイスがテストモードになっていないため、広告インスペクタを開けません。

AdOrientation

AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
インライン アダプティブ バナー広告と大型アンカー アダプティブ バナー広告の向きのオプション。
プロパティ
CURRENT
LANDSCAPE
PORTRAIT

AdSize

広告のサイズを表します。

事前定義されたサイズのセット（AdSize.LARGE_BANNER など）またはアダプティブ サイズのいずれかになります。

AgeRestrictedTreatment

AgeRestrictedTreatment: typeof AgeRestrictedTreatment[keyof typeof AgeRestrictedTreatment]
広告リクエストの年齢制限に応じた取り扱いオプションを定義します。
プロパティ
CHILD
広告リクエストに子ども向け取り扱いを適用することを示します。
TEEN
広告リクエストに 13 歳以上の未成年者の取り扱いを適用することを示します。
UNSPECIFIED
広告リクエストに特定の年齢制限に応じた取り扱いシグナルが適用されないことを示します。

ConsentStatus

ConsentStatus: typeof ConsentStatus[keyof typeof ConsentStatus]
同意ステータスの値。
プロパティ
NOT_REQUIRED
同意は必要ありません。
OBTAINED
ユーザーの同意が得られているかどうか、パーソナライズされているかどうか、パーソナライズされていないかどうかを返します。
REQUIRED
ユーザーの同意が必要だが、まだ取得していない。
UNKNOWN
同意ステータスが不明です。

DebugGeography

DebugGeography: typeof DebugGeography[keyof typeof DebugGeography]
地域をテストするためのデバッグ値。
プロパティ
DISABLED
デバッグ用デバイスで地域デバッグが無効になっています。
EEA
デバッグ用デバイスで、地域が EEA として表示されます。
OTHER
デバッグ用デバイスで、地域が規制が施行されていない地域として表示されます。
REGULATED_US_STATE
デバッグ用デバイスで、地域が規制対象の米国の州として表示されます。

FormErrorCode

FormErrorCode: typeof FormErrorCode[keyof typeof FormErrorCode]
User Messaging Platform（UMP）フォームのオペレーションの失敗のエラーコードを表します。
プロパティ
ALREADY_USED
同意書はすでに使用されています。
INTERNAL_ERROR
SDK 内で内部エラーが発生しました。
INVALID_OPERATION
操作が無効でした。
NETWORK_ERROR
ネットワーク接続のため、フォーム オペレーションが失敗しました。
TIMEOUT
フォーム オペレーションがタイムアウトしました。
UNAVAILABLE
同意フォームはありません。
UNKNOWN
エラーコードを既知のエラーコードにマッピングできませんでした。

FullScreenContentErrorCode

FullScreenContentErrorCode: typeof FullScreenContentErrorCode[keyof typeof FullScreenContentErrorCode]
プロパティ
AD_ALREADY_USED
広告はすでに表示されています。
AD_NOT_READY
広告を表示する準備ができていません。
AD_TOO_LARGE
広告がシーンに対して大きすぎる（iOS のみ）。
APP_NOT_FOREGROUND
アプリがフォアグラウンドにない。
INTERNAL_ERROR
内部で何らかの処理が発生しました。たとえば、広告コンテンツの表示準備中に例外が発生しました。
MEDIATION_ERROR
メディエーション アダプタが広告を表示できませんでした。根本原因については、FullScreenContentError.mediationAdError をご覧ください。
UNKNOWN
エラーコードを既知のエラーコードにマッピングできませんでした。

LoadAdErrorCode

LoadAdErrorCode: typeof LoadAdErrorCode[keyof typeof LoadAdErrorCode]
広告読み込みオペレーションの失敗のエラーコードを表します。
プロパティ
AD_ALREADY_USED
広告レスポンスはすでに広告の読み込みに使用されています。
APP_ID_MISSING
アプリケーション ID が指定されていないため、広告リクエストは送信されませんでした。
CANCELLED
広告リクエストがキャンセルされました（Android のみ）。
INTERNAL_ERROR
SDK 内で内部エラーが発生しました。
INVALID_REQUEST
広告リクエストが無効でした（広告ユニット ID が正しくない場合など）。
INVALID_RESPONSE
サーバー間広告レスポンスが無効です。たとえば、広告レスポンスにリクエスト ID がありません。
MEDIATION_ERROR
メディエーション アダプタが見つからなかったか、広告リクエストの実行に失敗しました。
NETWORK_ERROR
ネットワーク接続が原因で広告リクエストが失敗しました。
NO_FILL
広告リクエストは成功しましたが、広告インベントリの不足が原因で広告が返されませんでした。
TIMEOUT
広告リクエストがタイムアウトしました。
UNKNOWN
エラーコードを既知のエラーコードにマッピングできませんでした。

MaxAdContentRating

MaxAdContentRating: typeof MaxAdContentRating[keyof typeof MaxAdContentRating]
アプリの広告レーティングの上限を定義し、表示できる広告の種類を分類します。
プロパティ
G
ファミリーや子どもを含め、一般の視聴者に適したコンテンツ。
MA
成人向けコンテンツ。
PG
多くの視聴者に適したコンテンツですが、保護者の判断が推奨されます。
T
13 歳以上の視聴者に適したコンテンツです。
UNSPECIFIED
コンテンツのレーティングが指定されていません。

NativeAdAssetNames

NativeAdAssetNames: typeof NativeAdAssetNames[keyof typeof NativeAdAssetNames]
標準のネイティブ広告アセットの識別に使用される名前。
プロパティ
ADCHOICES_CONTAINER_VIEW
AdChoices オーバーレイのコンテナ。
ADVERTISER
広告主の名前。
BODY
広告のメインの本文テキスト。
CALL_TO_ACTION
広告の行動を促すフレーズのテキスト（「インストール」や「詳細」など）。
HEADLINE
広告の見出しまたはタイトル。
ICON
広告のアイコン画像。
MEDIA_CONTENT
広告のメイン メディア コンテンツ（画像または動画）。
PRICE
広告に掲載されているアプリまたは商品の価格。
STAR_RATING
広告に掲載されているアプリまたは商品の星評価。
STORE
ショップ名。

NativeAdType

NativeAdType: typeof NativeAdType[keyof typeof NativeAdType]
読み込まれたネイティブ広告のフォーマットを識別します。
プロパティ
BANNER
バナー広告。
CUSTOM_NATIVE
カスタム ネイティブ フォーマット広告。
NATIVE
ネイティブ広告。

NativeMediaAspectRatio

NativeMediaAspectRatio: typeof NativeMediaAspectRatio[keyof typeof NativeMediaAspectRatio]
返されるネイティブ広告メディアのアスペクト比に関する設定。
プロパティ
ANY
返されるネイティブ広告メディアのアスペクト比に優先度はありません。
LANDSCAPE
返されるネイティブ広告メディアのアスペクト比を横向きでリクエストします。
PORTRAIT
返されるネイティブ広告メディアのアスペクト比を縦向きでリクエストします。
SQUARE
返されるネイティブ広告メディアのアスペクト比を正方形でリクエストします。
UNKNOWN
アスペクト比が不明です。

OnAdInspectorClosedListener

OnAdInspectorClosedListener: ((error?) => void)
広告インスペクタの UI が閉じられたときに呼び出されるコールバックのインターフェース定義。

PrecisionType

PrecisionType: typeof PrecisionType[keyof typeof PrecisionType]
報告された広告価値の精度。
プロパティ
ESTIMATED
集計データから推定された広告の価値。
PRECISE
広告に支払われた正確な金額。
PUBLISHER_PROVIDED
パブリッシャーが指定した広告の価値（メディエーション グループ内の手動 CPM など）。
UNKNOWN
精度が不明な広告の価値。

PrivacyOptionsRequirementStatus

PrivacyOptionsRequirementStatus: typeof PrivacyOptionsRequirementStatus[keyof typeof PrivacyOptionsRequirementStatus]
プライバシー オプションの要件ステータス。
プロパティ
NOT_REQUIRED
プライバシー オプションのエントリ ポイントは必須ではありません。
REQUIRED
プライバシー オプションのエントリ ポイントは必須です。
UNKNOWN
プライバシー オプションの要件ステータスが不明です。

PublisherPrivacyPersonalizationState

PublisherPrivacyPersonalizationState: typeof PublisherPrivacyPersonalizationState[keyof typeof PublisherPrivacyPersonalizationState]
パブリッシャーのプライバシーに関する取り扱いのパーソナライズ ステータスを示します。
プロパティ
DEFAULT
広告リクエストにパブリッシャーのデフォルトのプライバシー処理を適用することを示します。
DISABLED
広告リクエストにパブリッシャーのプライバシーに関するパーソナライズされていない取り扱いを適用することを示します。
ENABLED
広告リクエストにパブリッシャーのプライバシーに関するパーソナライズされた取り扱いを適用することを示します。

ResizeMode

ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
NativeAdMediaView の画像コンテンツのサイズ変更モードをカスタマイズするためのオプション。
プロパティ
CONTAIN
ビュー内に収まるように均一に拡大縮小します。

画像の高さと幅が一緒に拡大縮小され、各ディメンションがビューの対応するディメンション以下になります。画像は、アスペクト比を歪ませたり、切り抜いたりすることなく、ビュー内に収まるようにスケーリングされます。
COVER
ビューを覆うように均等に拡大縮小します。

画像の高さと幅が一緒に拡大縮小され、各ディメンションがビューの対応するディメンション以上になります。画像は、アスペクト比を歪めることなくビューに収まるように切り抜かれます。
STRETCH
幅と高さを個別にスケーリングしてビューを埋めます。

画像の高さと幅が個別にスケーリングされ、ビューのサイズに合わせられます。画像は、切り抜きなしでビュー全体を埋めるようにスケーリングされますが、画像のアスペクト比は維持されません。

ResolvedAdSize

ResolvedAdSize: FixedAdSize | FluidAdSize
広告の読み込み後に解決された広告サイズの最終状態を表します。

ほとんどの広告では、正確な width と height のディメンションを持つ FixedAdSize に解決されます。サイズが動的に設定されるバナー広告の場合、これは FluidAdSize に解決されます。ここで、サイズはビュー階層によって管理されます。

SwipeGestureDirection

SwipeGestureDirection: typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
カスタム クリック スワイプ操作の指示。
プロパティ
DOWN
下にスワイプします。
LEFT
左にスワイプします。
RIGHT
右にスワイプします。
UP
上にスワイプします。

変数

AdSize

AdSize: {
  BANNER: FixedAdSize;
  custom: ((width, height) => FixedAdSize);
  FLUID: FluidAdSize;
  FULL_BANNER: FixedAdSize;
  getCurrentOrientationInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  getInlineAdaptiveBannerAdSize: ((width, maxHeight) => InlineAdaptiveAdSize);
  getLandscapeInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  getLargeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getLargeLandscapeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getLargePortraitAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getPortraitInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  LARGE_BANNER: FixedAdSize;
  LEADERBOARD: FixedAdSize;
  MEDIUM_RECTANGLE: FixedAdSize;
}
アダプティブ サイズとカスタム サイズを作成するための事前定義された広告サイズとヘルパー メソッド。

関数

canRequestAds

canRequestAds(): boolean
現在の同意ステータスで広告をリクエストできるかどうかを確認します。
戻り値
boolean 広告をリクエストできる場合は true、それ以外の場合は false。

getConsentStatus

getConsentStatus(): ConsentStatus
ユーザーの現在の同意ステータスを取得します。
戻り値
ConsentStatus 現在の同意ステータス。

getInitializationStatus

getInitializationStatus(): InitializationStatus
SDK の初期化ステータスを取得します。

このメソッドを使用して、SDK の初期化が完了したかどうかを確認し、個々のメディエーション アダプタのステータスを調べます。
戻り値
InitializationStatus 現在の初期化ステータス。

getPrivacyOptionsRequirementStatus

getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
アプリにプライバシー オプションのエントリ ポイントが必要かどうかを確認します。

エントリ ポイントが必要な場合は、showPrivacyOptionsForm を呼び出してプライバシー オプション フォームを表示する、表示可能で操作可能な UI 要素をアプリに追加します。エントリ ポイントが不要な場合は、UI 要素が非表示で操作できないように構成します。
戻り値
PrivacyOptionsRequirementStatus プライバシー オプションの要件ステータス。

getRequestConfiguration

getRequestConfiguration(): RequestConfiguration
グローバル リクエスト構成を取得します。

このメソッドを使用して、グローバルに適用されている現在のリクエスト構成を取得します。
戻り値
RequestConfiguration 現在のグローバル リクエスト構成。

initialize

initialize(config, onInitializationComplete?): void
Google Mobile Ads SDK を初期化します。

このメソッドは、広告を読み込む前、および Google Mobile Ads SDK の他の部分とやり取りする前に呼び出します。
パラメータ
config: InitializationConfig SDK の初期化を制御するオプション。
Optional onInitializationComplete: ((status) => void) SDK の初期化が完了したときに実行されるコールバック関数。

isConsentFormAvailable

isConsentFormAvailable(): boolean
同意フォームが利用可能かどうかを確認します。
戻り値
boolean 同意フォームが利用可能な場合は true、そうでない場合は false。

loadAndShowConsentFormIfRequired

loadAndShowConsentFormIfRequired(onDismissed?): void
現在の同意ステータスで同意フォームが必要な場合（ステータスが REQUIRED など）、同意フォームを読み込んでユーザーに表示します。
パラメータ
Optional onDismissed: ((error?) => void) フォームが閉じられたとき、またはフォームが不要な場合に呼び出されるコールバック関数。表示に失敗した場合は、オプションの FormError が渡されます。

openAdInspector

openAdInspector(_listener): void
Google Mobile Ads SDK の広告インスペクタ オーバーレイを開きます。

このメソッドを使用して、メディエーションの設定と広告ソースをデバッグします。
パラメータ
_listener: OnAdInspectorClosedListener

openDebugMenu

openDebugMenu(adUnitId): void
デバッグ メニューを開きます。

このメソッドを使用して、特定の広告ユニットのデバッグ メニューを開き、広告構成のテストとトラブルシューティングを行います。
パラメータ
adUnitId: string デバッグ メニューを開く広告ユニット ID。

parseLoadAdError

parseLoadAdError(error): LoadAdError
広告読み込み中にスローされたネイティブ エラーを解析し、LoadAdError でラップします。
パラメータ
error: unknown ネイティブ モジュールによってスローされるエラー オブジェクト。
戻り値
LoadAdError 解析された LoadAdError オブジェクト。

requestConsentInfoUpdate

requestConsentInfoUpdate(params?, onComplete?): void
同意情報の更新をリクエストします。

この API は、getConsentStatus を呼び出す前に、アプリのセッションごとに呼び出す必要があります。

この API が呼び出されると、getConsentStatus の戻り値が同期的に更新され、前のアプリ セッションの同意ステータス（存在する場合）が保持されます。

getConsentStatus は、onComplete コールバックが呼び出された後、最新のステータスに再度更新できます。
パラメータ
Optional params: ConsentRequestParameters デバッグとターゲティングのオプション構成。
Optional onComplete: ((error?) => void) 同意情報の更新が完了したときに呼び出されるコールバック関数。リクエストが失敗した場合は、FormError が返されます（省略可）。

reset

reset(): void
永続ストレージからすべての同意ステータスをクリアします。

デバッグ目的でのみ使用します。

setPublisherFirstPartyIdEnabled

setPublisherFirstPartyIdEnabled(enabled): void
パブリッシャーのファーストパーティ ID を有効にするかどうかを制御します。

Google Mobile Ads SDK のパブリッシャーのファーストパーティ ID（旧称「同一アプリキー」）を有効または無効にします。
関連情報
パラメータ
enabled: boolean パブリッシャーのファーストパーティ ID を有効にする場合は true、無効にする場合は false。デフォルトは true です。

setRequestConfiguration

setRequestConfiguration(_config): void
コンプライアンスとターゲティングのグローバル リクエスト設定を設定します。

このメソッドを使用して、広告レーティングの上限、年齢に応じた取り扱いタグなどのコンプライアンス設定、テストデバイス ID などのターゲティングの詳細を指定します。
パラメータ
_config: RequestConfiguration

setUserControlledAppVolume

setUserControlledAppVolume(volume): void
ユーザーが制御するアプリの音量を設定します。

このメソッドを使用して、デバイスの他の音声出力に対するすべての広告の音量を調整します。
パラメータ
volume: number 音量レベル（0.0（無音）～ 1.0（最大））。この範囲内の任意の浮動小数点値が有効です（0.001 や 0.33333 など）。値は、0.1 などの特定のステップサイズ増分に制限されません。

setUserMutedApp

setUserMutedApp(muted): void
アプリがミュートされているかどうかを設定します。

このメソッドを使用して、後続の広告の初期音声ミュート状態を制御します。
パラメータ
muted: boolean アプリケーションの音声をミュートするかどうか。デフォルトは false です。

showPrivacyOptionsForm

showPrivacyOptionsForm(onDismissed?): void
プライバシー オプション フォームを表示します。

getPrivacyOptionsRequirementStatus が REQUIRED の場合、プライバシー オプション フォームを表示します。

このメソッドは、プライバシー オプション フォームの表示をリクエストするユーザー入力に応じてのみ呼び出す必要があります。

プライバシー オプション フォームは、フォームが利用可能になったときに SDK によって自動的にプリロードされます。フォームがプリロードされていない場合、SDK は非同期でフォームを読み込もうとします。

ユーザーにフォームが表示され、オプションが選択されてフォームが閉じられた後、onDismissed コールバックが呼び出されます。次の場合、FormError を返すこともあります。
  • フォームは利用できません。
  • フォームが表示されません。
  • フォームはまだプリロード中です。
パラメータ
Optional onDismissed: ((error?) => void) フォームが閉じられたときに呼び出されるコールバック関数。表示が失敗した場合は、オプションの FormError が渡されます。