翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
クライアント側の広告追跡スキーマとプロパティ
MediaTailor クライアント側の広告追跡機能を使用すると、詳細なクライアント側の広告追跡データをプレイヤー環境に統合できます。以下のセクションでは、広告追跡スキーマ全体と、スキーマを構成する特定のプロパティと値について説明します。
Schema
次の JSON 構造は、MediaTailor クライアント側の広告追跡スキーマを示しています。この表現は、異なるパート間の関係を理解するのに役立つスキーマのネスト構造を示しています。
各プロパティの詳細については、「」を参照してくださいプロパティ。
{ "avails": [ { "ads": [ { "adID": "string", "adParameters": "string", "adSystem": "string", "adTitle": "string", "adVerifications": [ { "executableResource": [ { "apiFramework": "string", "type": "string", "uri": "string", "language": "string" } ], "javaScriptResource": [ { "apiFramework": "string", "browserOptional": "string", "uri": "string" } ], "trackingEvents": [ { "event": "string", "uri": "string" } ], "vendor": "string", "verificationParameters": "string" } ], "companionAds": [ { "adParameters": "string", "altText": "string", "attributes": { "adSlotId": "string", "apiFramework": "string", "assetHeight": "string", "assetWidth": "string", "expandedHeight": "string", "expandedWidth": "string", "height": "string", "id": "string", "pxratio": "string", "renderingMode": "string", "width": "string" }, "companionClickThrough": "string", "companionClickTracking": "string", "htmlResource": "string", "iFrameResource": "string", "sequence": "string", "staticResource": "string", "trackingEvents": [ { "event": "string", "uri": "string" } ] } ], "creativeId": "string", "creativeSequence": "string", "duration": "string", "durationInSeconds": number, "extensions": [ { "type": "string", "content": "string" } ], "icons": [ { "attributes": { "apiFramework": "string", "duration": "string", "height": "string", "offset": "string", "program": "string", "pxratio": "string", "width": "string", "xPosition": "string", "yPosition": "string" }, "htmlResource": "string", "iconClicks": { "iconClickThrough": "string", "iconClickTracking": { "id": "string" }, "iconClickFallbackImages": [ { "altText": "string", "height": "string", "width": "string", "staticResource": { "creativeType": "string", "uri": "string" } } ] }, "iconViewTracking": "string", "iFrameResource": "string", "staticResource": { "creativeType": "string", "uri": "string" } } ], "mediaFiles": { "adParameters": "string", "duration": "string", "durationInSeconds": number, "mediaFilesList": [ { "apiFramework": "string", "delivery": "string", "height": "string", "maintainAspectRatio": "string", "mediaFileUri": "string", "mediaType": "string", "scalable": "string", "width": "string", "bitrate": "string" } ], "mezzanine": "string", "startTime": "string", "startTimeInSeconds": number, "trackingEvents": [ { "beaconUrls": ["string"], "duration": "string", "durationInSeconds": number, "dateTime": "string", "eventId": "string", "eventType": "string", "startTime": "string", "startTimeInSeconds": number } ] }, "startTime": "string", "startTimeInSeconds": number, "dateTime": "string", "adBreakTrackingEvents": [...], "vastAdId": "string" } ], "adType": "string", "availID": "string", "duration": "string", "durationInSeconds": number, "startTime": "string", "startTimeInSeconds": number, "dateTime": "string", "adMarkerDuration": "string", "adProgramDateTime": "string", "dashAvailabilityStartTime": "string", "hlsAnchorMediaSequenceNumber": "string" } ], "nonLinearAvails": [ { "nonLinearAds": [...], "nonLinearAdsList": [...] } ], "nextToken": "string", "meta": {} }
プロパティ
次の表に、クライアント側の追跡 API のプロパティ、その定義、値タイプ、および例を示します。
プロパティ | 定義 | 値のタイプ | 例 |
---|---|---|---|
adID
|
パス: VAST マッピング: なし |
String | 10 |
adBreakTrackingEvents
|
VAST レスポンスから VMAP 追跡イベントを保持する配列。詳細については、VMAP 1.0 仕様のセクション 2.3.3 パス: |
配列 |
[]
|
adMarkerDuration
|
マニフェストの広告マーカーから観測された表示期間。 |
String |
30
|
adParameters
|
MediaTailor がプレイヤーに渡す VAST VPAID からの広告パラメータの文字列。 パス: VAST マッピング: |
String | |
adProgramDateTime
|
|
String | |
ads
|
表示を構成する広告オブジェクトを含む配列。広告はマニフェストに表示される順序で一覧表示されます。 パス: |
配列 |
[]
|
adSystem
|
広告を提供するシステムの名前。 重要必ず値を指定してください。値を指定しない場合、問題が発生する可能性があります。 |
String |
myADS
|
adTitle
|
広告のタイトル。 |
String |
ad1
|
adVerifications
|
クリエイティブ再生を検証するためにサードパーティーの測定コードを実行するために必要なリソースとメタデータが含まれています。このプロパティの詳細については、VAST 4.2 仕様 MediaTailor は VAST 3 拡張ノード パス: VAST マッピング: |
配列 |
[]
|
altText
|
コンパニオン広告のイメージの代替テキスト。このテキストにより、視覚障害者がイメージの説明を読み返すための記述的オーディオサポートを持つプレイヤーが可能になります。 パス: |
String |
video sequence advertising sneakers
|
apiFramework
|
この広告が VPAID 広告であることをプレイヤーに伝える スキーマ内の複数の場所に表示できます。 |
String |
VPAID
|
availID
|
パス: |
String |
|
avails
|
アクティブなマニフェストウィンドウに表示される広告ブレークオブジェクトまたは表示を含む配列。表示は、マニフェストに表示される順序で一覧表示されます。 パス: |
配列 |
[]
|
adType
|
広告のタイプ。 パス: |
String | |
dateTime
|
広告表示または広告の開始を ISO 8601 秒形式でプログラムする日時。 パス: |
String | |
duration
|
長さ、ISO 8601 秒形式。レスポンスには、広告表示全体と各広告とビーコンの期間が含まれますが、ビーコンの期間は常にゼロです。 パス: |
String | 15.015 |
durationInSeconds
|
長さ、秒形式。 パス: |
数値 | |
extensions
|
広告サーバーが使用する VAST のカスタム拡張機能。拡張機能の詳細については、VAST 4.2 仕様 パス: VAST マッピング: |
配列 | [] |
icons
|
広告のアイコン要素。 パス: VAST マッピング: |
配列 | |
mediaFiles
|
プレイヤーが広告表示に必要とする動画やその他のアセット。 パス: |
オブジェクト | |
nonLinearAvails
|
非線形広告表示オブジェクトの配列。 パス: |
配列 | |
executableResource
|
検証用の実行可能リソース。 パス: VAST マッピング: |
配列 | |
javaScriptResource
|
検証用の JavaScript リソース。 パス: VAST マッピング: |
配列 | |
trackingEvents
|
検証広告またはコンパニオン広告のイベントを追跡します。 パス: |
配列 | |
vendor
|
検証ベンダー。 パス: VAST マッピング: |
String | |
uri
|
実行可能アセット、ビデオアセット、または追跡エンドポイントを指す URI。 パス: スキーマ内のさまざまな場所 VAST マッピング: VAST のさまざまな CDATA 要素 |
String | https://tracking.example.com/impression |
verificationParameters
|
検証パラメータ。 パス: VAST マッピング: |
String | |
attributes
|
ディメンションやレンダリングモードなどのコンパニオン広告属性。 パス: |
オブジェクト | |
companionClickThrough
|
視聴者がコンパニオン広告をクリックしたときにメディアプレーヤーが開く、広告主のページへの URL。 パス: VAST マッピング: |
String | https://aws.amazon.com/ |
companionClickTracking
|
パス: VAST マッピング: |
String | https://myads.com/beaconing/event=clicktracking |
htmlResource
|
ストリーミングプロバイダーの HTML ページに直接挿入される CDATA エンコードされた HTML。 パス: VAST マッピング: |
String | <![CDATA[<!doctype html><html><head><meta name=\"viewport\" content=\"width=1, initial-scale=1.0, minimum-scale=1.0,...]]> |
iFrameResource
|
ストリーミングプロバイダーが iframe にロードする HTML リソースファイルの URL。 パス: VAST マッピング: |
String | |
sequence
|
VAST レスポンスでクリエイティブに指定されたシーケンス値。 パス: |
String | 1 |
startTime
|
ISO 8601 秒形式の時間位置。HLS の場合、これは再生セッションの開始を基準としています。DASH の場合、これはマニフェストの AST (可用性の開始時刻) を基準としています。レスポンスには、ad avail 全体、および各広告とビーコンの開始時間が含まれます。 パス: |
String | PT18.581355S |
startTimeInSeconds
|
秒形式の時間位置。HLS の場合、これは再生セッションの開始を基準としています。DASH の場合、これはマニフェストの AST (可用性の開始時刻) を基準としています。レスポンスには、ad avail 全体、および各広告とビーコンの開始時間が含まれます。 パス: |
数値 | 18.581 |
eventId
|
|
String | |
event
|
追跡イベントの名前。 パス: |
String | impression , start , firstQuartile , midpoint , thirdQuartile , complete |
beaconUrls
|
MediaTailor が広告ビーコンを送信する URL。 パス: |
配列 | |
bitrate
|
ビデオアセットのビットレート。このプロパティは通常、実行可能アセットには含まれません。 |
String | 2048 |
companionAds
|
1 つ以上のコンパニオン広告コンテンツ仕様。それぞれが使用するリソースファイルを指定します。コンパニオン広告は広告表示に付随し、広告のフレームやバナーなどのコンテンツを動画の近くに表示します。 パス: |
配列 | [] |
creativeId
|
広告の |
String | creative-1 |
creativeSequence
|
VAST レスポンス |
String | 1 |
dashAvailabilityStartTime
|
ライブ/動的 DASH の場合、オリジンマニフェスト |
String | 2022-10-05T19:38:39.263Z |
delivery
|
|
String | progressive |
eventType
|
ビーコンのタイプ。 パス: |
String | impression |
height
|
ビデオアセットの高さをピクセル単位で示します。 |
String | 360 |
hlsAnchorMediaSequenceNumber
|
HLS オリジンマニフェストに表示される最初/最も古いメディアシーケンスのメディアシーケンス番号。 |
String | 77 |
maintainAspectRatio
|
スケーリング中に動画のアスペクト比を維持するかどうかを示します。 |
ブール値 | true |
mediaFilesList
|
プレイヤーが広告表示に必要とする動画やその他のアセットを指定します。 パス: |
配列 | [] |
mediaFileUri
|
実行可能アセットまたはビデオアセットを指す URI。 |
String | https://myad.com/ad/ad134/vpaid.js |
mediaType
|
クリエイティブアセットまたはコンパニオンアセットの MIME タイプ。 |
String | video/mp4 |
meta
|
広告の追加メタデータ。 |
オブジェクト | |
mezzanine
|
VPAID 広告にメザニン MP4 アセットが含まれている場合に指定される URL。 パス: |
String | https://gcdn.2mdn.net/videoplayback/id/itag/ck2/file/file.mp4 |
nextToken
|
このような値が存在する場合、結果の次のページを指すトークンの値。 |
String | UFQzOS44NzNTXzIwMjMtMDctMzFUMTY6NTA6MDYuMzUwNjI2ODQ1Wl8x |
nonLinearAds
|
動画コンテンツと一緒に表示される非線形広告。 |
配列 | [] |
nonLinearAdsList
|
非線形広告のリスト。 |
配列 | [] |
scalable
|
ビデオを他のディメンションにスケールするかどうかを示します。 |
ブール値 | true |
skipOffset
|
ユーザーがスキップコントロールを使用できるようにするタイミングを識別する時間値。 |
String | 00:00:05 |
staticResource
|
広告コンポーネントに使用される静的クリエイティブファイルへの URL。 パス: |
String | https://very-interactive-ads.com/campaign1/file.json?c=1019113602 |
vastAdId
|
|
String | ad1 |
width
|
ビデオアセットの幅をピクセル単位で示します。 |
String | 640 |
xPosition
|
ビデオプレーヤー内のアイコンの水平位置。特定のピクセル値、または「左」や「右」などの位置を指定できます。 パス: |
String | left 、または 10 |
yPosition
|
ビデオプレーヤー内のアイコンの垂直位置。特定のピクセル値、または「上」や「下」などの位置を指定できます。 パス: |
String | top 、または 10 |
iconClicks
|
アイコンのクリックスルーと追跡情報が含まれます。 パス: |
オブジェクト | |
iconClickThrough
|
ビューワーがアイコンをクリックしたときにメディアプレーヤーが開く、広告主のページへの URL。 パス: |
String | https://advertiser.com/landing-page |
iconClickTracking
|
パス: |
オブジェクト | |
iconClickFallbackImages
|
アイコンを表示できない場合に表示するフォールバックイメージの配列。 パス: |
配列 | |
iconViewTracking
|
アイコンが表示されたときに追跡するための URL。 パス: |
String | https://tracking.example.com/icon-view |
offset
|
広告の再生中にアイコンが表示されるときのタイムオフセット。 パス: |
String | 00:00:05 |
program
|
アイコンに関連付けられた「AdChoices」などのプログラムまたはイニシアチブ。 パス: |
String | AdChoices |
pxratio
|
アイコンまたはコンパニオン広告のピクセル比。高 DPI ディスプレイに使用されます。 パス: |
String | 1 、または 2 |
type
|
リソースまたは拡張機能のタイプ。 パス: |
String | text/javascript |
content
|
拡張機能の内容。 パス: |
String | |
language
|
実行可能リソースのプログラミング言語。 パス: |
String | javascript |
browserOptional
|
JavaScript リソースにブラウザのサポートが必要かどうかを示します。 パス: |
String | true 、または false |
id
|
スキーマ内のさまざまな要素の識別子。 パス: |
String | companion-1 |
assetHeight
|
コンパニオン広告アセットの高さ。 パス: |
String | 250 |
assetWidth
|
コンパニオン広告アセットの幅。 パス: |
String | 300 |
expandedHeight
|
展開時のコンパニオン広告の高さ。 パス: |
String | 600 |
expandedWidth
|
展開時のコンパニオン広告の幅。 パス: |
String | 600 |
renderingMode
|
コンパニオン広告のレンダリングモード。 パス: |
String | default 、または transparent |
adSlotId
|
コンパニオン広告を表示する広告スロットの ID。 パス: |
String | banner-1 |
creativeType
|
クリエイティブアセットの MIME タイプ。 パス: |
String | image/png |