レスポンス・レンダラー
Ad Placement API のレスポンス JSON には、zones 配列と、renderers および userオブジェクトが含まれます。
このページではrenderersオブジェクトについて説明します。renderersオブジェクトは、ウェブページ上のさまざまなコンテナや広告を独立してレンダリングするために使用できます。
コンテナ・レンダラー
これらのレンダラーは、広告を表示するのに便利なさまざまなタイプのコンテナを生成するように設計されています。コンテナ レンダラーのレンダラー関数は、広告の配置に使用できるプレースホルダを含む配列を返します。
zone`オブジェクトに関しては、広告掲載レスポンスで受け取ったのと同じオブジェクトを渡すことができますが、zones.typeを渡す必要はないという違いがあります。
固定コンテナ・レンダラー
ページ上の位置を固定したコンテナをレンダリングするために使用する。
このスクリプトは window.FixedContainerRenderer 変数を公開します。例えば、window.FixedContainerRenderer.render(zone, placeholder); を呼び出すことで、ページ上にコンテナをレンダリングすることができます。
利用可能なレンダラー機能:。
| 機能 | パラメータ名 | 必須 | パラメータ 説明 |
|---|---|---|---|
render() | ゾーン | はい | レンダリング情報を含むゾーンオブジェクト |
| プレースホルダー | はい | コンテナをレンダリングする場所を示すHTML要素 | |
| クッキーコンセント | いいえ | ユーザーがクッキーに同意するかどうかを示すブール値 |
スティッキー・コンテナ・レンダラー
このスクリプトはwindow.StickyContainerRenderer変数を公開します。例えば、window.StickyContainerRenderer.render(zone, placeholder);を呼び出すことで、ページ上にコンテナをレンダリングすることができます。
利用可能なレンダラー機能:。
| 機能 | パラメータ名 | 必須 | パラメータ 説明 |
|---|---|---|---|
render() | ゾーン | はい | レンダリング情報を含むゾーンオブジェクト |
| プレースホルダー | はい | コンテナをレンダリングする場所を示すHTML要素 | |
| クッキーコンセント | いいえ | ユーザーがクッキーに同意するかどうかを示すブール値 | |
| setBorder()` | zoneId` | はい | ボーダーを設定するゾーンのID |
| 幅 | はい | ボーダーの幅 | |
| 色 | はい | ボーダーの色 | |
| removeBorder()` | zoneId` | はい | ボーダーを取り除くゾーンのID |
| setPosition()` | zoneId` | はい | ポジションを設定するゾーンのID |
| 水平位置 | はい | ゾーンの水平位置 | |
| 垂直位置 | はい | ゾーンの垂直位置 |
インスタントメッセージコンテナレンダラ
インスタント・メッセージ・コンテナをページに表示するために使用します。
このスクリプトは window.InstantMessageContainerRenderer 変数を公開します。例えば、window.InstantMessageContainerRenderer.render(zone, placeholder); を呼び出すことで、ページ上にコンテナをレンダリングすることができます。
利用可能なレンダラー機能:。
| 機能 | パラメータ名 | 必須 | パラメータ 説明 |
|---|---|---|---|
render() | ゾーン | はい | レンダリング情報を含むゾーンオブジェクト |
| プレースホルダー | はい | コンテナをレンダリングする場所を示すHTML要素 | |
| クッキーコンセント | いいえ | ユーザーがクッキーに同意するかどうかを示すブール値 |
モバイルインスタントメッセージコンテナレンダラ
モバイル用のインスタントメッセージコンテナをページに表示するために使用します。
このスクリプトは window.MobileInstantMessageContainerRenderer 変数を公開します。例えば、 window.MobileInstantMessageContainerRenderer.render(zone, placeholder); を呼び出すことで、ページ上にコンテナをレンダリングすることができます。
利用可能なレンダラー機能:。
| 機能 | パラメータ名 | 必須 | パラメータ 説明 |
|---|---|---|---|
render() | ゾーン | はい | レンダリング情報を含むゾーンオブジェクト |
| プレースホルダー | はい | コンテナをレンダリングする場所を示すHTML要素 | |
| クッキーコンセント | いいえ | ユーザーがクッキーに同意するかどうかを示すブール値 |
フルページ・インタースティシャル・コンテナ・レンダラ
デスクトップ用またはモバイル用のフルページ・インタースティシャル・コンテナをページ上にレンダリングするために使用します。
このスクリプトは window.FullpageInterstitialContainerRenderer 変数を公開します。例えば、 window.FullpageInterstitialContainerRenderer.render(zone, placeholder); を呼び出すことで、ページ上にコンテナをレンダリングすることができます。
利用可能なレンダラー機能:。
| 機能 | パラメータ名 | 必須 | パラメータ 説明 |
|---|---|---|---|
render() | ゾーン | はい | レンダリング情報を含むゾーンオブジェクト |
| プレースホルダー | はい | コンテナをレンダリングする場所を示すHTML要素 | |
| クッキーコンセント | いいえ | ユーザーがクッキーに同意するかどうかを示すブール値 |
グループ・コンテナ・レンダラ
このスクリプトはwindow.GroupContainerRenderer変数を公開します。例えば、window.GroupContainerRenderer.render(group, placeholder);を呼び出すことで、ページ上にコンテナをレンダリングすることができます。
利用可能なレンダラー機能:。
| 機能 | パラメータ名 | 必須 | パラメータ 説明 |
|---|---|---|---|
render() | グループ | はい | レンダリング情報を含むグループオブジェクト |
| プレースホルダー | はい | コンテナをレンダリングする場所を示すHTML要素 | |
| クッキーコンセント | いいえ | ユーザーがクッキーに同意するかどうかを示すブール値 |
コンテンツ・レンダラー
これらのレンダラーは、コンテナ内に広告を表示する役割を担っている。コンテナを必要としない自己完結型のものもあります。
バナー・コンテンツ・レンダラー
このスクリプトはwindow.BannerRenderer変数を公開し、それを使ってレンダラーと対話することができます。例えば、window.BannerRenderer.render(zone, placeholder);を呼び出すことで、広告をレンダリングすることができます。
利用可能なレンダラー機能:。
| 機能 | パラメータ名 | 必須 | パラメータ 説明 |
|---|---|---|---|
render() | ゾーン | はい | レンダリング情報を含むゾーンオブジェクト |
| プレースホルダー | はい | コンテナなど、広告を表示する場所を示すHTML要素。 | |
| クッキーコンセント | いいえ | ユーザーがクッキーに同意するかどうかを示すブール値 |
ネイティブ・コンテンツ・レンダラー
このスクリプトはwindow.NativeRenderer変数を公開し、それを使ってレンダラーと対話することができます。例えば、window.NativeRenderer.render(zone, placeholder);を呼び出すことで、広告をレンダリングすることができます。
利用可能なレンダラー機能:。
| 機能 | パラメータ名 | 必須 | パラメータ 説明 |
|---|---|---|---|
render() | ゾーン | はい | レンダリング情報を含むゾーンオブジェクト |
| プレースホルダー | はい | コンテナなど、広告を表示する場所を示すHTML要素。 | |
| クッキーコンセント | いいえ | ユーザーがクッキーに同意するかどうかを示すブール値 |
アウトストリーム・ビデオ・コンテンツ・レンダラー
このスクリプトは、window.OutstreamVideoRenderer 変数を公開します。たとえば、window.OutstreamVideoRenderer.render(zone, placeholder); を呼び出すことで、広告をレンダリングすることができます。
利用可能なレンダラー機能:。
| 機能 | パラメータ名 | 必須 | パラメータ 説明 |
|---|---|---|---|
render() | ゾーン | はい | レンダリング情報を含むゾーンオブジェクト |
| プレースホルダー | はい | コンテナなど、広告を表示する場所を示すHTML要素。 | |
| クッキーコンセント | いいえ | ユーザーがクッキーに同意するかどうかを示すブール値 |
ページ内プッシュ通知コンテンツ・レンダラー
このスクリプトはwindow.InPagePushNotificationRenderer変数を公開します。例えば、window.InPagePushNotificationRenderer.render(zone, placeholder);を呼び出すことで、広告をレンダリングすることができます。
利用可能なレンダラー機能:。
| 機能 | パラメータ名 | 必須 | パラメータ 説明 |
|---|---|---|---|
render() | ゾーン | はい | レンダリング情報を含むゾーンオブジェクト |
| プレースホルダー | はい | コンテナなど、広告を表示する場所を示すHTML要素。 | |
| クッキーコンセント | いいえ | ユーザーがクッキーに同意するかどうかを示すブール値 |