ドキュメントAnalyticsストリーミングメディアサービスガイド

リクエストパラメーター request-parameters

Last update: Tue Aug 19 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：

作成対象：

  • ユーザー
  • 管理者
  • 開発者

Analytics データ

リクエストキー
必須
リクエストタイプキー
設定する場所
説明
analytics.trackingServer
はい
string
sessionStart
Adobe Analytics サーバーの URL
analytics.reportSuite
はい
string
sessionStart
Analytics レポートデータを識別する ID
analytics.enableSSL
いいえ
ブール型
sessionStart
SSL を有効にするかどうか（true または false）
analytics.visitorId
いいえ
string
sessionStart
Adobe 訪問者 ID は、複数のアドビアプリケーションで使用できるカスタム ID です。ハートビート visitorId は Analytics VID. と同じです。

訪問者データ

リクエストキー
必須
リクエストタイプキー
設定する場所
説明
visitor.marketingCloudOrgId
はい
string
sessionStart
Experience Cloud 組織 ID。Adobe Experience Cloud エコシステム内で組織を識別します。
visitor.marketingCloudUserId
いいえ
string
sessionStart
これは、Experience Cloud ユーザー ID（ECID）です。ほとんどのシナリオで、これがユーザーを識別するために使用する必要がある ID です。ハートビート marketingCloudUserId は、Adobe Analytics の MID と同じです。技術的には必須ではありませんが、このパラメーターは、Experience Cloud ファミリーのアプリにアクセスするために必要です。
visitor.aamLocationHint
いいえ
整数
sessionStart
Adobe Audience Manager Edge データを提供します。値が入力されていない場合、値は null です。
appInstallationId
いいえ
string
sessionStart
アプリとデバイスを一意に識別する appInstallationId

コンテンツデータ

リクエストキー
必須
リクエストタイプキー
設定する場所
説明
media.id
はい
string
sessionStart
コンテンツの一意の ID
media.name
いいえ
string
sessionStart
人が判読可能なコンテンツの名前
media.length
はい
number
sessionStart
コンテンツの長さ（秒）
media.contentType
はい
string
sessionStart
ストリームの形式（任意の文字列を指定できます。推奨される値は、「Live」、「VOD」または「Linear」です）
media.playerName
はい
string
sessionStart
コンテンツのレンダリングをおこなうプレーヤーの名前
media.channel
はい
string
sessionStart
コンテンツの配布チャネル。モバイルアプリケーション名、Web サイト名またはプロパティ名を使用できます。
media.resume
いいえ
ブール型
sessionStart
ユーザーが（新しいセッションを開始するに対して）以前のセッションを再開しているかどうかを示します
media.sdkVersion
いいえ
string
sessionStart
プレーヤーで使用される SDK のバージョン

コンテンツ標準メタデータ

リクエストキー
必須
リクエストタイプキー
設定する場所
説明
media.streamFormat
いいえ
string
sessionStart
ストリーミング形式（例：「HD」）
media.show
いいえ
string
sessionStart
プログラム名またはシリーズ名
media.season
いいえ
string
sessionStart
番組またはシリーズが属するシーズン番号
media.episode
いいえ
string
sessionStart
エピソードの番号
media.assetId
いいえ
string
sessionStart
TV シリーズのエピソードの識別子、ムービーアセットの識別子、ライブイベントの識別子など、ビデオアセットのコンテンツの一意の ID。この ID は通常、EIDR、TMS／Gracenote、Rovi などのメタデータを扱う機関から取得します。その他の独自のシステムや社内システムから取得することもできます。
media.genre
いいえ
string
sessionStart
コンテンツプロデューサーによって定義されたコンテンツのタイプ
media.firstAirDate
いいえ
string
sessionStart
コンテンツがテレビで最初に放送された日付
media.firstDigitalDate
いいえ
string
sessionStart
コンテンツが何らかのデジタルプラットフォームで最初に放送された日付
media.rating
いいえ
string
sessionStart
TV Parental Guidelines で定義されたレーティング
media.originator
いいえ
string
sessionStart
コンテンツの作成者
media.network
いいえ
string
sessionStart
ネットワーク／チャネル名
media.showType
いいえ
string
sessionStart

コンテンツのタイプ（0 ～ 3 の整数）

  • 0 - エピソードそのもの
  • 1 - プレビュー
  • 2 - クリップ
  • 3 - その他
media.adLoad
いいえ
string
sessionStart
読み込まれた広告のタイプ
media.pass.mvpd
いいえ
string
sessionStart
アドビの認証によって提供される MVPD
media.pass.auth
いいえ
string
sessionStart
ユーザーがアドビの認証によって認証されていることを示します（設定されている場合にのみ true になります）。
media.dayPart
いいえ
string
sessionStart
コンテンツが放送された時刻
media.feed
いいえ
string
sessionStart
フィードのタイプ（例：「West-HD」）

広告データ

リクエストキー
必須
リクエストタイプキー
設定する場所
説明
media.ad.podFriendlyName
いいえ
string
adBreakStart
広告ブレークのわかりやすい名前
media.ad.podIndex
はい
整数
adBreakStart
ビデオ内の広告ポッドのインデックス
media.ad.podSecond
はい
number
adBreakStart
ポッドが開始された時間（秒）
media.ad.podPosition
はい
整数
adStart
広告ブレーク内の広告のインデックス（1 から開始）
media.ad.name
いいえ
string
adStart
広告のわかりやすい名前
media.ad.id
はい
string
adStart
広告の名前
media.ad.length
はい
number
adStart
ビデオ広告の長さ（秒）
media.ad.playerName
はい
string
adStart
広告のレンダリングをおこなうプレーヤーの名前

広告標準メタデータ

