メディア | APIリファレンス |Tealiumドキュメント

クラス: Media

Mediaクラスは、カスタムイベントを使用してアプリ内でストリーミングメディアをトラッキングするためのメソッドを提供します。メディアトラッキングについて詳しくはこちらをご覧ください。

以下は、Tealium KotlinのMediaクラスでよく使用されるメソッドの概要です。

メソッド	説明
`clickAd()`	現在再生中の広告がクリックされました。
`custom()`	カスタムイベントステータスをデータレイヤーに送信します。
`endAd()`	広告が終了しました。
`endAdBreak()`	広告ブレイクが終了しました。
`endBuffer()`	バッファが終了しました。
`endChapter()`	章が終了しました。
`endSeek()`	ユーザーがシークを終了しました。
`endSession()`	セッションが終了しました（広告とコンテンツを含む）。
`pause()`	ユーザーがメディアを一時停止しました。
`ping()`	インターバルイベントをデータレイヤーに送信します。
`play()`	メディアコンテンツの再生が開始されました。
`resumeSession()`	セッションが再開されました。
`sendMilestone()`	マイルストーンデータをデータレイヤーに送信します。
`sendSummary()`	サマリーデータをデータレイヤーに送信します。
`skipAd()`	ユーザーが現在の広告をスキップしました。
`skipChapter()`	ユーザーが章をスキップしました。
`startAdBreak()`	広告ブレイクが開始されました。
`startAd()`	広告が開始されました。
`startBuffer()`	バッファが開始されました。
`startChapter()`	章が開始されました。
`startSeek()`	ユーザーがシークを開始しました。
`startSession()`	セッションが開始されました。
`updatePlayerState()`	プレーヤーの状態の開始または終了。
`updateQOE()`	クオリティオブエクスペリエンスのビットレート値を構成します。

`clickAd()`

現在再生中の広告がクリックされました。

tealium?.media?.clickAd(event)

`custom()`

カスタムイベントステータスをデータレイヤーに送信します。

tealium?.media?.custom(name)

パラメーター	タイプ	説明
`name`	`String`	カスタムイベント名。

`endAd()`

広告が終了しました。

tealium?.media?.endAd()

`endAdBreak()`

現在のセッションの最新の広告ブレイクが終了します。現在の広告ブレイクでのみ有効です。

tealium?.media?.endAdBreak()

`endBuffer()`

バッファが終了しました。

tealium?.media?.endBuffer()

`endChapter()`

章が終了しました。

tealium?.media?.endChapter()

`endSeek()`

ユーザーがシークを終了しました。指定された位置でシークが終了したことを記録します。

tealium?.media?.endSeek(position)

パラメーター	タイプ	説明
`position`	`Int`	シークが終了したメディア内の位置（秒単位）のインデックス位置。

例:

tealium?.media?.startSeek(10)

`endSession()`

セッションが終了しました（広告とコンテンツを含む）。

tealium?.media?.endSession()

`pause()`

ユーザーがメディアを一時停止しました。

tealium?.media?.pause()

`ping()`

インターバルイベントをデータレイヤーに送信します。このメソッドは、MediaContentオブジェクトのトラッキングタイプがINTERVALまたはINTERVAL_MILESTONEに構成されている場合、自動的に10秒ごとに呼び出されます。

tealium?.media?.ping()

メディアトラッキングタイプについて詳しくはこちらをご覧ください。

`play()`

メディアコンテンツの再生が開始されました。

tealium?.media?.play()

`resumeSession()`

セッションが再開されました。

tealium?.media?.startSession()

`sendMilestone()`

マイルストーンデータをデータレイヤーに送信します。このメソッドは、コンテンツの再生率に基づいて自動的に呼び出されます。MediaContentオブジェクトのトラッキングタイプがMILESTONEまたはINTERVAL_MILESTONEに構成されている場合です。

tealium?.media?.sendMilestone()

マイルストーンの値:

メディア再生率	マイルストーン値
8.0 - 12.0	`10%`
23.0 - 27.0	`25%`
48.0 - 52.0	`50%`
73.0 - 77.0	`75%`
88.0 - 92.0	`90%`
97.0 - 100.0	`100%`

