PUSH ONE リファレンス
Download OpenAPI specification:
本仕様書は、PUSH ONE サービスで利用する API について説明することを目的とします。
リクエスト制限エラー(429)を除き、エラー時も含め HTTP ステータス 200 を返却します。
エラー判定はレスポンス内の error_code の有無で行ってください(エラー時は result: 1 と error_code を返却)。
※ 正常時に result: 0 を返却するのは配信・配信停止系の API のみです。
result で返却されるコード値(数値)を定義します。
| Value | Description |
|---|---|
| 0 | 処理成功 |
| 1 | 処理失敗 |
error_code で返却されるコード値(数値)を定義します。
| 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 <= 500 items 配信対象のユニークキーの配列を指定します。500件まで指定できます。 |
| service_token required | string CMS で発行されたサービスの Service Token を指定します。 |
| message_name required | string <= 300 characters メッセージ名称を指定します。※CMS 上で表示するタイトルになります。メッセージには利用されません。 |
| message_title required | string メッセージタイトルを指定します。18文字程度が目安。端末によっては表示可能文字数が異なります。140文字を超える部分は切り捨てられます。 |
| message_text required | string メッセージテキストを指定します。20~60文字程度が目安。端末によっては表示可能文字数が異なります。512文字を超える部分は切り捨てられます。 |
| click_url required | string <= 1024 characters メッセージクリック時の遷移先 URL を指定します。 |
| icon_url | string <= 300 characters メッセージアイコンの URL を指定します。http:// または https:// で始まる URL を指定してください。※指定がない場合、CMS で設定したデフォルトアイコンを利用します。デフォルトアイコンも未設定の場合はエラーになります。 |
| delivery_type required | string 配信種別を指定します。 1=予約配信 4=即時配信 |
| send_start_date | string 配信開始日時を日本時間で指定します。形式は YYYY/MM/DD HH:mm(24時間表記)です。※配信種別が予約のとき必須 |
| require_interaction | string 通知を自動で最小化するかの設定 0 =自動で最小化する(デフォルト) 1 =自動で最小化しない |
| large_image_url | string <= 300 characters 追加大型画像 URL を設定します |
object 選択ボタン 1 を設定します。指定する場合は url と text の両方が必須です。 | |
object 選択ボタン 2 を設定します。action1 を指定した場合のみ指定できます。指定する場合は url と text の両方が必須です。 |
{- "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 配信停止対象のメッセージIDの配列を指定します。メッセージIDは数値の文字列で指定してください。 |
{- "service_token": "string",
- "message_ids": [
- "string"
]
}{- "result": 0,
- "messages": [
- {
- "message_id": "1000001",
- "code": "OK"
}, - {
- "message_id": "1000002",
- "code": "INVALID_ARGUMENT"
}
]
}ユニークキーまたはCOINsIdを指定してユニークキー連携設定を解除することができます。
※unique_key と registration_id のどちらか一方は必須です。両方を指定した場合は unique_key が優先され、registration_id は無視されます。
※ユニークキーを指定した場合、該当するすべての配信端末からユニークキー設定が解除されます。(例:ユーザー退会時)
※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 解除対象のユニークキーを指定します。すべての配信端末から該当するユニークキー設定が解除されます。※unique_key と registration_id のどちらか一方は必須です。 |
| registration_id | string 解除対象の配信端末(COINsId)を指定します。特定の端末のみユニークキー設定が解除されます。※unique_key と registration_id のどちらか一方は必須です。unique_key と両方を指定した場合は無視されます。 |
{- "service_token": "string",
- "unique_key": "string",
- "registration_id": "string"
}{ }ユニークキー連携メッセージの一覧を取得します。
オプションでメッセージIDや日付範囲を指定して絞り込みが可能です。
配信開始日時の新しい順に、1ページあたり10件ずつ返却します。
配信停止したメッセージも含みます(レスポンスに配信ステータスは含まれません)。
| X-Account-Token required | string アカウント毎に発行されるトークン |
| Content-Type required | string Value: "application/json" application/json |
| service_token required | string CMS で発行されたサービスの Service Token を指定します。 |
| message_ids | Array of strings <= 500 items 特定のメッセージIDの配列を指定して検索します。500件まで指定できます。メッセージIDは数値の文字列で指定してください。数値でない値が含まれるとエラーになります。 |
| from_send_start_date | string 配信開始日時の範囲(開始)を日本時間で指定します。形式は「YYYY/MM/DD HH:mm(24時間表記)」です。指定した日時は範囲に含みます(以上)。to_send_start_date と両方を指定した場合のみ有効です。to_send_start_date より後の日時を指定するとエラーになります。 |
| to_send_start_date | string 配信開始日時の範囲(終了)を日本時間で指定します。形式は「YYYY/MM/DD HH:mm(24時間表記)」です。指定した日時は範囲に含みません。from_send_start_date と両方を指定した場合のみ有効です。 |
object |
{- "service_token": "string",
- "message_ids": [
- "string"
], - "from_send_start_date": "string",
- "to_send_start_date": "string",
- "pagination": {
- "page": 1
}
}{- "items": [
- {
- "message_id": "10000123",
- "message_name": "テストメッセージ1",
- "message_title": "お知らせ",
- "message_text": "新商品が入荷しました!",
- "require_interaction": "1",
- "send_start_date": "2025-03-20 10:30:00",
- "badge_image_url": "",
- "action2": null
}, - {
- "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": "",
- "action1": null,
- "action2": null
}
], - "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
}
}