Show Menu
トピック×

ドメイン管理 API メソッド

データ送信先のドメインを作成および管理できるドメイン管理メソッド(Cookie の宛先の場合のみ)。

新しいドメインの作成

新しいドメインを作成できる POST メソッド(Cookie の宛先の場合のみ)。

リクエスト

POST https://api.demdex.com/v1/partner-sites/

リクエストのサンプル

{
   "url":"example1.com"
}

応答

成功すると、 201 created とパートナーサイトが返されます。パートナーサイトの一意の ID もあわせて返されます。
{
    "pid": 1111,
    "siteId": 111,
    "url": "example1.com"
}

ドメインの削除

ドメインを削除できる DELETE メソッド(Cookie の宛先の場合のみ)。

リクエスト

DELETE https://api.demdex.com/v1/partner-sites/ <site-Id>

応答

成功するとレスポンスで 204 no content が返されます。パートナーサイトが見つからない場合は 404 not found が返されます。

ドメインのプロパティを返す

指定されたドメインに関する詳細を返す GET メソッド(Cookie の宛先の場合のみ)。

リクエスト

GET https://api.demdex.com/v1/partner-sites/ <siteId>

応答

成功すると、 200 OK とデータが以下のサンプルのように返されます。サイト ID やパートナーが見つからない場合、 404 Not found が返されます。
{
    "pid": 1111,
    "siteId": 111,
    "url": "example1.com"
}

すべてのドメインのプロパティを返す

すべてのドメインに関する情報を返す GET メソッド(Cookie の宛先の場合のみ)。

リクエスト

GET https://api.demdex.com/v1/partner-sites/

オプションのクエリパラメーター

オブジェクトの​ すべて ​のプロパティを返す API メソッドで、これらのオプションパラメーターを使用できます。そのクエリを API に渡す際に、リクエスト文字列にこれらのオプションを設定します。 オプションのパラメーター を参照してください。
パラメーター 説明
page ページ番号を返します。番号は 0 から始まります。
pageSize リクエストによって返された応答結果の番号を設定します(10 がデフォルト)。
sortBy 指定された JSON プロパティに従って、結果を並べ替えて返します。
descending 結果を降順で並べ替えて返します。昇順がデフォルトです。
search 検索パラメーターとして使用する指定文字列に基づいて結果を返します。例えば、項目の任意のフィールドに「Test」という語があるすべてのモデルの結果を探したい場合は、サンプルリクエストは次のようになります。
`GET` `https://api.demdex.com/v1/models/?search=Test`
「get all」メソッドで返されるすべての値を検索できます。

応答

成功すると、 200 OK とデータが配列で以下のサンプルのように返されます。サイト ID やパートナーが見つからない場合、 404 Not found が返されます。
[
    {
        "pid": 1111,
        "siteId": 111,
        "url": "example1.com"
    },
    {
        "pid": 2222,
        "siteId": 222,
        "url": "example2.com"
    },
    {
        "pid": 3333,
        "siteId": 333,
        "url": "example3.com"
    }
]