Back to top

Growth Push API v1

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。サポート対象外 となるため、お問い合わせを頂きましてもお答えしかねますのでご了承ください。APIをご利用の場合は、最新版 Growth Push API v4 をご利用ください.

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

Clients

Clients Object

Name Type Notes
growthbeatApplicationId string Grwothbeat アプリケーションID
growthbeatClientId string Growthbeat クライアントID
id number Growth Push クライアントID
token string デバイストークン
os enum OS ( ios/android )
status enum プッシュ通知ステータス ( unknown/validating/active/inactive/invalid )
environment enum デバイス環境 ( development/production )
applicationId number Growth Push アプリケーションID
code string Growth Push Code

Get Clients

Get Clients
GET/clients{?applicationId}{&secret}{&token}

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

GET https://api.growthpush.com/1/clients?applicationId=&secret=&token=
URI Parameters
HideShow
applicationId
number (required) 

Growth Push アプリケーションID

secret
string (required) 

Growth Push シークレットキー

token
string (required) 

デバイストークン

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 0,
  "code": "DEVICE_CODE",
  "token": "DEVICE_TOKEN",
  "growthbeatClientId": "GROWTHBEAT_CLIENT_ID",
  "growthbeatApplicationId": "GRWOTHBEAT_APPLICATION_ID",
  "os": "ios",
  "status": "unknown",
  "environment": "production",
  "applicationId": 0,
  "created": "2015-02-03 12:34:56"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "code": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "growthbeatClientId": {
      "type": "string"
    },
    "growthbeatApplicationId": {
      "type": "string"
    },
    "os": {
      "type": "string",
      "enum": [
        "ios",
        "android"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "unknown",
        "validating",
        "active",
        "inactive",
        "invalid"
      ]
    },
    "environment": {
      "type": "string",
      "enum": [
        "production",
        "development"
      ]
    },
    "applicationId": {
      "type": "number"
    },
    "created": {
      "type": "string"
    }
  }
}

Create New Client

Create New Client
POST/clients

新規クライアント作成

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

POST https://api.growthpush.com/1/clients
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "applicationId": 0,
  "secret": "SECRET",
  "token": "DEVICE_TOKEN",
  "os": "ios",
  "environment": "production"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "number",
      "description": "Growth Push アプリケーションID"
    },
    "secret": {
      "type": "string",
      "description": "Growth Push シークレットキー"
    },
    "token": {
      "type": "string",
      "description": "デバイストークン"
    },
    "os": {
      "type": "string",
      "enum": [
        "ios",
        "android"
      ],
      "description": "OS"
    },
    "environment": {
      "type": "string",
      "enum": [
        "production",
        "development"
      ],
      "description": "デバイス環境"
    }
  },
  "required": [
    "applicationId",
    "secret",
    "token",
    "os",
    "environment"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 0,
  "code": "DEVICE_CODE",
  "token": "DEVICE_TOKEN",
  "growthbeatClientId": "GROWTHBEAT_CLIENT_ID",
  "growthbeatApplicationId": "GRWOTHBEAT_APPLICATION_ID",
  "os": "ios",
  "status": "unknown",
  "environment": "production",
  "applicationId": 0,
  "created": "2015-02-03 12:34:56"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "code": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "growthbeatClientId": {
      "type": "string"
    },
    "growthbeatApplicationId": {
      "type": "string"
    },
    "os": {
      "type": "string",
      "enum": [
        "ios",
        "android"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "unknown",
        "validating",
        "active",
        "inactive",
        "invalid"
      ]
    },
    "environment": {
      "type": "string",
      "enum": [
        "production",
        "development"
      ]
    },
    "applicationId": {
      "type": "number"
    },
    "created": {
      "type": "string"
    }
  }
}

Update a Client

Update a Client
PUT/clients/{growthPushClientId}

クライアント更新

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

PUT https://api.growthpush.com/1/clients/growthPushClientId
URI Parameters
HideShow
growthPushClientId
number (required) 

Growth Push クライアントID

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "secret": "SECRET",
  "token": "DEVICE_TOKEN",
  "environment": "production"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "secret": {
      "type": "string",
      "description": "GGrowth Push シークレットキー"
    },
    "token": {
      "type": "string",
      "description": "デバイストークン"
    },
    "environment": {
      "type": "string",
      "enum": [
        "production",
        "development"
      ],
      "description": "デバイス環境"
    }
  },
  "required": [
    "secret"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 0,
  "code": "DEVICE_CODE",
  "token": "DEVICE_TOKEN",
  "growthbeatClientId": "GROWTHBEAT_CLIENT_ID",
  "growthbeatApplicationId": "GRWOTHBEAT_APPLICATION_ID",
  "os": "ios",
  "status": "unknown",
  "environment": "production",
  "applicationId": 0,
  "created": "2015-02-03 12:34:56"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "code": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "growthbeatClientId": {
      "type": "string"
    },
    "growthbeatApplicationId": {
      "type": "string"
    },
    "os": {
      "type": "string",
      "enum": [
        "ios",
        "android"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "unknown",
        "validating",
        "active",
        "inactive",
        "invalid"
      ]
    },
    "environment": {
      "type": "string",
      "enum": [
        "production",
        "development"
      ]
    },
    "applicationId": {
      "type": "number"
    },
    "created": {
      "type": "string"
    }
  }
}

