セグメント サービス

セグメントサービスでは、セグメント ID を作成できます。この ID を使用して、インベントリページに配置するセグメントピクセルを作成できます。 Xandr プラットフォームを通じてサードパーティのデータ プロバイダーと連携している場合は、それらのプロバイダーのセグメントの一覧が表示されます。

• セグメントはメンバーに関連付けられており、オプションで特定の広告主に関連付けることができます。
• すべてのセグメント データはサーバー側の Cookie ストアに保存され、すべての入札要求で所有メンバーに関連付けられている入札者に渡されます。
• 広告主の関連付けは、コンソール ユーザー インターフェイスで参照および使用されます。

REST API

JSON フィールド

Piggyback ピクセル

ピギーバック ピクセルを追加するときは、次の点に注意してください。

• イメージ ピクセルは他のイメージ ピクセルにのみピギーバックでき、JavaScript ピクセルは他の JavaScript ピクセルにのみピギーバックできます。
• イメージ ピクセルには、ピギーバック ピクセルを 1 つだけ持つことができます。 複数のピクセルに便乗する必要がある場合は、必ず JavaScript ピクセルを使用してください。
• Xandr のピグバック ピクセルには文字制限はありませんが、ブラウザー/サーバーの URL 制限が適用される場合があります。

piggyback_pixels 配列の各オブジェクトには、次のフィールドが含まれています。

クエリ文字列について

Xandr には、クエリ文字列マッピングの 2 つの方法が用意されており、パブリッシャーは配置タグのクエリ文字列でインベントリ固有またはユーザー固有の情報を渡すことができます。

• クエリ文字列マッピング - セグメントに割り当てられたパラメーター値のセット。
• クエリ文字列マッピング キー 値 - 1 つのキーと値のペアをセグメントに割り当ててから、別のセグメントで異なる値を持つ同じキーを再利用できます。

両方のタイプのマップされたクエリ文字列の場合:

• マップされたクエリ文字列を使用して広告呼び出しが行われると、関連付けられているユーザーが自動的にセグメントに追加されます。
• キャンペーン内のクエリ文字列を(プロファイルサービスのsegment_targets または segment_group_targets フィールド経由で) ターゲットにすることができます。

ユーザーをセグメントに保持する期間を選択できることに注意してください。 リターゲティング目的でユーザーをセグメントに保持する場合は、 expire_minutes を正しい分数に設定します (null はシステムの最大値である 180 日に設定されます)。 広告呼び出しの期間中のみ、ユーザーをセグメントに追加する場合は、 expire_minutes を 0 に設定します。

さまざまなシナリオとフォーマットについては、以下の 例 を参照してください。

クエリ文字列マッピング

クエリ文字列マッピングでは、 querystring_mapping フィールドを使用してセグメントにパラメーターを割り当てることができます。 1 つのパラメーターに複数の値を追加できます。 このメソッドは、1 つの値のみがユーザーに意味を持つ場合に役立ちます。 たとえば、ユーザーの年齢、給与範囲、経験など。 ユーザーが beginner セグメントにいるが、後でより多くの経験値を積んだ場合、そのユーザーは advanced セグメントに移動でき、 beginner セグメントから自動的に削除されます。 詳細については 、「例」 を参照してください。

この種類のクエリ文字列では、パラメーターに値を指定できません。 たとえば、「 {"param": "car_model", "value_type": "none"} 」のように入力します。 これにより、そのパラメーターの任意の値を指定できます。

クエリ文字列マッピングのキー値

クエリ文字列のキー/値マッピングでは、 querystring_mapping_key_value オブジェクトを使用して、1 つのキーと値のペアをセグメントに割り当てることができます。 この種類のクエリ文字列を使用すると、ユーザーは複数のセグメントに存在でき、1 つのパラメーターに複数の値を使用するのが理にかなっている場合に便利です。 たとえば、ユーザーの音楽の好みなどです。 ユーザーが rock セグメントに属し、 funkも気に入っている場合は、両方のセグメントに同時に存在できます。 詳細については 、「例」 を参照してください。

この種類のクエリ文字列では、各 qs_key には少なくとも 1 つの対応する qs_valueが必要です。

例

セグメントの作成

$ cat segment