メディアトラッキングタイプについて詳しくはこちらをご覧ください。

`sendSummary()`

サマリーデータをデータレイヤーに送信します。このメソッドは、MediaContentオブジェクトのトラッキングタイプがSUMMARYに構成されている場合、endSession()で自動的に呼び出されます。

tealium?.media?.sendSummary()

メディアトラッキングタイプについて詳しくはこちらをご覧ください。

`skipAd()`

ユーザーが現在の広告をスキップしました。

tealium?.media?.skipAd()

`skipChapter()`

ユーザーが章をスキップしました。

tealium?.media?.skipChapter()

`startAd()`

広告が開始されました。広告が完了したらendAd()メソッドを呼び出します。

tealium?.media?.startAd(ad)

パラメーター	タイプ	説明
`ad`	`Ad`	広告オブジェクト。

例:

tealium?.media?.startAd(Ad("広告  1"))

`startAdBreak()`

広告ブレイクが開始されました。広告ブレイクが完了したらendAdBreak()メソッドを呼び出します。

tealium?.media?.startAdBreak(break)

パラメーター	タイプ	説明
`break`	`AdBreak`	広告ブレイクオブジェクト。

例:

val adBreak = AdBreak(name = "広告ブレイク 1")
tealium?.media?.startAdBreak(adBreak)

`startBuffer()`

バッファが開始されました。バッファリングが完了したらendBuffer()メソッドを呼び出します。

tealium?.media?.startBuffer()

`startChapter()`

章が開始されました。章が完了したらendChapter()メソッドを呼び出します。

tealium?.media?.startChapter(chapter)

パラメーター	タイプ	説明
`chapter`	`Chapter`	章セグメント名。

例:

tealium?.media?.startChapter(Chapter(name = "章 1"))

`startSeek()`

ユーザーがシークを開始しました。シークが完了したらendSeek()メソッドを呼び出します。

tealium?.media?.startSeek(position)

パラメーター	タイプ	説明
`position`	`Int`	シークが開始されたメディア内の位置（秒単位）のインデックス位置。

例:

tealium?.media?.startSeek(10)

`startSession()`

セッションが開始されました。セッションが完了したらendSession()メソッドを呼び出します。

tealium?.media?.startSession()

`updatePlayerState()`

プレーヤーの状態の開始または終了。

tealium?.media?.updatePlayerState(state)

パラメーター	タイプ	説明
`state`	`State` 定数	メディアの状態

以下のState定数が使用可能です:

値	説明
`CLOSED_CAPTION`	閉じたキャプションの状態。
`FULLSCREEN`	フルスクリーンの状態。
`IN_FOCUS`	フォーカスされた状態。
`MUTE`	ミュートの状態。
`PICTURE_IN_PICTURE`	ピクチャインピクチャの状態。

例:

tealium?.media?.updatePlayerState(fullscreen)

プレーヤーの状態について詳しくはこちらをご覧ください。

`updateQOE()`

現在のセッションのクオリティオブエクスペリエンスのビットレート値を構成します（キロビット/秒）。

tealium?.media?.updateQOE(rate)

パラメーター	タイプ	説明
`rate`	`Int`	ビットレート値。

例:

tealium?.media?.updateQOE(1500)

クラス: `MediaContent`

MediaContentクラスは、メディアコンテンツオブジェクトを作成します。

val mediaContent: MediaContent = MediaContent(
  name: MEDIA_NAME,
  streamType: MEDIA_STREAM_TYPE,
  mediaType: MEDIA_TYPE,   
  qoe: MEDIA_QOE,
  trackingType: MEDIA_TRACKING_TYPE,
  state = MEDIA_STATE,
  customID = MEDIA_CUSTOM_ID,
  duration: MEDIA_DURATION,
  playerName: MEDIA_PLAYER_NAME,
  channelName: MEDIA_CHANNEL_NAME,
  metadata: MEDIA_METADATA
)

