For the complete documentation index, see llms.txt. This page is also available as Markdown.

レスポンスゾーン

Ad Placement API の応答 JSON には ゾーン 配列と レンダラー および ユーザー オブジェクトです。

このページでは、 ゾーン 配列には、広告リクエストで勝ち取った広告に関するすべての詳細が含まれます。

この配列には、要求された各ゾーンIDの広告データを含むオブジェクトが入っています。

プロパティ
説明

idzone

広告ゾーンのID。

type

使用される広告フォーマット。例: banner.

data

広告データ(オブジェクト)

以下に、各 data 利用可能な広告フォーマットに応じたオブジェクトの詳細なプロパティ一覧を示します。

バナー

プロパティ
説明

url

広告の遷移先URL。

impression

インプレッションURL

image

広告用にアップロードされた元の画像。

optimum_image

アップロードされたクリエイティブがアニメーションGIFの場合、広告で使用するために作成された最適化済みのMP4版です。

width

広告の幅(ピクセル)。

height

広告の高さ(ピクセル)。

media

これはどの種類のバナーかを示します。画像、HTML、または動画です。該当するのは img_banner, html_banner または video_bannerそれぞれです。

バナー応答の例

画像バナー:

HTMLバナー:

動画バナー:

スティッキーバナー

プロパティ
説明

url

クリックURL

impression

インプレッションURL

image

広告用にアップロードされた元の画像。

optimum_image

スティッキーバナーでは、アップロードされたクリエイティブがアニメーションGIFの場合、広告で使用するために作成された最適化済みのMP4版です。

width

広告の幅(ピクセル)。

height

広告の高さ(ピクセル)。

frequency_period

広告が何分ごとに表示されるか。

v_pos

広告の縦方向の位置。

h_pos

広告の横方向の位置。

media

これはどの種類のバナーかを示します。画像、HTML、または動画です。該当するのは img_banner, html_banner、または video_banner それぞれ。

スティッキーバナー応答の例

インスタントメッセージ

プロパティ
説明

url

クリックURL

impression

インプレッションURL

image

画像のURL

optimum_image

アップロードされたクリエイティブがアニメーションGIFの場合、広告で使用するために作成された最適化済みのMP4版です。

width

広告の幅(ピクセル)。

height

広告の高さ(ピクセル)。

frequency_period

広告が何分ごとに表示されるか。

media

これはどの種類のバナーが使用されているかを示します。画像、HTML、または動画です。該当するのは img_banner, html_banner、または video_banner それぞれ。

インスタントメッセージ応答の例

ネイティブ広告

応答がネイティブ広告を返す場合、zones.data は2つのオブジェクトを返します。 layout および ad_items

data.layout

プロパティ
説明

widgetHeaderContentHtml

表示される「Powered by」ブランディングのURL。*

branding_logo

有効な場合に表示されるブランディングロゴのURL。*

branding_logo_hover

ユーザーがホバーしたときに表示されるブランディングロゴのURL。*

itemsPerRow

ウィジェットの各行に表示される広告数。

itemsPerCol

ウィジェットの各列に表示される広告数。

font_family

広告で使用されるフォントファミリー。

header_font_size

ブランディングヘッダーに使用されるフォントサイズ。

header_font_color

ブランディングヘッダーに使用されるフォント色。

widget_background_color

ウィジェットに使用される背景色の16進コード。

widget_width

ウィジェット全体の幅。

minimum_width_for_full_sized_layout

フルサイズレイアウトの最小幅(ピクセル)。

item_height

各広告の高さ。

item_padding

各広告間の余白。

image_height

各広告内の画像の高さ。

image_width

各広告内の画像の幅。

text_margin_top

上部テキストマージンのピクセルサイズ。

text_margin_bottom

下部テキストマージンのピクセルサイズ。

text_margin_left

左側テキストマージンのピクセルサイズ。

text_margin_right

右側テキストマージンのピクセルサイズ。

title_font_size

各広告のタイトルのフォントサイズ。

title_font_color

各広告のタイトルのフォント色。

title_font_weight

各広告のタイトルのフォントの太さ。

title_decoration

タイトルに下線があるかどうか。

title_hover_color

ホバー時のタイトルのフォント色。

title_hover_font_weight

ホバー時のタイトルのフォントの太さ。

title_hover_decoration

ホバー時にタイトルに下線が付くかどうか。

description_font_size

各広告の説明文のフォントサイズ。

description_font_color

各広告の説明文のフォント色。

description_font_weight

各広告の説明文のフォントの太さ。

description_decoration

説明文に下線があるかどうか。

description_hover_color

ホバー時の説明文のフォント色。

description_hover_font_weight

ホバー時の説明文のフォントの太さ。

description_hover_decoration

ホバー時に説明文に下線が付くかどうか。

open_in_new_window

クリック時に広告を新しいウィンドウで開くかどうか。1=はい、0=いいえ。

mobile_responsive_type

モバイルデバイス使用時のレスポンシブの種類(none または compact)。1=compact、0=なし。

header_is_on_top