{
    "segment":{
        "member_id":25,
        "short_name":"remarketing - Warner Media user",
        "code":"WM08"
    }
}

$ curl -b cookies -c cookies -X POST -d @segment 'https://api.appnexus.com/segment?member_id=25'
                                            Or
$ curl -b cookies -c cookies -X POST -d @segment 'https://api.appnexus.com/segment'

{
   "response" : {
      "id" : 102,
      "count" : 1,
      "dbg_info" : {
         ...
      },
      "start_element" : 0,
      "num_elements" : 100,
      "segment" : {
         "object_type" : "default",
         "advertiser_id" : null,
         "enable_rm_piggyback" : true,
         "querystring_mapping_key_value" : null,
         "member_id" : 25,
         "expire_minutes" : null,
         "category" : null,
         "provider" : null,
         "parent_segment_id" : null,
         "querystring_mapping" : null,
         "short_name" : "yuichi-test",
         "max_usersync_pixels" : null,
         "code" : "yuichi-test-seg-02",
         "state" : "active",
         "description" : null,
         "id" : 102,
         "piggyback_pixels" : null,
         "last_modified" : "2019-08-14 17:26:29"
      },
      "status" : "OK"
   }
}

セグメントの表示

$ curl -b cookies -c cookies 'https://api.appnexus.com/segment?id=11836'

{
    "response": {
        "status": "OK",
        "segments": [
            {
                "id": 11836,
                "code": null,
                "state": "active",
                "short_name": "March 10",
                "description": null,
                "member_id": 185,
                "category": null,
                "price": "0",
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": 0,
                "last_modified": "2010-03-10 23:23:48",
                "provider": null,
                "parent_segment_id": null,
                "advertiser_id": 51,
                "piggyback_pixels": null
            }
        ]
    }
}

非共有のファースト パーティ セグメントを表示する

$ curl -b cookies -c cookies -X GET 'https://api.appnexus.com/segment?include_shared=0'

{
    "response": {
        "status": "OK",
        "segments": [
            {
                "id": 11836,
                "code": null,
                "state": "active",
                "short_name": "March 10",
                "description": null,
                "member_id": 185,
                "category": null,
                "price": "0",
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": 0,
                "last_modified": "2010-03-10 23:23:48",
                "provider": null,
                "parent_segment_id": null,
                "advertiser_id": 51,
                "piggyback_pixels": null
            }
        ]
    }
}

セグメントを広告主所有からネットワーク所有に変更する

広告主レベルのセグメントをネットワーク レベルのセグメントに変更するには、PUT呼び出しを行い、セグメント ID とメンバー ID をクエリ文字列に渡し、JSON ファイルでnulladvertiser_idを設定します。

$ cat segment_update

{
    "segment": {
        "advertiser_id": null
    }
}

$ curl -b cookies -c cookies -X PUT -d @segment_update 'https://api.appnexus.com/segment?id=175196&member_id=1066'
 
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "175196",
        "start_element": 0,
        "num_elements": 100,
        "segment": {
            "id": 175196,
            "code": null,
            "state": "active",
            "short_name": "Users who have purchased software",
            "description": null,
            "member_id": 1066,
            "category": null,
            "price": 0,
            "expire_minutes": null,
            "enable_rm_piggyback": true,
            "max_usersync_pixels": null,
            "advertiser_id": null,
            "last_modified": "2013-10-18 20:34:27",
            "provider": null,
            "parent_segment_id": null,
            "piggyback_pixels": null,
            "querystring_mapping": null
        }
    }
}

セグメントへのテキスト クエリ文字列マッピングの追加

シナリオ: 発行元 6 は、配置596411のクエリ文字列に "experience_level=beginner"、"experience_level=intermediate"、または "experience_level=advanced" のいずれかの値が含まれていると示しています。 この配置に "experience_level" パラメーターが含まれる場合は、キャンペーン ターゲティングにおいて初級、中級、上級の値を区別する機能を備えたセグメント 25 に関連付けられているユーザーを追加します。 この場合は、次の JSON を作成し、 PUT 呼び出しを実行してセグメントを更新します。