リクエストキー
必須
リクエストタイプキー
設定する場所
説明
media.ad.advertiser
いいえ
string
adStart
広告で取り上げられている製品の会社またはブランド
media.ad.campaignId
いいえ
string
adStart
広告キャンペーンの ID
media.ad.creativeId
いいえ
string
adStart
広告クリエイティブの ID
media.ad.siteId
いいえ
string
adStart
広告サイトの ID
media.ad.creativeURL
いいえ
string
adStart
広告クリエイティブの URL
media.ad.placementId
いいえ
string
adStart
広告のプレースメント ID

チャプターデータ

リクエストキー
必須
リクエストタイプキー
設定する場所
説明
media.chapter.index
はい
整数
chapterStart
コンテンツ内のチャプターの位置を識別します。
media.chapter.offset
はい
number
chapterStart
再生においてチャプターが始まる時間（秒）
media.chapter.length
はい
number
chapterStart
チャプターの長さ（秒）
media.chapter.friendlyName
いいえ
string
chapterStart
チャプターのわかりやすい名前

品質データ

リクエストキー
必須
リクエストタイプキー
設定する場所
説明
media.qoe.bitrate
いいえ
整数
いずれか
平均ビットレート（bps）。平均ビットレートは、再生セッション中に発生した再生時間に関連するすべてのビットレート値の加重平均として計算されます。
media.qoe.droppedFrames
いいえ
整数
いずれか
ストリーム内のドロップフレームの数
media.qoe.framesPerSecond
いいえ
整数
いずれか
1 秒あたりのフレーム数
media.qoe.timeToStart
いいえ
整数
いずれか
ユーザーが再生を押してからコンテンツが読み込まれて再生が開始されたときまでの時間（ミリ秒）

カリフォルニア州消費者プライバシー法（CCPA）のパラメーター ccpa-params

リクエストキー
必須
リクエストタイプキー
設定する場所
説明
analytics.optOutServerSideForwarding
いいえ
ブール型
sessionStart
エンドユーザーが Adobe Analytics およびその他の Experience Cloud ソリューション（例：Audience Manager）間でのデータの共有をオプトアウトした場合、true に設定します。
analytics.optOutShare
いいえ
ブール型
sessionStart
エンドユーザーが（例えば、他の Adobe Analytics クライアントに対する）データのフェデレーションをオプトアウトした場合、true に設定します。

追加の詳細情報 additional-details

visitor.marketingCloudUserId

Experience Cloud ユーザー ID（MID または MCID とも呼ばれます）は、visitor.marketingCloudUserId キーを使用して params マップに含めることで、sessionStart 呼び出しの際に渡します。これは、既に他の Experience Cloud 製品と統合していて、MCID を既に取得している場合に便利な機能です。

NOTE
Media Analytics（MA）は、Experience Cloud ファミリーのアプリ（Adobe Analytics、Audience Manager、Target など）と統合されています。これらのアプリにアクセスするには、Experience Cloud ID が必要です。ECID は、ほとんどのシナリオでユーザーを識別するために使用する必要があるものです。

appInstallationId

  • appInstallationId 値を渡さない場合 - MA バックエンドは MCID を生成しなくなり、その代わりに Adobe Analytics にその操作を任せます​ 。 ​アドビのレコメンデーションは、MCID を送信する（MCID を取得できる場合）か、（必須の appInstallationId と共に）marketingCloudOrgId を送信してメディアコレクション API が MCID を生成してすべての呼び出しで送信できるようにすることです。

  • appInstallationId 値を渡す場合 - appInstallationId および​ （ ​必須の​ ） marketingCloudOrgId パラメーターの値を渡すと、MA バックエンドによって MCID を生成できます。自分で appInstallationId を渡す場合は、クライアント側でその値を維持する必要があります。この値はデバイス上のアプリに対して一意である必要があり、アプリが再インストールされない限り永続的である必要があります。

NOTE
appInstallationId は、アプリ​ とデバイス ​を一意に識別します。この値は各デバイスのアプリごとに一意である必要があります。つまり、異なるデバイスで同じアプリの同じバージョンを使用する 2 人のユーザーは、それぞれ異なる（一意の）appInstallationId を送信する必要があります。

visitor.marketingCloudOrgId

このパラメーターは、MCID が指定されていない場合に MCID の生成に必要であるだけでなく、（どの Media Analytics がフェデレーションルールの照合を実行するかに基づいて）Publisher ID の値としても使用されます。

Analytics レガシーユーザー ID（aid）および宣言済みユーザー ID（customerIDs）

  • analytics.aid：

    このキーの値は、Analytics レガシーユーザー ID を表す文字列である必要があります。

  • visitor.customerIDs：

    このキーの値は、次の形式のオブジェクトである必要があります。

    code language-js 
    "<<insert your ID name here>>": {
  "id": " <<insert your id here>>",
   "authState": <<insert one of 0, 1, 2>>
}

visitor.customerIDs の値には、上記の形式のオブジェクトを任意の数だけ含めることができます。

visitor.aamLocationHint

このパラメーターは、Adobe Analytics が顧客データを Audience Manager に送信したときにどの Adobe Audience Manager（AAM）Edge がヒットするかを示します。値が入力されない場合、値は null になります。 これは、エンドユーザーが地理的に離れた場所（例えば、米国東部、米国西部、ヨーロッパ、アジア）でデバイスを使用する場合に特に重要です。そうでない場合、ユーザーデータは複数の AAM Edge に分散されます。

media.resume

セッションが閉じられた後で（例えば、ユーザーが一旦ビデオから離れた後で戻ってきた結果）再開され、プレーヤーの再生ヘッドが停止された位置からビデオが再開されたことをアプリが検出した場合、sessionStart 呼び出しの params バケット内でブール型のオプションの media.resume パラメーターを送信できます。

recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb