レスポンスレンダラー

Ad Placement API のレスポンス JSON には、 zones 配列と レンダラー と user オブジェクトが含まれます。

このページでは、 レンダラー オブジェクトについて説明します。このオブジェクトは、Webページ上で異なるコンテナや広告を個別にレンダリングするために使用できます。

コンテナレンダラー

これらのレンダラーは、広告を便利に表示できるさまざまな種類のコンテナを生成するように設計されています。コンテナレンダラーの render 関数は、広告を配置するために使用できるプレースホルダーの配列を返します。

〜については zone オブジェクトでは、Ad Placement のレスポンスで受け取ったのと同じオブジェクトを渡せます。ただし、渡す必要がない点が異なります zones.type.

固定コンテナレンダラー

ページ上の固定位置にあるコンテナをレンダリングするために使用します。

このスクリプトは window.FixedContainerRenderer 変数を公開します。この変数を使ってレンダラーを操作できます。たとえば、 window.FixedContainerRenderer.render(zone, placeholder); を呼び出すことで、ページ上にコンテナをレンダリングできます。

利用可能なレンダラー関数:

関数	パラメータ名	必須	パラメータの説明
render()	zone	はい	レンダリング用の情報を含む zone オブジェクト
	placeholder	はい	コンテナをどこにレンダリングするかを示す HTML 要素
	cookieConsent	いいえ	ユーザーが Cookie に同意しているかを示す真偽値

スティッキーコンテナレンダラー

このスクリプトは window.StickyContainerRenderer 変数を公開します。この変数を使ってレンダラーを操作できます。たとえば、 window.StickyContainerRenderer.render(zone, placeholder); を呼び出すことで、ページ上にコンテナをレンダリングできます。

利用可能なレンダラー関数:

関数	パラメータ名	必須	パラメータの説明
render()	zone	はい	レンダリング用の情報を含む zone オブジェクト
	placeholder	はい	コンテナをどこにレンダリングするかを示す HTML 要素
	cookieConsent	いいえ	ユーザーが Cookie に同意しているかを示す真偽値
setBorder()	zoneId	はい	境界線を設定する zone の ID
	width	はい	境界線の幅
	color	はい	境界線の色
removeBorder()	zoneId	はい	境界線を削除する zone の ID
setPosition()	zoneId	はい	位置を設定する zone の ID
	horizontalPosition	はい	zone の水平位置
	verticalPosition	はい	zone の垂直位置

インスタントメッセージコンテナレンダラー

ページ上にインスタントメッセージコンテナをレンダリングするために使用します。

このスクリプトは window.InstantMessageContainerRenderer 変数を公開します。この変数を使ってレンダラーを操作できます。たとえば、 window.InstantMessageContainerRenderer.render(zone, placeholder); を呼び出すことで、ページ上にコンテナをレンダリングできます。

利用可能なレンダラー関数:

関数	パラメータ名	必須	パラメータの説明
render()	zone	はい	レンダリング用の情報を含む zone オブジェクト
	placeholder	はい	コンテナをどこにレンダリングするかを示す HTML 要素
	cookieConsent	いいえ	ユーザーが Cookie に同意しているかを示す真偽値

モバイルインスタントメッセージコンテナレンダラー

ページ上にモバイル向けのインスタントメッセージコンテナをレンダリングするために使用します。

このスクリプトは window.MobileInstantMessageContainerRenderer 変数を公開します。この変数を使ってレンダラーを操作できます。たとえば、 window.MobileInstantMessageContainerRenderer.render(zone, placeholder); を呼び出すことで、ページ上にコンテナをレンダリングできます。

利用可能なレンダラー関数:

関数	パラメータ名	必須	パラメータの説明
render()	zone	はい	レンダリング用の情報を含む zone オブジェクト
	placeholder	はい	コンテナをどこにレンダリングするかを示す HTML 要素
	cookieConsent	いいえ	ユーザーが Cookie に同意しているかを示す真偽値

フルページインタースティシャルコンテナレンダラー

