次の方法で共有


IDENTITY Type サービス

注:

このサービスは現在アルファにあります。 まだ開発中であり、予告なく変更される場合があります。 有効にするには、Microsoft アカウント担当者にお問い合わせください。

Identity Management Framework の Identity Type サービスを使用して、プラットフォーム内の識別子の取得、作成、更新、削除を行うことができます。 さらに、このサービスを使用すると、所有者は ID ソリューションのアクセス許可を管理できます。 このサービスを使用すると、ID 所有者は次のことができます。

  • bidstream 内で識別子を利用することが許可されている発行元を決定します。
  • 識別子を使用してデータを組み込むことができるパートナーをプラットフォーム上で決定します。
  • 識別子にアクセスできる外部入札者を選択します。
  • プラットフォームで、ログ レベルのデータ フィードで識別子の値を受け取る資格があるパートナーを選択します。

重要

新しい識別子を登録または作成するには、この機能が Microsoft 管理者ロールに制限されているため、Microsoft アカウント担当者にお問い合わせください。

REST API

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/identity-type?id=IDENTITY_ID1 ID で特定の識別子を表示します。 ここでは、 IDENTITY_ID1 識別子の ID の例を示します。
GET https://api.appnexus.com/identity-type?id=IDENTITY_ID1、IDENTITY_ID2、IDENTITY_ID3 コンマ区切りリストを使用して、ID で複数の識別子を表示します。
GET https://api.appnexus.com/identity-type?source=SOURCE1 LiveRamp、Warner Media などのソースによって特定の識別子を表示します。ここでは、 SOURCE1 識別子のソースの例を示します。
GET https://api.appnexus.com/identity-type?source=SOURCE1、SOURCE2 コンマ区切りリストを使用して、ソース別に複数の識別子を表示します。
GET https://api.appnexus.com/identity-type?member_owner_id=OWNERID1 ID 所有者の ID で識別子を表示します。
GET https://api.appnexus.com/identity-type?member_owner_id=OWNERID1、OWNERID2 コンマ区切りリストを使用して、所有者の複数の ID で複数の識別子を表示します。
PUT https://api.appnexus.com/identity-type?id=IDENTITY_ID1 ID で特定の識別子を更新します。
POST https://api.appnexus.com/identity-type 例に示すように、ペイロード JSON を使用して識別子を追加します。
Microsoft 管理者専用フィールド。
DELETE https://api.appnexus.com/identity-type?id=IDENTITY_ID1&member_id=MEMBER_ID1 メンバーに属している既存の識別子を削除します。
Microsoft 管理者専用フィールド。

JSON フィールド

管理者専用コントロールを使用した登録フィールド

フィールド 種類 説明
id int Microsoft は識別子の ID を作成しました。
読み取り専用。
必須のオン:PUTDELETE
member_owner_id int 識別子所有者 (通常は発行元) のメンバー ID。
必須:POST
Microsoft 管理者の書き込み専用フィールド。
source string 識別子のソース。 たとえば、LiveRamp、Warner Media などです。ソースは識別子に一意である必要があります。
必須:POST
requires_platform_resolution ブール値 エンコードとデコードの識別子でプラットフォームの解決が必要です。
必須:POST
requires_seat_resolution ブール値 各入札者の識別子 (RampID) でシートの解決が必要です。
identity_resolver_check
is_auction_usage_single_context ブール値 関連するプライバシーの使用 (CPRA) の識別子コンテキスト セット。 識別子を使用して 2 つ以上のドメイン/Web サイト上のユーザーを識別する場合は、 falseに設定する必要があります。
必須:POST
is_passthrough ブール値 プラットフォームで周波数制限と対象ユーザーのセグメント化を許可するマスター設定。
デフォルト:False
requires_rti_partner_match ブール値 Trade Desk 関連の識別子に必要なフィールド。
rti_partner ブール値 Trade Desk 関連の識別子に必要なフィールド。
is_experimental ブール値 FLoC/トピックに使用されるフィールド。 FLoC の詳細については、「フェデレーション ラーニング オブ コーホート (FLoC)」を参照してください。
opt_out_default ブール値 trueすると、業界の型識別子は既定でオプトアウトされ、その逆も無効になります
ID の種類がオプトインされている場合は、ID リゾルバーを参照して、オプトアウトがあるかどうかを確認する必要はありません。ただし、ID の種類が既定で最初にオプトアウトされた場合、ID リゾルバーは識別子をオプトインするかオプトアウトするかを決定する必要があります。
enforce_adx_specification ブール値 このフィールドは、Impression Bus のドライブ検証 ID の長さが 32 を超えるかどうかを指定します。

識別子所有者のマスター コントロール設定

フィールド 種類 説明
status string activeinactiveかに関係なく、識別子の状態。
auction_participation_control object 他のパブリッシャーがこの識別子を使用できるかどうかを制御し、許可される識別子を指定するためのマスター設定。 詳細については、以下の 「オークション参加コントル」 を参照してください。
audience_segmentation_control object 識別子を使用して対象ユーザーのセグメント化のために他のメンバーへのアクセス許可を制御するマスター設定。 要求のこのフィールドは、登録済み識別子に対してセグメントオンボードを許可するメンバーの一覧を定義します。
external_bidder_control object 識別子を外部入札者に送信できるかどうかを制御し、適格な外部入札者を指定するマスター設定。 このフィールドは、新しく登録されたソースと識別子を受け取る入札者の既定のリストを定義します。 既定では、メンバー参加者は識別子レベルで定義された入札者を使用するか、ID タイプの参加者 API を使用してオーバーライドできます。
lld_exposure_control object 識別子をログ レベル データ (LLD) で使用できるかどうかを制御し、承認された受信者を決定するマスター設定。 このフィールドは、新しく登録されたソースと識別子の実際の ID 値を LLD フィードに表示できるメンバーの一覧を定義します。 既定では、メンバー参加者は識別子レベルで定義されているメンバーを使用するか、ID 型の参加者 API をオーバーライドできます。