$ cat segment_update

 {
    "segments": [
        {
            "id": 25,
            "member_id": 20,
            "querystring_mapping": {
                "param": "experience_level",
                "value_type": "text",
                "values": [
                    "beginner",
                    "intermediate",
                    "advanced"
                ],
                "publishers": [
                    {
                        "id": 6
                    }
                ],
                "placements": [
                    {
                        "id": 596411
                    }
                ]
            }
        }
    ]
}

 $ curl -b cookies -c cookies -X PUT -d @segment_update 'https://api.appnexus.com/segment?id=25'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "25",
        "start_element": null,
        "num_elements": null,
        "segment": {
            "id": 25,
            "code": null,
            "state": "active",
            "short_name": "test",
            "description": null,
            "member_id": 49,
            "category": null,
            "price": 23,
            "expire_minutes": 20,
            "enable_rm_piggyback": true,
            "max_usersync_pixels": null,
            "last_modified": "2012-01-24 20:15:18",
            "provider": null,
            "parent_segment_id": null,
            "advertiser_id": null,
            "piggyback_pixels": null,
            "querystring_mapping": {
                "param": "experience_level",
                "value_type": "text",
                "values": [
                    "beginner",
                    "intermediate",
                    "advanced"
                ],
                "publishers": [
                    {
                        "id": 6,
                        "name": "Publisher 6"
                    }
                ],
                "sites": null,
                "placements": [
                    {
                        "id": 596411,
                        "name": "Placement 596411"
                    }
                ]
            }
        }
    }
}

セグメントへの数値クエリ文字列マッピングの追加

シナリオ: 自動パブリッシャー 30 では、配置のクエリ文字列に "car_year" パラメーターの後に 1 年が続くことが予想されます。 このパブリッシャーからのプレースメントのクエリ文字列に "car_year=YYYY" が含まれる場合は、関連付けられているユーザーをセグメント 26に追加できます。 この場合は、次の JSON を作成し、 PUT 呼び出しを実行してセグメントを更新します。

$ cat segment_update

{
   "segment": {
      "member_id": 20,
      "querystring_mapping": {
         "param": "car_year",
         "value_type": "numeric",
         "publishers": [
            {
               "id": 30
            }
         ]
      }
   }
}

$ curl -b cookies -c cookies -X PUT -d @segment 'https://api.appnexus.com/segment?id=26'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "26",
        "start_element": null,
        "num_elements": null,
        "segment": {
            "id": 26,
            "code": null,
            "state": "active",
            "short_name": "test",
            "description": null,
            "member_id": 20,
            "category": null,
            "price": 23,
            "expire_minutes": 20,
            "enable_rm_piggyback": true,
            "max_usersync_pixels": null,
            "last_modified": "2012-01-24 20:15:18",
            "provider": null,
            "parent_segment_id": null,
            "advertiser_id": null,
            "piggyback_pixels": null,
            "querystring_mapping": {
                "param": "car_year",
                "value_type": "numeric",
                "values": null,
                "publishers": [
                    {
                        "id": 30,
                        "name": "Publisher 30"
                    }
                ],
                "sites": null,
                "placements": null
            }
        }
    }
}

値を含まないクエリ文字列マッピングをセグメントに追加する

シナリオ: 10 と 30 の両方のパブリッシャーが、配置でパラメーター "car_model" (値なし) を予期するように指示します。 これらのパブリッシャーからのプレースメントのクエリ文字列が "car_model" と表示された場合は、セグメント 2に関連付けられているユーザーを追加できます。 この場合は、次の JSON を作成し、 PUT 呼び出しを実行してセグメントを更新します。

$ cat segment_update

{
   "segment": {
      "member_id": 20,
      "querystring_mapping": {
         "param": "car_model",
         "value_type": "none",
         "publishers": [
            {
               "id": 10,
               "id": 30
            }
         ]
      }
   }
}

$ curl -b cookies -c cookies -X PUT -d @segment_update 'https://api.appnexus.com/segment?id=2'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "2",
        "start_element": null,
        "num_elements": null,
        "segment": {
            "id": 2,
            "code": null,
            "state": "active",
            "short_name": "test",
            "description": null,
            "member_id": 20,
            "category": null,
            "price": 23,
            "expire_minutes": 20,
            "enable_rm_piggyback": true,
            "max_usersync_pixels": null,
            "last_modified": "2012-01-24 20:15:18",
            "provider": null,
            "parent_segment_id": null,
            "advertiser_id": null,
            "piggyback_pixels": null,
            "querystring_mapping": {
                "param": "car_model",
                "value_type": "none",
                "values": null,
                "publishers": [
                    {
                        "id": 10,
                        "name": "Publisher 10"
                    },
                    {
                        "id": 30
                        "name": "Publisher 30"
                    }
                ],
                "sites": null,
                "placements": null
            }
        }
    }
}

