パートナーAPI

APIを介した顧客データの同期

CitrusAdへの顧客データの送信

顧客データをCitrusAdに送信するには、以下のようなコマンドを使用します。なお、以下の customers フィールドのデータはダミーで、説明の例として示しています。

📘

すべて customer オブジェクトフィールドは任意です。フィールドに値を入力せずに customer オブジェクトをプッシュすると、新しい id が生成されます。したがって、 id は指定しないでください（ customer オブジェクトを作成する時）。

フィールド targetingData のすべての値は任意で、小売業者が設定できます。詳しくはリファレンスページをご覧ください。

POST $BASE_URL/v1/customers HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customers": [
        {
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "targetingData": {
            "customer_type": "Corporate"
            }
        }
    ]
}

成功すると、以下のオブジェクトが返されます。

{
    "customers": [
        {
            "targetingData": {
                "customer_type": "Corporate"
            },
            "gender": "Other",
            "teamId": "9be784a8-22fc-4315-a335-b7d2c2494f0a",
            "postcode": "",
            "suburb": "",
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "yearOfBirth": 0
        }
    ]
}

複数顧客の同期

複数の顧客を同期させる場合、各リクエストで最大100個のアイテムを一括で送信できます。リクエストの回数に上限はありません。

顧客ペイロードのプッシュされる順序は、返された結果と同じ順序です。また、インテグレータがバックエンドで維持する顧客表現とデータを一致させることが可能です。

POST $BASE_URL/v1/customers HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customers": [
        {
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "targetingData": {
            "customer_type": "Corporate"
            }
        },
        {
            "id": "c7792468-07ea-4cc3-9b1a-975bb43dfa02",
            "targetingData": {
            "customer_type": "Retail"
            }
        }
    ]
}

成功すると、以下のオブジェクトが返されます。

{
    "customers": [
        {
            "targetingData": {
                "customer_type": "Corporate"
            },
            "gender": "Other",
            "teamId": "9be784a8-22fc-4315-a335-b7d2c2494f0a",
            "postcode": "",
            "suburb": "",
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "yearOfBirth": 0
        },
        {
            "targetingData": {
                "customer_type": "Retail"
            },
            "gender": "Other",
            "teamId": "9be784a8-22fc-4315-a335-b7d2c2494f0a",
            "postcode": "",
            "suburb": "",
            "id": "c7792468-07ea-4cc3-9b1a-975bb43dfa02",
            "yearOfBirth": 0
        }
    ]
}

🚧

gender、postcode、suburb、yearOfBirth フィールド

これらのフィールドはもう使用されておらず、履歴統合のためにのみ残されていることに注意してください。

顧客データの一括取り込み

APIは一度に100件のバッチを受け付けるため、統合の際には、顧客データの最初のバッチを統合用ファイルとして送信することをおすすめします。