オークション参加制御

他のパブリッシャーがこの識別子を使用できるかどうかを制御し、許可される識別子を指定するためのマスター設定。 要求のこのフィールドは、オークションが有効になっているメンバーの一覧を定義します。 オークションが有効なメンバーは、フレームワーク内の識別子の参加者になります。

フィールド 種類 説明
allow_participation string オークション参加が有効な販売者:
オプション:
- "all"
- "none"
- “include_subset”
participant_member_list 整数の配列 有効になっている member_id の一覧: “include_subset”

対象ユーザーのセグメント化コントロール

識別子を使用して対象ユーザーのセグメント化のために他のメンバーへのアクセス許可を制御するマスター設定。 要求のこのフィールドは、登録済み識別子に対してセグメントオンボードを許可するメンバーの一覧を定義します。

フィールド 種類 説明
allow_segmentation string 対象ユーザーのセグメント化が有効になっているメンバー:
オプション:
- "all"
- "none"
- “include_subset”
segmentation_member_list 整数の配列 有効になっている member_id の一覧: “include_subset”

外部入札者コントロール

識別子を外部入札者に送信できるかどうかを制御し、適格な外部入札者を指定するマスター設定。 このフィールドは、新しく登録されたソースと識別子を受け取る入札者の既定のリストを定義します。 既定では、メンバー参加者は識別子レベルで定義された入札者を使用するか、ID タイプの参加者 API を使用してオーバーライドできます。

フィールド 種類 説明
allow_bidders 配列 外部入札者のメンバーが識別子を受け取る機能を有効にしました。
オプション:
- "all"
- "none"
- “include_subset”
external_bidder_list 整数の配列 有効になっている member_id の一覧: “include_subset”

ログ レベルのデータ公開制御

識別子をログ レベル データ (LLD) で使用できるかどうかを制御し、承認された受信者を決定するマスター設定。 このフィールドは、新しく登録されたソースと識別子の実際の ID 値を LLD フィードに表示できるメンバーの一覧を定義します。 既定では、メンバーの参加者は識別子レベルで定義されたメンバーを使用できます。または、パブリッシャーが参加者サービスを利用して、提供する識別子の採用方法とプラットフォームによる表示方法を追加制御するオプションがある ID 型の参加者 API をオーバーライドできます。

フィールド 種類 説明
lld_exposure_allowed 配列 LLD で識別子の値を受け取るために有効になっているメンバー。
オプション:
- "all"
- "none"
- “include_subset”
- "participant_only"
exposure_member_list 整数の配列 有効になっている member_id の一覧: “include_subset”

識別子を作成する

$ cat new_identifier.json
{
  "identity_type": {
      "source": "test.com",
      "member_owner_id": 958,
      "requires_platform_resolution": true,
      "identity_resolver_check": true,
      "is_auction_usage_single_context": true,
      "is_passthrough": true,
      "requires_seat_resolution": false,
      "requires_rti_partner_match": false,
      "rti_partner": "",
      "is_experimental": false,
      "opt_out_default": false,
      "status": "active",
      "enforce_adx_specification": false,
      "auction_participation_control": {
        "allow_participation": "include_subset",
        "participant_member_list": [
          123,
          456
        ]
      },
      "audience_segmentation_control": {
        "allow_segmentation": "include_subset",
        "segmentation_member_list": [
          456
        ]
      },
      "external_bidder_control": {
        "allow_bidders": "all",
        "external_bidder_list": [
          111,
          112
        ]
      },
      "lld_exposure_control": {
        "lld_exposure_allowed": "include_subset",
        "exposure_member_list": [
          311,
          312
        ]
      }
    }
  }
$ curl -b cookie -c cookie -X POST  'https://api.appnexus.com/identity-type'
{
    "response": {
        "status":"OK",
        "id":IDENTITY_ID_001
        }
        }

注:

新しく登録されたソースの場合、ID は増分順序で生成されますが、残りのフィールド値は API を介して送信された要求に基づいてデータベースに格納されます。

特定の識別子の詳細を表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/identity-type?id=IDENTITY_ID_001'
{
  "response": {
    "status": "OK",
    "identity_type": {
        "id": IDENTITY_ID_001,
        "source": "test.com",
        "member_owner_id": 958,
        "requires_platform_resolution": true,
        "identity_resolver_check": true,
        "is_auction_usage_single_context": true,
        "is_passthrough": true,
        "requires_seat_resolution": false,
        "requires_rti_partner_match": false,
        "rti_partner": "",
        "is_experimental": false,
        "opt_out_default": false,
        "status": "active",
        "enforce_adx_specification": false,
        "auction_participation_control": {
          "allow_participation": "include_subset",
          "participant_member_list": [
            123,
            456
          ]
        },
        "audience_segmentation_control": {
        "allow_segmentation": "include_subset",
        "segmentation_member_list": [
          456
         ]
        },
        "external_bidder_control": {
        "allow_bidders": "all",
        "external_bidder_list": [
          111,
          112
         ]
        },
        "lld_exposure_control": {
        "lld_exposure_allowed": "include_subset",
        "exposure_member_list": [
          311,
          312
        ]
      }
    }
  }
}

ID の種類の参加者サービス