オーディエンスAPI¶

オーディエンスAPIを使うと、任意のユーザーID のリストを使ってオーディエンスを作成、もしくは更新することができます。

自社の分析基盤や、他社サービスなどで作成したユーザーIDのリストをReproに登録し、マーケティング施策の配信対象として利用することができます。

注釈

Reproに登録されているユーザーが対象となります。Reproに登録されていないユーザーが含まれている場合は、対象として計上されません。

はじめに¶

現在、オーディエンスAPIでは下記の機能を提供しています。

機能	HTTPメソッド	エンドポイント
新規作成	`POST`	`https://api.reproio.com/v2/audiences`
更新	`PATCH`	`https://api.reproio.com/v2/audiences/<オーディエンスID>`

警告

エンドポイントのドメインが repro.io から reproio.com に変更されます。旧ドメインも引き続きご利用頂けますが、なるべく新しいドメインをご利用ください。

Repro API トークンの確認¶

オーディエンスAPIを使うには、Repro API トークンを使用する必要があります。

設定 > アプリ設定 に行き、 アプリ > Repro API トークン を確認します。

認証¶

取得した Repro API トークンをHTTPヘッダーの X-Repro-Token フィールドに設定してください。

単位時間あたりのアクセス上限¶

リクエストが正常に完了すると、レスポンスの X-RateLimit-Limit ヘッダーに、1分あたりのリクエストの上限回数が記載されます。リクエスト数がこれを超えると、 HTTP Status 429 (Too Many Requests) が返ります。なお、 X-RateLimit-Limit の値は変動する場合があります。

APIフォーマット¶

メッセージをHTTP bodyにJSONフォーマットでセットします。

name: オーディエンス名を指定します。作成時には必須、更新時には任意の項目となります。
user_ids: アプリ内でユーザーID APIを使って登録されたユーザーのIDを配列形式で指定します。

オーディエンスの新規作成¶

オーディエンス新規作成APIはHTTPの POST メソッドを受けつけるエンドポイントと紐付いています。

POST https://api.reproio.com/v2/audiences

ペイロード例¶

{
  "name": "Audience created by API",
  "user_ids": [
    "user-123",
    "user-456",
    "user-789"
  ]
}

レスポンス例¶

オーディエンスの新規作成に成功したら、 201 Created のステータスコードと下記のようなレスポンスボディを持つレスポンスが返されます。

{
  "id": "xxxxxxxx",
  "name": "Audience created by API"
}

オーディエンスの更新¶

オーディエンス更新APIはHTTPの PATCH メソッドを受けつけるエンドポイントと紐付いています。

PATCH https://api.reproio.com/v2/audiences/xxxxxxxx

エンドポイントやRepro API トークンは管理画面のオーディエンスページからも確認できます。

ペイロード例¶

{
  "user_ids": [
    "modified-user-123",
    "modified-user-456",
    "modified-user-789"
  ]
}

レスポンス例¶

オーディエンスの更新に成功したら、 202 Accepted のステータスコードと下記のようなレスポンスボディを持つレスポンスが返されます。

{
  "id": "xxxxxxxx",
  "name": "Audience created by API"
}

オーディエンスAPIのリクエスト¶

リクエストヘッダー

リクエストのヘッダーには、以下の値を設定します。

ヘッダー	説明	必須
Content-Type	application/jsonを指定します。	必須
X-Repro-Token	Repro API トークンの確認で取得したトークンを指定します。	必須

リクエストボディ

メッセージをJSONフォーマットで設定します。

オーディエンスAPIのレスポンス¶

レスポンスヘッダー

レスポンスのヘッダーには、以下の値が含まれます。

ステータス	ヘッダー	説明
正常	`X-RateLimit-Limit`	単位時間あたりのアクセス上限
正常	`X-RateLimit-Remaining`	アクセスできる残り回数
正常	`X-RateLimit-Reset`	アクセス数がリセットされる時刻(unixtime)
リクエスト制限	`Retry-After`	再実行可能になるまでの秒数

レスポンスボディ

ユーザープロフィールAPIをコールした際の、レスポンスに含まれるステータスコードとエラーメッセージの一覧は下記になります。

400 Bad Request¶

リクエストにエラーがあります。エラーメッセージを確認の上、対応してください。

401 Unauthorized¶

Repro API トークンが指定されていません。

レスポンスボディ:

{
  "status": "unauthorized",
  "error": {
    "messages": [
      "Please include your Repro API Token as \"X-Repro-Token\" HTTP header."
    ]
  }
}

403 Forbidden¶

指定した Repro API トークンが間違っています。

レスポンスボディ:

{
  "status": "forbidden",
  "error": {
    "messages": [
      "Please check your Repro API Token as \"X-Repro-Token\" HTTP header."
    ]
  }
}

404 Not Found¶

エンドポイントが存在しません。

レスポンスボディ:

{
  "status": "not_found",
  "error": {
    "messages": [
      "Not found."
    ]
  }
}

429 Too Many Requests¶

リクエスト数が多すぎます。 Retry-After ヘッダーに記載された秒数待った後、リクエストを再開してください。

レスポンスボディ:

{
  "status": "too_many_requests",
  "error": {
    "messages": [
      "Too many requests hit the API too quickly."
    ]
  }
}