Back to top

Growth Push API v2

Growth Push API v2 のドキュメントです.

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。APIをご利用の場合は、最新版 Growth Push API v4 をご利用ください.

詳細は 【重要】12/6再掲：一部のAPI廃止について ブログをご覧ください.

Common Params

Name Type Notes
applicationId number Growth Push アプリケーションID
secret string Growth Push シークレットキー

Notifications

Notification Object

Name Type Note
id number Notification ID
applicationId number Growth Push アプリケーションID
status enum 送信状態 ( waiting/success/failure )
created string 作成日時 ( yyyy-MM-dd HH:mm:ss )
attachNotificationId boolean 指定するとペイロードに “growthpush”:{“notificationId”:xxxxx} という形式で、通知IDが含まれます。
duration number 配信時刻からこの時間以上の時間が経過したpushは配信されずに破棄されます。ミリ秒で指定してください。
trial array[Trial]
segment Segment

Trial Object

Name Type Note
id number トライアルID
notifiationId number Notification ID
automationId number 自動配信ID
text string 配信文言
sound boolean 通知音
badge boolean 通知バッジ
extra boolean ペイロードに任意のパラメータを JSON形式 で指定します。ex. {“url”:"https://growthpush.com"}
scheduled string 配信予定時刻 ( yyyy-MM-dd HH:mm:ss )
status enum 送信状態 ( standby/creating/waiting/pending/sending/completed )

Segment Object

Name Type Note
id number セグメントID
name string セグメント名
query string JSON形式 のセグメント。セグメントには、タグ・イベント・セグメントをかけ合わせて組み合わせることができます。
size number セグメント対象人数 詳細は セグメントの概算人数とは？いつ更新されるのか？ 参照。
invisible boolean 削除フラグ
modified string 作成日時 ( YYYY-MM-DD HH:mm:ss )
created string 作成日時 ( YYYY-MM-DD HH:mm:ss )

Create New Notification

Create New Notification
POST/notifications

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。Notification APIをご利用の場合は、 Growth Push Notification API v3 をご利用ください.

このAPIは、Growth Push の認証キー(secret)を使用します。配信作成時に生成したUUIDをreturnします。

Example URI

POST https://api.growthpush.com/2/notifications
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "applicationId": 0,
  "secret": "SECRET",
  "query": "{}",
  "text": "text",
  "sound": true,
  "badge": true,
  "extra": "{}",
  "attachNotificationId": true,
  "duration": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "number",
      "description": "Growth Push アプリケーションID"
    },
    "secret": {
      "type": "string",
      "description": "Grwoth Push シークレットキー"
    },
    "query": {
      "type": "string",
      "description": "セグメントクエリ"
    },
    "text": {
      "type": "string",
      "description": "テキスト"
    },
    "sound": {
      "type": "boolean",
      "description": "通知音"
    },
    "badge": {
      "type": "boolean",
      "description": "通知バッジ"
    },
    "extra": {
      "type": "string",
      "description": "任意のパラメータを追加"
    },
    "attachNotificationId": {
      "type": "boolean",
      "description": "通知IDの追加"
    },
    "duration": {
      "type": "number",
      "description": "ミリ秒で指定"
    }
  },
  "required": [
    "applicationId",
    "secret"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "jobId": "JOB_ID"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string"
    }
  }
}

Generated by aglio on 27 Feb 2018