ユーザーメタデータ user-metadata

NOTE
このページのコンテンツは、情報提供の目的でのみ提供されます。 この API を使用するには、Adobeの現在のライセンスが必要です。 不正な使用は許可されていません。
NOTE
REST API 実装は、 スロットルメカニズム

REST API エンドポイント clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

説明 description

認証済みユーザーに関して MVPD が共有したメタデータを取得します。

エンドポイント
呼び出し済み
作成者
入力
パラメーター
HTTP
メソッド
応答
HTTP
応答
<SP_FQDN>/api/v1/tokens/usermetadata
ストリーミングアプリ

または

プログラマーサービス
(1) 請求者
2. deviceId(必須)
3. device_info/X-Device-Info (必須)
4. deviceType
5. deviceUser (非推奨)
6. appId (非推奨)
GET
失敗した場合は、ユーザーメタデータまたはエラーの詳細を含む XML または JSON。

200 — 成功

404 — メタデータが見つかりません

412 — 無効な AuthN トークン(期限切れのトークンなど)

入力パラメーター
説明
要求者
この操作が有効な ProgrammerRequestorId。
deviceId
デバイス ID バイト。

device_info/

X-Device-Info

デバイス情報のストリーミング。

注意: この INFO は、URL パラメータとして device_info に渡すことができますが、このパラメータの潜在的なサイズと、GETURL の長さに関する制限により、HTTP ヘッダーで X-Device-Info として渡す必要があります。

詳しくは、 デバイスと接続情報を渡す.
deviceType
デバイスタイプ(Roku、PC など)。

このパラメータが正しく設定されている場合、ESM は以下の指標を提供します。 デバイスタイプ別に分類 クライアントレスを使用する場合に、Roku、AppleTV、Xbox など、様々な種類の分析を実行できます。

詳しくは、 パス指標でクライアントレスデバイスタイプパラメーターを使用するメリット

注意: The device_info は、このパラメーターを置き換えます。
deviceUser
デバイスのユーザー ID。

注意: 使用する場合、 deviceUser は、 登録コードを作成 リクエスト。
appId
アプリケーション ID/名前。

注意: The device_info は、このパラメーターを置き換えます。 使用する場合、 appId は、 登録コードを作成 リクエスト。
NOTE
ユーザーメタデータ情報は、認証フローの完了後に使用できる必要がありますが、MVPD やメタデータタイプに応じて、認証フローで更新できます。

レスポンスのサンプル sample-response

呼び出しが成功すると、サーバーは、以下に示す構造と同じ構造の XML(デフォルト)または JSON オブジェクトで応答します。

    {
        updated: 1334243471,
        encrypted: ["encryptedProp"],
        data: {
              zip: ["12345", "34567"],
              maxRating: {
                  "MPAA": "PG-13",
                  "VCHIP": "TV-Y",
                  "URL": "http://exam.pl/e/manage/ratings"
                         },
              householdID: "3456",
              userID: "BgSdasfsdk23/dsaf3+saASesadgfsShggssd=",
              channelID: ["channel-1", "channel-2"]
              }
    }

オブジェクトのルートには、次の 3 つのノードがあります。

  • 更新済み:メタデータが最後に更新された時刻を表す UNIX タイムスタンプを指定します。 このプロパティは、認証フェーズでメタデータを生成する際に、サーバーによって最初に設定されます。 以降の呼び出し(メタデータの更新後)では、タイムスタンプが増分されます。
  • データ:実際のメタデータ値が含まれます。
  • 暗号化:暗号化されたプロパティをリストする配列。 特定のメタデータ値を復号するには、プログラマは、メタデータに対して Base64 デコードを実行し、その結果の値に対して RSA 復号を適用する必要があります (Adobeは、プログラマの公開証明書を使用してサーバ上のメタデータを暗号化します )。

エラーが発生した場合、サーバーは詳細なエラーメッセージを指定する XML または JSON オブジェクトを返します。

詳しくは、 ユーザーメタデータ.

REST API リファレンスに戻る

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b