PUSH ONE リファレンス
Download OpenAPI specification:
本仕様書は、PUSH ONE サービスで利用する API について説明することを目的とします。
result で返却されるコード値を定義します。
| Value | Description |
|---|---|
| 0 | 処理成功 |
| 1 | 処理失敗 |
| Value | Description |
|---|---|
| 100 | ヘッダのアカウントトークンエラー |
| 200 | 入力項目エラー |
| 301 | データ登録・更新エラー |
| 302 | データ参照エラー |
| 900 | リクエスト制限エラー |
| 999 | 内部処理エラー |
短時間で大量のリクエストを送信するとリクエスト制限エラーになることがあります。
429 Too Many Requestsエラーが発生した場合は Retry-After ヘッダーの値（秒）を参照して再度リクエストを行ってください。
全体配信、条件を指定して配信メッセージを設定出来ます。
※送信最大ペイロードサイズは3KBとなります。
| X-Account-Token required | string アカウント毎に発行されるトークン |
| Content-Type required | string Value: "application/json" application/json |
required | object |
{- "push_info": {
- "service_token": "string",
- "service_type": "string",
- "message_name": "string",
- "message_title": "string",
- "message_text": "string",
- "click_url": "string",
- "icon_url": "string",
- "delivery_type": "string",
- "send_start_date": "string",
- "condition_operator": "string",
- "condition_id": [
- "string"
], - "segment_id": "string",
- "registration_id": [
- "string"
], - "segments": [
- "string"
], - "require_interaction": "string",
- "large_image_url": "string",
- "group_name": "string",
- "action1": {
- "url": "string",
- "text": "string"
}, - "action2": {
- "url": "string",
- "text": "string"
}
}
}{- "result": "0",
- "message_id": "10009999"
}メッセージを指定して配信を停止させる事が出来ます。
※配信の停止が可能な条件は以下になります。
| X-Account-Token required | string アカウント毎に発行されるトークン |
| Content-Type required | string Value: "application/json" application/json |
required | object |
{- "push_info": {
- "service_token": "string",
- "message_id": [
- "string"
]
}
}{- "result": "0",
- "messages": [
- {
- "message_id": "1000001",
- "code": "OK"
}, - {
- "message_id": "1000002",
- "code": "INVALID_ARGUMENT"
}
]
}ユニークキーを指定して配信メッセージを送信できます。
ユニークキーはJavaScriptSDKのユニークキー設定で設定できます。
※送信最大ペイロードサイズは3KBとなります。
| X-Account-Token required | string アカウント毎に発行されるトークン |
| Content-Type required | string Value: "application/json" application/json |
| unique_keys required | Array of strings 配信対象のユニークキーの配列を指定します。 |
| service_token required | string CMS で発行されたサービスの Service Token を指定します。 |
| message_name required | string <= 300 characters メッセージ名称を指定します。※CMS 上で表示するタイトルになります。メッセージには利用されません。 |
| message_title required | string メッセージタイトルを指定します。18文字程度が目安。端末によっては表示可能文字数が異なります。 |
| message_text required | string メッセージテキストを指定します。20~60文字程度が目安。端末によっては表示可能文字数が異なります。 |
| click_url required | string メッセージクリック時の遷移先 URL を指定します。 |
| icon_url | string メッセージアイコンの URL を指定します。※指定がない場合、CMS で設定したデフォルトアイコンを利用 |
| delivery_type required | string 配信種別を指定します。 １＝予約配信 ４＝即時配信 |
| send_start_date | string 配信開始日時を指定します。形式は YYYY/MM/DD hh:mm です。※配信種別が予約のとき必須 |
| require_interaction | string 通知を自動で最小化するかの設定 0 ＝自動で最小化する（デフォルト） 1 ＝自動で最小化しない |
| large_image_url | string 追加大型画像 URL を設定します |
object | |
object |
{- "unique_keys": [
- "string"
], - "service_token": "string",
- "message_name": "string",
- "message_title": "string",
- "message_text": "string",
- "click_url": "string",
- "icon_url": "string",
- "delivery_type": "string",
- "send_start_date": "string",
- "require_interaction": "string",
- "large_image_url": "string",
- "action1": {
- "url": "string",
- "text": "string"
}, - "action2": {
- "url": "string",
- "text": "string"
}
}{- "result": "0",
- "message_id": "10009999"
}メッセージIDを指定してユニークキー連携配信を停止させることができます。
※配信の停止が可能な条件は以下になります。
| X-Account-Token required | string アカウント毎に発行されるトークン |
| Content-Type required | string Value: "application/json" application/json |
| service_token required | string CMS で発行されたサービスの Service Token を指定します。 |
| message_ids required | Array of strings <= 500 items 特定のメッセージIDを指定して検索します。最大500件まで指定可能です。 |
{- "service_token": "string",
- "message_ids": [
- "string"
]
}{- "result": "0",
- "messages": [
- {
- "message_id": "1000001",
- "code": "OK"
}, - {
- "message_id": "1000002",
- "code": "INVALID_ARGUMENT"
}
]
}ユニークキーまたはCOINsIdを指定してユニークキー連携設定を解除することができます。
※ユニークキーを指定した場合、該当するすべての配信端末からユニークキー設定が解除されます。（例：ユーザー退会時）
※COINsIdを指定した場合、特定の配信端末のみユニークキー設定が解除されます。（例：ユーザーログアウト時）
| X-Account-Token required | string アカウント毎に発行されるトークン |
| Content-Type required | string Value: "application/json" application/json |
| service_token required | string CMS で発行されたサービスの Service Token を指定します。 |
| unique_key | string 解除対象のユニークキーを指定します。すべての配信端末から該当するユニークキー設定が解除されます。 |
| registration_id | string 解除対象の配信端末（COINsId）を指定します。特定の端末のみユニークキー設定が解除されます。 |
{- "service_token": "string",
- "unique_key": "string",
- "registration_id": "string"
}{ }ユニークキー連携メッセージの一覧を取得します。
オプションでメッセージIDや日付範囲を指定して絞り込みが可能です。
| X-Account-Token required | string アカウント毎に発行されるトークン |
| Content-Type required | string Value: "application/json" application/json |
| service_token required | string CMS で発行されたサービスの Service Token を指定します。 |
| message_ids required | Array of strings <= 500 items 特定のメッセージIDを指定して検索します。最大500件まで指定可能です。 |
| from_send_start_date required | string <date-time> 配信開始日時の範囲（開始）を指定します。形式は「YYYY/MM/DD hh:mm:ss」です。 |
| to_send_start_date required | string <date-time> 配信開始日時の範囲（終了）を指定します。形式は「YYYY/MM/DD hh:mm:ss」です。 |
{- "service_token": "string",
- "message_ids": [
- "string"
], - "from_send_start_date": "2019-08-24T14:15:22Z",
- "to_send_start_date": "2019-08-24T14:15:22Z"
}{- "items": [
- {
- "message_id": "10000123",
- "message_name": "テストメッセージ1",
- "message_title": "お知らせ",
- "message_text": "新商品が入荷しました！",
- "require_interaction": "1",
- "send_start_date": "2025/03/20 10:30:00",
}, - {
- "message_id": "10000124",
- "message_name": "テストメッセージ2",
- "message_title": "セール情報",
- "message_text": "期間限定セール開催中！",
- "require_interaction": "0",
- "send_start_date": "2025/03/19 15:00:00",
- "large_image_url": "",
- "badge_image_url": ""
}
], - "pagination": {
- "has_next": true
}
}指定したユニークキーに紐づいている全てのCOINsId（registration_id）を取得します。
これにより、特定のユニークキーがどの端末に関連付けられているかを確認できます。
| X-Account-Token required | string アカウント毎に発行されるトークン |
| Content-Type required | string Value: "application/json" application/json |
| service_token required | string CMS で発行されたサービスの Service Token を指定します。 |
| unique_key required | string 関連するCOINsIdを取得したいユニークキーを指定します。 |
{- "service_token": "string",
- "unique_key": "string"
}{- "count": 2,
- "registration_ids": [
- "registration_id1",
- "registration_id2"
]
}ユニークキー連携配信のサマリ情報を取得します。
配信数や表示数、クリック数などの統計情報を日付ごとに取得できます。
| X-Account-Token required | string アカウント毎に発行されるトークン |
| Content-Type required | string Value: "application/json" application/json |
| service_token required | string CMS で発行されたサービスの Service Token を指定します。 |
| message_id required | string 統計情報を取得するメッセージIDを指定します。 |
{- "service_token": "string",
- "message_id": "string"
}{- "item": {
- "date": "2025/03/21 00:00:00",
- "progress_status": "completed",
- "optin_count": 7,
- "distribution_count": 3,
- "display_count": 3,
- "click_count": 1,
- "os_unknown_count": 0,
- "os_windows_count": 0,
- "os_ios_count": 0,
- "os_mac_count": 0,
- "os_android_count": 0,
- "browser_unknown_count": 0,
- "browser_safari_count": 0,
- "browser_chrome_count": 0,
- "browser_ie_count": 0,
- "browser_edge_count": 0,
- "browser_firefox_count": 0,
- "device_pc_count": 0,
- "device_sp_count": 0,
- "device_tab_count": 0,
- "display_os_unknown_count": 0,
- "display_os_windows_count": 1,
- "display_os_ios_count": 0,
- "display_os_mac_count": 1,
- "display_os_android_count": 1,
- "display_browser_unknown_count": 0,
- "display_browser_safari_count": 0,
- "display_browser_chrome_count": 3,
- "display_browser_ie_count": 0,
- "display_browser_edge_count": 0,
- "display_browser_firefox_count": 0,
- "display_device_pc_count": 2,
- "display_device_sp_count": 1,
- "display_device_tab_count": 0,
- "click_os_unknown_count": 0,
- "click_os_windows_count": 0,
- "click_os_ios_count": 0,
- "click_os_mac_count": 1,
- "click_os_android_count": 0,
- "click_browser_unknown_count": 0,
- "click_browser_safari_count": 0,
- "click_browser_chrome_count": 1,
- "click_browser_ie_count": 0,
- "click_browser_edge_count": 0,
- "click_browser_firefox_count": 0,
- "click_device_pc_count": 1,
- "click_device_sp_count": 0,
- "click_device_tab_count": 0
}
}