変数名	タイプ	説明	必須
`name`	`String`	メディアコンテンツの名前。	Yes
`streamType`	`StreamType`	メディアストリームのタイプ。	Yes
`mediaType`	`MediaType`	メディアのタイプ（ビデオまたはオーディオ）。	Yes
`qoe`	`QoE`	クオリティオブエクスペリエンスのビットレート値。	Yes
`trackingType`	`TrackingType`	イベントトラッキングのレベル（デフォルト：`TrackingType.FULL_PLAYBACK`）	Yes
`state`	`PlayerState`	メディアプレーヤーの状態のタイプ。
`customId`	`String`	カスタム識別子名。
`duration`	`Int`	メディアの再生時間（秒単位）（例：`130`）
`playerName`	`String`	メディアプレーヤーの名前。
`channelName`	`String`	メディアチャンネルの名前。
`metadata`	`[String: Any]`	追加のメディアメタデータ。

クラス: `Ad`

Adクラスは、広告オブジェクトを作成します。

val ad = Ad(
  id = MEDIA_AD_ID,
  name = MEDIA_AD_NAME,
  duration = MEDIA_AD_DURATION,
  position = MEDIA_AD_POSITION,
  advertiser = MEDIA_AD_ADVERTISER,
  creativeId = MEDIA_AD_CREATIVE_ID,
  campaignId = MEDIA_AD_CAMPAIGN_ID,
  placementId = MEDIA_AD_PLACEMENT_ID,
  siteId = MEDIA_AD_SITE_ID,
  creativeUrl = MEDIA_AD_CREATIVE_URL,
  numberOfLoads = MEDIA_AD_LOAD,
  pod = MEDIA_AD_POD,
  playerName = MEDIA_AD_PLAYER_NAME
)

パラメーター	タイプ	説明	必須
`name`	`String`	広告の名前	Yes
`duration`	`Double`	広告の再生時間（秒単位）（例：`130`）
`position`	`Int`	広告の現在のインデックス位置（秒単位）
`advertiser`	`String`	広告の広告主
`creativeId`	`String`	広告のクリエイティブ識別子
`campaignId`	`String`	広告のキャンペーン識別子
`placementId`	`String`	広告の配置識別子
`siteId`	`String`	広告のサイト識別子
`creativeUrl`	`String`	広告のクリエイティブURL
`numberOfLoads`	`Int`	広告の読み込み回数
`pod`	`String`	広告のポッド
`playerName`	`String`	広告のプレーヤー名

クラス: `AdBreak`

AdBreakクラスは、広告ブレイクオブジェクトを作成します。

val adBreak = AdBreak(
  id = MEDIA_AD_BREAK_ID,
  name = MEDIA_AD_BREAK_NAME,
  duration = MEDIA_AD_BREAK_DURATION,
  index = MEDIA_AD_BREAK_INDEX,
  position = MEDIA_AD_BREAK_POSITION
)

パラメーター	タイプ	説明	必須
`id`	`String`	広告ブレイクの一意の識別子
`name`	`String`	広告ブレイクの名前	Yes
`duration`	`Double`	広告ブレイクの再生時間（秒単位）（例：`130`）
`index`	`Int`	広告ブレイクのインデックス
`position`	`Int`	広告ブレイクの現在のインデックス位置（秒単位）

クラス: `Chapter`

Chapterクラスは、章オブジェクトを作成します。

val chapterObject = Chapter(
  name = MEDIA_CHAPTER_NAME,
  duration = MEDIA_CHAPTER_DURATION,
  position = MEDIA_CHAPTER_POSITION,
  metadata = MEDIA_CHAPTER_METADATA
)

以下は、Chapterオブジェクトのパラメーターです。パラメーター名を使用しない場合は、パラメーターを順番に指定する必要があります（例：duration =）。

変数名	タイプ	説明	必須
`name`	`String`	章の名前。	Yes
`duration`	`Double`	章の再生時間（秒単位）（例：`130`）
`position`	`Int`	章の位置インデックス。
`metadata`	`[String: Any]`	追加の章のメディアメタデータ。

クラス: `Ad`

Adクラスは、広告オブジェクトを作成します。