クエリ文字列キーと値のマッピングを使用して、複数の値を持つキーを再利用する

シナリオ: パブリッシャーが、音楽の好みに基づいてユーザーをセグメントに追加したいと考えています。 同じキー "music_genre" を使用し、複数の値 ("rock"、"pop"、"hard rock"、"funk" の値) を提供して、それらを異なるセグメントに割り当て、ユーザーを 1 つ以上のセグメントに配置できるようにします。 これは、ユーザーが多様な音楽の選択肢を持っている可能性があるという事実を反映しています。

この場合、次の JSON を作成し、 PUT 呼び出しを行ってセグメントを更新します。

$ cat segment_update
{
    "segments": [
        {
            "id": 501,
            "querystring_mapping_key_value": {
                "qs_key": "music_genre",
                "qs_value": "rock"
            }
        },
        {
            "id": 502,
            "querystring_mapping_key_value": {
                "qs_key": "music_genre",
                "qs_value": "pop"
            }
        },
        {
            "id": 503,
            "querystring_mapping_key_value": {
                "qs_key": "music_genre",
                "qs_value": "hard rock"
            }
        },
        {
            "id": 504,
            "querystring_mapping_key_value": {
                "qs_key": "music_genre",
                "qs_value": "funk"
            }
        }
    ]
}

$ curl -b cookies -c cookies -X PUT -d @segment_update 'https://api.appnexus.com/segment?member_id=201'

{
    "response": {
        "status": "OK",
        "count": 2,
        "id": [
            501,
            502,
            503,
            504
        ],
        "start_element": 0,
        "num_elements": 100,
        "ids": [
            501,
            502,
            503,
            504
        ],
        "segments": {
            "501": {
                "id": 501,
                "code": null,
                "state": "active",
                "short_name": "rock",
                "description": null,
                "member_id": 201,
                "category": null,
                "price": 0,
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": null,
                "advertiser_id": null,
                "last_modified": "2015-06-02 16:39:40",
                "provider": null,
                "parent_segment_id": null,
                "piggyback_pixels": null,
                "querystring_mapping": null,
                "querystring_mapping_key_value": {
                    "qs_key": "music_genre",
                    "qs_value": "rock"
                }
            },
            "502": {
                "id": 502,
                "code": null,
                "state": "active",
                "short_name": "rock",
                "description": null,
                "member_id": 201,
                "category": null,
                "price": 0,
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": null,
                "advertiser_id": null,
                "last_modified": "2015-06-02 16:39:40",
                "provider": null,
                "parent_segment_id": null,
                "piggyback_pixels": null,
                "querystring_mapping": null,
                "querystring_mapping_key_value": {
                    "qs_key": "music_genre",
                    "qs_value": "pop"
                }
            },
            "503": {
                "id": 503,
                "code": null,
                "state": "active",
                "short_name": "rock",
                "description": null,
                "member_id": 201,
                "category": null,
                "price": 0,
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": null,
                "advertiser_id": null,
                "last_modified": "2015-06-02 16:39:40",
                "provider": null,
                "parent_segment_id": null,
                "piggyback_pixels": null,
                "querystring_mapping": null,
                "querystring_mapping_key_value": {
                    "qs_key": "music_genre",
                    "qs_value": "hard rock"
                }
            },
            "504": {
                "id": 504,
                "code": null,
                "state": "active",
                "short_name": null,
                "description": null,
                "member_id": 958,
                "category": null,
                "price": 0,
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": null,
                "advertiser_id": null,
                "last_modified": "2015-06-02 16:39:40",
                "provider": null,
                "parent_segment_id": null,
                "piggyback_pixels": null,
                "querystring_mapping": null,
                "querystring_mapping_key_value": {
                    "qs_key": "music_genre",
                    "qs_value": "funk"
                }
            }
        }
    }
}