Events

Event Object

Name Type Note
goalId number イベントID
timestamp number 作成日時
clientId number Growth Push クライアントID
value string イベント値

Create New Event By Client Id

Create New Event By Client Id
POST/events

新規イベント作成

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

POST https://api.growthpush.com/1/events
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "clientId": 0,
  "code": "CODE",
  "name": "NAME",
  "value": "VALUE"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "clientId": {
      "type": "number",
      "description": "Growth Push クライアントID"
    },
    "code": {
      "type": "string",
      "description": "Growth Push Code"
    },
    "name": {
      "type": "string",
      "description": "イベント名"
    },
    "value": {
      "type": "string",
      "description": "イベント値"
    }
  },
  "required": [
    "clientId",
    "code",
    "name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "goalId": 0,
  "timestamp": 0,
  "clientId": 0,
  "value": "VALUE"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "goalId": {
      "type": "number"
    },
    "timestamp": {
      "type": "number"
    },
    "clientId": {
      "type": "number"
    },
    "value": {
      "type": "string"
    }
  }
}

Create New Event By Token

Create New Event By Token
POST/events

新規イベント作成

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

POST https://api.growthpush.com/1/events
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "applicationId": 0,
  "secret": "Hello, world!",
  "token": "DEVICE_TOKEN",
  "name": "NAME",
  "value": "VALUE"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "number",
      "description": "Growth Push アプリケーションID"
    },
    "secret": {
      "type": "string",
      "description": "Growth Push シークレットキー"
    },
    "token": {
      "type": "string",
      "description": "デバイストークン"
    },
    "name": {
      "type": "string",
      "description": "イベント名"
    },
    "value": {
      "type": "string",
      "description": "イベント値"
    }
  },
  "required": [
    "applicationId",
    "name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "goalId": 0,
  "timestamp": 0,
  "clientId": 0,
  "value": "VALUE"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "goalId": {
      "type": "number"
    },
    "timestamp": {
      "type": "number"
    },
    "clientId": {
      "type": "number"
    },
    "value": {
      "type": "string"
    }
  }
}

Tags

Tag Object

Name Type Note
id number タグID
applicationId number Growth Push アプリケーションID
type enum タグタイプ ( custom/message )
name string タグ名
value string タグ値
invisible boolean 削除フラグ
created string 作成日 ( YYYY-MM-DD HH:mm:ss )

Get Tag

Get Tag
GET/tags{?applicationId}{&secret}{&name}{&limit}{&order}

タグ取得 新規セグメント作成

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

GET https://api.growthpush.com/1/tags?applicationId=&secret=&name=&limit=&order=
URI Parameters
HideShow
applicationId
number (required) 

Grwoth Push アプリケーションID

secret
string (required) 

Growth Push シークレットキー

name
string (required) 

タグ名

limit
number (optional) Default: 100 

リミット

order
string (optional) Default: descoding 

ソート

Choices: ascending descending

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 0,
  "applicationId": 0,
  "type": "custom",
  "invisible": true,
  "created": "2015-02-03 12:34:56"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "applicationId": {
      "type": "number"
    },
    "type": {
      "type": "string",
      "enum": [
        "custom",
        "message"
      ]
    },
    "invisible": {
      "type": "boolean"
    },
    "created": {
      "type": "string"
    }
  }
}

Tag Clients

タグに紐づくクライアントを抽出するAPIです

Tag Client Object

Name Type Note
tagId number タグID
clientId number Growth Push クライアントID
value string タグ値

Get Tag Clients By Tag Id

Get Tag Clients By Tag Id
GET/tags{?tagId}{&secret}{&exclusiveClientId}{&limit}{&order}

タグ取得 新規セグメント作成

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

GET https://api.growthpush.com/1/tags?tagId=&secret=&exclusiveClientId=&limit=&order=
URI Parameters
HideShow
tagId
number (required) 

タグID

secret
string (required) 

Growth Push シークレットキー

exclusiveClientId
number (optional) 

前のページの最後のクライアントID

limit
number (optional) Default: 100 

リミット

order
string (optional) Default: descoding 

ソート

Choices: ascending descending

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "tagId": 0,
    "clientId": 0,
    "value": "VALUE"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Get Tag Client By Client Id

Get Tag Client By Client Id
GET/tags{?clientId}{&code}{&type}{&exclusiveTagId}{&limit}{&order}

タグ取得 新規セグメント作成

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

GET https://api.growthpush.com/1/tags?clientId=&code=&type=&exclusiveTagId=&limit=&order=
URI Parameters
HideShow
clientId
number (required) 

クライアントID

code
string (required) 