val ad = Ad(
  id = MEDIA_AD_ID,
  name = MEDIA_AD_NAME,
  duration = MEDIA_AD_DURATION,
  position = MEDIA_AD_POSITION,
  advertiser = MEDIA_AD_ADVERTISER,
  creativeId = MEDIA_AD_CREATIVE_ID,
  campaignId = MEDIA_AD_CAMPAIGN_ID,
  placementId = MEDIA_AD_PLACEMENT_ID,
  siteId = MEDIA_AD_SITE_ID,
  creativeUrl = MEDIA_AD_CREATIVE_URL,
  numberOfLoads = MEDIA_AD_LOAD,
  pod = MEDIA_AD_POD,
  playerName = MEDIA_AD_PLAYER_NAME
)

パラメーター	タイプ	説明	必須
`name`	`String`	広告の名前	Yes
`duration`	`Double`	広告の再生時間（秒単位）（例：`130`）
`position`	`Int`	広告の現在のインデックス位置（秒単位）
`advertiser`	`String`	広告の広告主
`creativeId`	`String`	広告のクリエイティブ識別子
`campaignId`	`String`	広告のキャンペーン識別子
`placementId`	`String`	広告の配置識別子
`siteId`	`String`	広告のサイト識別子
`creativeUrl`	`String`	広告のクリエイティブURL
`numberOfLoads`	`Int`	広告の読み込み回数
`pod`	`String`	広告のポッド
`playerName`	`String`	広告のプレーヤー名

クラス: `AdBreak`

AdBreakクラスは、広告ブレイクオブジェクトを作成します。

val adBreak = AdBreak(
  id = MEDIA_AD_BREAK_ID,
  name = MEDIA_AD_BREAK_NAME,
  duration = MEDIA_AD_BREAK_DURATION,
  index = MEDIA_AD_BREAK_INDEX,
  position = MEDIA_AD_BREAK_POSITION
)

パラメーター	タイプ	説明	必須
`id`	`String`	広告ブレイクの一意の識別子
`name`	`String`	広告ブレイクの名前	Yes
`duration`	`Double`	広告ブレイクの再生時間（秒単位）（例：`130`）
`index`	`Int`	広告ブレイクのインデックス
`position`	`Int`	広告ブレイクの現在のインデックス位置（秒単位）

クラス: `Chapter`

Chapterクラスは、章オブジェクトを作成します。

val chapterObject = Chapter(
  name = MEDIA_CHAPTER_NAME,
  duration = MEDIA_CHAPTER_DURATION,
  position = MEDIA_CHAPTER_POSITION,
  metadata = MEDIA_CHAPTER_METADATA
)

変数名	タイプ	説明	必須
`name`	`String`	章の名前。	Yes
`duration`	`Double`	章の再生時間（秒単位）（例：`130`）
`position`	`Int`	章の位置インデックス。
`metadata`	`[String: Any]`	追加の章のメディアメタデータ。

クラス: Media

clickAd()

custom()

endAd()

endAdBreak()

endBuffer()

endChapter()

endSeek()

endSession()

pause()

ping()

play()

resumeSession()

sendMilestone()

sendSummary()

skipAd()

skipChapter()

startAd()

startAdBreak()

startBuffer()

startChapter()

startSeek()

startSession()

updatePlayerState()

updateQOE()

クラス: MediaContent

クラス: Ad

クラス: AdBreak

クラス: Chapter

クラス: Ad

クラス: AdBreak

クラス: Chapter

`clickAd()`

`custom()`

`endAd()`

`endAdBreak()`

`endBuffer()`

`endChapter()`

`endSeek()`

`endSession()`

`pause()`

`ping()`

`play()`

`resumeSession()`

`sendMilestone()`

`sendSummary()`

`skipAd()`

`skipChapter()`

`startAd()`

`startAdBreak()`

`startBuffer()`

`startChapter()`

`startSeek()`

`startSession()`

`updatePlayerState()`

`updateQOE()`

クラス: `MediaContent`

クラス: `Ad`

クラス: `AdBreak`

クラス: `Chapter`

クラス: `Ad`

クラス: `AdBreak`

クラス: `Chapter`