ブランディングを広告の上または下に表示するかどうか。1=はい、0=いいえ。

header_text_align

ブランディングヘッダーの水平方向の配置。

title_enabled

タイトルが有効かどうか。1=はい、0=いいえ。

description_enabled

説明文が有効かどうか。1=はい、0=いいえ。

image_border_size

画像枠のサイズ(ピクセル)。

image_border_color

画像枠の16進色コード。

text_align

テキストの配置:left、center、right。

customcss_enabled

カスタムCSSが有効かどうか。1=はい、0=いいえ。

customcss

有効な場合、カスタムCSSがここに表示されます。

header_enabled

ヘッダーが有効かどうか。1=はい、0=いいえ。

mobile_breakpoint

広告ゾーンのデスクトップ表示とモバイル表示の切り替え位置(ピクセル)。

spacing_v

詳細オプションで設定する、広告間の垂直方向の間隔(ピクセル)。

spacing_h

詳細オプションで設定する、広告間の水平方向の間隔(ピクセル)。

zoom

ホバー時に広告が拡大/縮小するかどうか。

mobile_rows

モバイルウィジェット内の広告の行数。

mobile_cols

モバイルウィジェット内の広告の列数。

use_v2_script

この広告ゾーンが新しいV2設定で作成されたか、古いv1設定で作成されたか。

text_enabled

テキストのタイトルと説明文を表示するかどうか。1=はい、0=いいえ。

mobile_image_width

モバイルでの各広告画像の幅。

mobile_text_box_size

モバイル時のテキストボックスサイズ。有効範囲は50〜500です。

mobile_text_enabled

モバイルでタイトルが有効かどうか。1=はい、0=いいえ。

mobile_text_position

モバイルでのテキスト位置:下または右。

item_spacing_on_each_side

古いv1設定で構成された広告の各側の余白。

text_position

テキストが左側または右側のどちらに配置されるか。

text_box_size

テキストボックスのサイズ(ピクセル)。範囲は50〜500です。

widget_height

ウィジェット全体の高さ。

brand_enabled

ブランディングが有効かどうか。

brand_font_size

ブランディングのフォントサイズ。

brand_font_color

ブランディングのフォント色。

brand_font_weight

ブランディングのフォントの太さ。

brand_decoration

フォントに下線があるかどうか。

mobile_image_height

モバイルでの各広告画像の高さ。

publisherAdType

これはどのタイプのネイティブ広告か、つまり recommendation、exit、または interstitial です: native-recommendation, native-interstitial.

data.ad_items

プロパティ
説明

idvariation

バリエーションのID。

image

広告用にアップロードされた元の画像。

url

クリックURL。

impression

インプレッションURL。

title

広告のタイトルテキスト。

description

広告の説明文。

brand

広告のブランドテキスト。

original_url

ランディングページの元のURL。

image_position

広告画像の位置(画像のトリミング方法)。

size

選択された広告フォーマットのサイズ

iframe_url

バリエーションとして iframe が使用される場合、その iframe のURLです。

video_thumb_id

広告クリエイティブに関連付けられた動画サムネイルアセットの識別子(存在する場合)。

video_thumb_url

動画サムネイルアセットのURL(存在する場合)。

video_thumb_enabled

動画サムネイルアセットのステータス(存在する場合)。

ネイティブ広告応答の例

アウトストリーム動画

プロパティ
説明

url

クリックURL

トラッキング

トラッキング情報を含むオブジェクト。

動画

読み込む動画広告ファイルまたはVASTリンク。

brandingEnabled

ブランディングを有効にするフラグ。 この値は現在使用されていません

frequencyPeriod

広告が何分ごとに表示されるか。

maximumWidth

動画の幅サイズ。

isVast

勝利したキャンペーンが通常の動画広告(false)かVASTリンクキャンペーン(true)かを示します。

ctaEnabled

広告にCTAを表示するフラグ

cta

CTAの詳細を含むオブジェクト

impression

インプレッションURL

data.tracking

現時点では、 data.tracking オブジェクトは次のもののみを返します progress 動画の再生を追跡するためのオブジェクトの配列です。これらのオブジェクトのうち、 "offset": "00:00:10.000" 動画視聴を記録するために呼び出すのはこれです。各オブジェクトのプロパティは以下で説明します:

プロパティ
説明

offset

動画広告の再生時間に対する秒数または割合での進捗マーカー

url

トラッキングURL

data.cta

プロパティ
説明

displayUrl

広告のランディングページに関連するURL

テキスト

CTA要素で使用されるテキスト

アウトストリーム動画のレスポンス例

ビデオスライダー

プロパティ
説明

url

クリックURL

トラッキング

トラッキング情報を含むオブジェクト。

動画

読み込む動画広告ファイルまたはVASTリンク。

screenDensity

ユーザーのデバイス上で広告が占める最大画面領域の割合を示す整数

onComplete

動画の再生が終了した後の広告の動作を示します。「hide」は広告を非表示にし、「repeat」はユーザーが再生し直せるよう広告をページに残します

closeAfter

広告に閉じるボタンが表示されるまでに必要な秒数を示します