クライアントの認証キー

type
string (optional) 

タグタイプ

Choices: custom notification

exclusiveTagId
number (optional) 

前のページの最後のタグのID

limit
number (optional) Default: 100 

リミット

order
string (optional) Default: descoding 

ソート

Choices: ascending descending

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "tagId": 0,
    "clientId": 0,
    "value": "VALUE"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Create New Tags

Create New Tags
POST/tags

タグクライアントの作成 新規セグメント作成

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

  • このAPIは、指定のデバイスにまとめてタグ付けをします。既にタグが登録されている場合は、そのvalueを更新します。

  • リクエスト数は指定したタグの件数分カウントされます。また、Notificationタグは更新する事はできません。

  • 大量のタグを更新することを想定しているため 反映までに時間がかかる場合があります(数時間以上かかる場合があります) 。即時性が必要な場合は、1件ずつのタグ付けを利用してください。

Example URI

POST https://api.growthpush.com/1/tags
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "{\"clientId\"": "\"GROWTH_PUSH_CLIENT_ID\",\"code\":\"GROWTH_PUSH_CODE\",\"tagIdValues\":[{\"tagId\":1,\"value\":\"hoge\"},{\"tagId\":2,\"value\":\"fuga\"}]}"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "{\"clientId\"": {
      "type": "string",
      "description": "JSON"
    }
  },
  "required": [
    "{\"clientId\""
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "tagId": 0,
    "clientId": 0,
    "value": "VALUE"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Create New Tag By Client Id

Create New Tag By Client Id
POST/tags

タグクライアントの作成 新規セグメント作成

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

POST https://api.growthpush.com/1/tags
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "clientId": 0,
  "code": "CODE",
  "name": "NAME",
  "value": "VALUE"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "clientId": {
      "type": "number",
      "description": "Growth Push クライアントID"
    },
    "code": {
      "type": "string",
      "description": "Growth Push Code"
    },
    "name": {
      "type": "string",
      "description": "タグ名"
    },
    "value": {
      "type": "string",
      "description": "タグ値"
    }
  },
  "required": [
    "clientId",
    "code",
    "name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "tagId": 0,
  "clientId": 0,
  "value": "VALUE"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "tagId": {
      "type": "number"
    },
    "clientId": {
      "type": "number"
    },
    "value": {
      "type": "string"
    }
  }
}

Create New Tag By Device Token

Create New Tag By Device Token
POST/tags

タグクライアントの作成

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

POST https://api.growthpush.com/1/tags
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "secret": 0,
  "token": "DEVICE_TOKEN",
  "name": "NAME",
  "value": "VALUE"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "secret": {
      "type": "number",
      "description": "Growth Push シークレットキー"
    },
    "token": {
      "type": "string",
      "description": "デバイストークン"
    },
    "name": {
      "type": "string",
      "description": "タグ名"
    },
    "value": {
      "type": "string",
      "description": "タグ値"
    }
  },
  "required": [
    "secret",
    "token",
    "name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "tagId": 0,
  "clientId": 0,
  "value": "VALUE"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "tagId": {
      "type": "number"
    },
    "clientId": {
      "type": "number"
    },
    "value": {
      "type": "string"
    }
  }
}

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 )

Get Notifications

Get Notifications
GET/notifications{?applicationId}{&secret}{&page}{&limit}

配信一覧所得

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

GET https://api.growthpush.com/1/notifications?applicationId=&secret=&page=&limit=
URI Parameters
HideShow
applicationId
number (required) 

Growth Push アプリケーションID

secret
string (required) 

Growth Push シークレットキー

page
number (optional) Default: 1 

ページ数

limit
number (optional) Default: 100 

リミット

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 0,
    "applicationId": 0,
    "segmentId": 0,
    "tagId": 0,
    "automationId": 0,
    "status": "waiting",
    "created": "2015-02-03 12:34:56",
    "trial": [
      {
        "id": 0,
        "notificationId": 0,
        "automationTrialId": 0,
        "text": "TEXT",
        "sound": true,
        "badge": true,
        "extra": "EXTRA",
        "scheduled": "2015-02-03 12:34:56",
        "status": "standby"
      }
    ],
    "segment": {
      "id": 0,
      "name": "NAME",
      "query": "QUERY",
      "size": 0,
      "invisible": true,
      "modified": "2015-02-03 12:34:56",
      "created": "2015-02-03 12:34:56"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Create New Notification

Create New Notification
POST/notifications

新規配信作成

Deprecation Notice

このAPIは 2016年12月21日 をもって 廃止 となりました。

Example URI

POST https://api.growthpush.com/1/notifications
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "applicationId": 0,
  "secret": "SECRET",
  "query": "{}",
  "text": "text",
  "sound": true,
  "badge": true,
  "extra": "{}",
  "attachNotificationId": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "number",
      "description": "Growth Push アプリケーションID"
    },
    "secret": {
      "type": "string",
      "description": "Growth 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の追加"
    }
  },
  "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