ページ上にデスクトップまたはモバイル向けのフルページインタースティシャルコンテナをレンダリングするために使用します。

このスクリプトは window.FullpageInterstitialContainerRenderer 変数を公開します。この変数を使ってレンダラーを操作できます。たとえば、 window.FullpageInterstitialContainerRenderer.render(zone, placeholder); を呼び出すことで、ページ上にコンテナをレンダリングできます。

利用可能なレンダラー関数:

関数	パラメータ名	必須	パラメータの説明
render()	zone	はい	レンダリング用の情報を含む zone オブジェクト
	placeholder	はい	コンテナをどこにレンダリングするかを示す HTML 要素
	cookieConsent	いいえ	ユーザーが Cookie に同意しているかを示す真偽値

グループコンテナレンダラー

このスクリプトは window.GroupContainerRenderer 変数を公開します。この変数を使ってレンダラーを操作できます。たとえば、 window.GroupContainerRenderer.render(group, placeholder); を呼び出すことで、ページ上にコンテナをレンダリングできます。

利用可能なレンダラー関数:

関数	パラメータ名	必須	パラメータの説明
render()	group	はい	レンダリング用の情報を含む group オブジェクト
	placeholder	はい	コンテナをどこにレンダリングするかを示す HTML 要素
	cookieConsent	いいえ	ユーザーが Cookie に同意しているかを示す真偽値

コンテンツレンダラー

これらのレンダラーは、コンテナ内に広告を表示する役割を担います。中には単体で動作し、コンテナを必要としないものもあります。

バナーコンテンツレンダラー

このスクリプトは window.BannerRenderer 変数を公開します。この変数を使ってレンダラーを操作できます。たとえば、 window.BannerRenderer.render(zone, placeholder); 広告をレンダリングできます。

利用可能なレンダラー関数:

関数	パラメータ名	必須	パラメータの説明
render()	zone	はい	レンダリング用の情報を含む zone オブジェクト
	placeholder	はい	コンテナなど、広告をどこにレンダリングするかを示す HTML 要素
	cookieConsent	いいえ	ユーザーが Cookie に同意しているかを示す真偽値

ネイティブコンテンツレンダラー

このスクリプトは window.NativeRenderer 変数を公開します。この変数を使ってレンダラーを操作できます。たとえば、 window.NativeRenderer.render(zone, placeholder); 広告をレンダリングできます。

利用可能なレンダラー関数:

関数	パラメータ名	必須	パラメータの説明
render()	zone	はい	レンダリング用の情報を含む zone オブジェクト
	placeholder	はい	コンテナなど、広告をどこにレンダリングするかを示す HTML 要素
	cookieConsent	いいえ	ユーザーが Cookie に同意しているかを示す真偽値

アウトストリーム動画コンテンツレンダラー

このスクリプトは window.OutstreamVideoRenderer 変数を公開します。この変数を使ってレンダラーを操作できます。たとえば、 window.OutstreamVideoRenderer.render(zone, placeholder); 広告をレンダリングできます。

利用可能なレンダラー関数:

関数	パラメータ名	必須	パラメータの説明
render()	zone	はい	レンダリング用の情報を含む zone オブジェクト
	placeholder	はい	コンテナなど、広告をどこにレンダリングするかを示す HTML 要素
	cookieConsent	いいえ	ユーザーが Cookie に同意しているかを示す真偽値

ページ内プッシュ通知コンテンツレンダラー

このスクリプトは window.InPagePushNotificationRenderer 変数を公開します。この変数を使ってレンダラーを操作できます。たとえば、 window.InPagePushNotificationRenderer.render(zone, placeholder); 広告をレンダリングできます。

利用可能なレンダラー関数:

関数	パラメータ名	必須	パラメータの説明
render()	zone	はい	レンダリング用の情報を含む zone オブジェクト
	placeholder	はい	コンテナなど、広告をどこにレンダリングするかを示す HTML 要素
	cookieConsent	いいえ	ユーザーが Cookie に同意しているかを示す真偽値