ドキュメントAdobe PassAdobe Pass 認証

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

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
このページのコンテンツは情報提供のみを目的としています。 この API を使用するには、Adobeから現在のライセンスが必要です。 無許可の使用は許可されていません。
NOTE
REST API の実装には、 スロットルメカニズムという制限があります。

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

<REGGIE_FQDN>:

<SP_FQDN>:

説明 description

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

エンドポイント
呼び出
元
入力
パラメーター
HTTP
メソッド
応答
HTTP
Response
<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 トークン（期限切れのトークンなど）

入力パラメーター
説明
要求者
この操作が有効なプログラマ requestorId です。
deviceId
デバイス ID のバイト。

device_info/

X-Device-Info

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

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

詳しくは、「デバイスと接続の情報を渡す を参照してください。
deviceType
デバイスタイプ（Roku、PC など）。

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

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

メモ： このパラメーターは device_info で置き換えられます。
deviceUser
デバイスユーザー ID。

メモ： 使用する場合、deviceUser は 登録コードの作成リクエストと同じ値を持つ必要があります。
appId
アプリケーション ID/名前。

メモ： このパラメーターは 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 つのノードがあります。

  • updated：メタデータが最後に更新された時刻を表す UNIX タイムスタンプを指定します。 このプロパティは、認証フェーズでメタデータを生成するときに、サーバーによって最初に設定されます。 （メタデータを更新した後の）後続の呼び出しでは、タイムスタンプが増分されます。
  • data：実際のメタデータ値を格納します。
  • encrypted：暗号化されたプロパティをリストする配列。 特定のメタデータ値を復号化するには、プログラマーはメタデータに対して Base64 デコードを実行し、結果の値に対して独自の秘密鍵を使用して RSA 復号化を適用する必要があります（Adobeは、プログラマーの公開証明書を使用してサーバー上のメタデータを暗号化します）。

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

詳しくは、 ユーザーメタデータを参照してください。

REST API リファレンスに戻る

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