Skip to main content

実装方法

バナー広告はHTML属性のみで簡単に実装できます。別途関数呼び出しなしで広告枠がレンダリングされる際に自動的に広告がリクエストされます。
開発環境ではテストユニットIDを使用してください:PUBLIC_TEST_UNIT_ID_320_100

Data Attributes方式

data-adrop-unit属性を追加するだけでSDKが自動的に広告を読み込みます。

Data Attributes

string
必須
Ad Controlコンソールで作成したユニットID
string
string
デフォルト:"light"
テーマ設定(lightまたはdark) - ダークモード設定を参照
boolean
デフォルト:false
カスタムクリック処理の有効化 - trueに設定するとSDKが自動で目的地URLに移動せず、adClickedイベントのみ発生させます。開発者がクリック動作を直接実装できます。
string
デフォルト:"responsive"
バックフィル広告のレンダリングモード(responsive または fixed)。詳細はバックフィルレンダリングモードガイドを参照してください。(SDK 1.2.3+)
string
広告識別子 — デバイスで表示機能で登録済みテストデバイスからドラフトクリエイティブをプレビューするときに必要です。本番環境にハードコードしないでください。

広告の再リクエスト

広告枠DOMを新しく作成して既存DOMを置き換えると、広告が再リクエストされます。

renderAd方式

広告読み込みタイミングを直接制御したい場合に使用します。

renderAdオプション

string
必須
Ad Controlコンソールで作成したユニットID
string
ユーザー識別子(SDK設定値を個別の広告枠で上書きする場合に使用)
string
string
デフォルト:"light"
テーマ設定(lightまたはdark) - ダークモード設定を参照
boolean
デフォルト:false
カスタムクリック処理の有効化 - trueに設定するとSDKが自動で目的地URLに移動せず、adClickedイベントのみ発生させます。開発者がクリック動作を直接実装できます。
'responsive' | 'fixed'
デフォルト:"responsive"
バックフィル広告のレンダリングモード。詳細はバックフィルレンダリングモードガイドを参照してください。(SDK 1.2.3+)
string
広告識別子 — デバイスで表示機能で登録済みテストデバイスからドラフトクリエイティブをプレビューするときに必要です。本番環境にハードコードしないでください。

広告の再リクエスト

renderAd()を再度呼び出すと、広告が再リクエストされます。

広告の削除

clear()を呼び出してコンテナから広告を削除できます。

広告サイズ

推奨:レスポンシブな幅 + ユニット登録サイズと一致する aspect-ratio。枠が端末幅に合わせて伸縮し、高さは比率で固定されるため CLS が発生しません。
ピクセル単位の整列が必要な場合は固定ピクセルサイズもサポートします。
バックフィル広告のコンテナ作成パターンとレンダリングモードの選択基準はバックフィルレンダリングモードガイドを参照してください。

イベント処理

広告の状態変化を検出して、適切なUI処理ができます。

サポートするイベント

イベントリスナーの解除

不要になったイベントリスナーはoff()で解除してください。

AdData

イベントハンドラーで受け取る広告データです。詳細なフィールド情報はリファレンス > AdDataを参照してください。

カスタムクリック処理

useCustomClickが有効化されるとSDKが自動で目的地URLに移動しません。代わりにクリックイベントを処理してカスタム動作を実装できます。
カスタムクリック処理が有効化されると、ユーザーが広告をクリックしたときの動作を完全に制御できます。destinationURLadClickedイベントデータに含まれて提供されます。

完全なサンプル