brandingEnabled

ブランディングを有効にするフラグ。 このプロパティは現在使用されていません

frequencyPeriod

広告が何分ごとに表示されるか。

impression

インプレッションURL

isVast

勝利したキャンペーンが通常の動画広告(false)かVASTリンクキャンペーン(true)かを示します。

ctaEnabled

広告にCTAを表示するフラグ

cta

CTAの詳細を含むオブジェクト

data.tracking

現時点では、 data.tracking オブジェクトは次のもののみを返します progress 動画の再生を追跡するためのオブジェクトの配列です。これらのオブジェクトのうち、 "offset": "00:00:10.000" 動画視聴を記録するために呼び出すのはこれです。各オブジェクトのプロパティは以下で説明します:

プロパティ
説明

offset

動画広告の再生時間に対する秒数または割合での進捗マーカー

url

トラッキングURL

data.cta

プロパティ
説明

displayUrl

広告のランディングページに関連するURL

テキスト

CTA要素で使用されるテキスト

ビデオスライダーのレスポンス例

フルページインタースティシャル

プロパティ
説明

url

クリックURL

impression

インプレッションURL

image

広告用にアップロードされた元の画像。

optimum_image

アップロードされたクリエイティブがアニメーションGIFの場合、広告で使用するために作成された最適化済みのMP4版です。

width

広告の幅(ピクセル)。

height

広告の高さ(ピクセル)。

frequency_count

広告を表示できる回数

frequency_period

広告が何分おきに表示されるか

frequency_trigger_type

この広告の頻度がインプレッション(0)またはクリック(1)に基づくかを示すフラグ

ad_trigger_method

この広告ゾーンで有効なトリガー方法

ad_trigger_classes

広告を発火させるクラス(ある場合)

first_trigger_clicks

初回訪問時に広告を発火させるために必要なクリック数

next_trigger_clicks

広告を再表示するために、最初の発火後に必要なクリック数

chrome_enabled

この広告ゾーンがChromeで有効(1)、無効(0)、またはこのブラウザ専用で有効(2)かを示すフラグ

capping_enabled

この広告ゾーンにキャッピングを適用するかどうかを示すフラグ

media

これはどの種類のバナーかを示します。画像、HTML、または動画です。該当するのは img_banner, html_banner または video_bannerそれぞれです。

注: フルページインタースティシャルのレスポンスのプロパティの多くは、広告のキャッピングとトリガーに関連しています。広告の描画はあなたの責任なので、これらのプロパティを考慮するかどうかはあなた次第です。

フルページインタースティシャルのレスポンス例

例ではデスクトップのフルページインタースティシャルを示していますが、モバイルのフルページインタースティシャルのレスポンスも zone.type を除けば同じである必要があります。

ページ内プッシュ

プロパティ
説明

url

クリックURL

impression

インプレッションURL

image

広告用にアップロードされた元の画像。

optimum_image

アップロードされたクリエイティブがアニメーションGIFの場合、広告で使用するために作成された最適化済みのMP4版です。

title

通知のタイトル

description

通知の説明

horizontal_position

ページ上の水平方向の位置を示します(左、中央、右)

vertical_position

ページ上の垂直方向の位置を示します(上、中央、下)

delay

ページ読み込み後、通知が表示されるまでの秒数

max_notifications_on_page

同時にページ上に表示できる通知の数

once_closed_hide_for

閉じた後に広告が非表示になる秒数(ユーザーのクッキー同意が必要)

user_session_capping

ユーザーに広告が表示される回数(ユーザーのクッキー同意が必要)

delay_between_notifications

前の通知が読み込まれてから次の通知が表示されるまでの秒数

ページ内プッシュ通知のレスポンス例

マルチフォーマット

マルチフォーマットのリクエストへのレスポンスは、異なる結果を返す場合があります:

プロパティ
説明

orientation

マルチゾーンレイアウトの向き。"horizontal" または "vertical" になります

ad_items

レイアウトの各枠の広告データを含む配列。

結果にかかわらず、プロパティ multizoneid がレスポンスに追加され、このレスポンスが対応するマルチフォーマット広告ゾーンのゾーンIDを示します。

マルチフォーマットのレスポンス例

次の例は ゾーン 、マルチフォーマット広告ゾーンのオブジェクトを示しています。 横3列 のレイアウトです:

レスポンシブディスプレイ広告

バナーやフルページインタースティシャルなどの一部のフォーマットでは、 レスポンシブディスプレイ広告 元の広告フォーマットからの需要に加えて、ネイティブ広告キャンペーンからの需要を受け取れるようにできます。このような場合、レスポンスには original_zone 元のフォーマットの種類とデータを示すオブジェクトが含まれます。

バナー広告フォーマットの例です:

インプレッションのトラッキング

インプレッションURLに対してGETリクエストを行い、広告リクエストのインプレッションを記録してください。これを実現する方法の一つは、インプレッションURLをソースとして不可視の画像ファイルを、広告が表示されるページ上に作成することです。例:

最終更新

役に立ちましたか?