Notification API クエリ指定方法

Growth Push Notification APIに使用するクエリの仕様を説明いたします。

セグメントには、タグ・イベント・セグメントをかけ合わせて組み合わせることができます。タグ・イベント・セグメントによって、クエリ形式の指定が異なります。またクエリは、Object型ではなく、文字列型をとっており、その文字列をJSON形式で指定する必要がございます。

タグセグメントの指定方法

Parameter	Value	Note
type	tag	タグ指定は必ず `tag` と入力してください。
tagId	任意のタグID	管理画面から tagId を確認してください
operator	equal(=) / begin_witch(前方一致) / less_equal(>=) / less_than(<) / greater_qeual(>=) / greater_than(>) / exist(存在) / in(含む)	指定する value に合わせて変更してください
value	任意の値	抽出するタグの値

1. 男性ユーザー

{"type":"tag","tagId":2,"operator":"equal","value":"male"}

2. 指定のタグが紐づいているユーザー

{"type":"tag","tagId":3,"operator":"exist"}

2. 指定のタグに xxxx,YYYY,ZZzzAA…… の value が紐づいているユーザー (valueの値は 10件以上 指定する必要がございます。)

{"type":"tag","tagId":4,"operator":"in","value":"xxxx,YYYY,ZZzzAA&hellip;&hellip;"}

イベントの指定方法

Parameter	Value	Note
type	event	イベント指定は必ず event と入力してください
goalId	任意のイベントID	管理画面から eventId(goalId) を確認してください
range	relative(相対時間) / absolute(絶対時間)	相対時間もしくは絶対時間を指定できます
begin	relative(現在時刻からの指定時間までのミリ秒) / absolute(YYYY-MM-DD HH:mm:ss)	期限の開始時間を設定します
end	relative(現在時刻からの指定時間までのミリ秒) / absolute(YYYY-MM-DD HH:mm:ss)	期限の終了時間を設定します
aggregation	count(発生回数) / summation(値の合計) / maximu(値の合計) / minimum(値の最小)	イベントの計算方法
operator	equal(=) / begin_witch(前方一致) / less_equal(>=) / less_than(<) / greater_qeual(>=)	指定する value に合わせて変更してください
value	任意の値	aggregation に対する指定値

1. 72時間で1回以上起動しているユーザー

{"type":"event","goalId":1,"range":"relative","aggregation":"count","operator":"greater_equal","value":1.0,"begin":259200000,"end":0}

セグメントの指定方法

Parameter	Value	Note
type	and / or	and 演算子、 or 演算子で計算します
conditions	タグ・イベントの掛けあわせ	JSON形式

1. 男性ユーザー、かつ72時間で1回以上起動しているユーザー

{"type":"and","conditions":[{"type":"tag","tagId":2,"operator":"equal","value":"male"},{"type":"event","goalId":1,"range":"relative","aggregation":"count","operator":"greater_equal","value":1.0,"begin":259200000,"end":0}]}

2. 東京のユーザー、または神奈川のユーザー

{"type":"or","conditions":[{"type":"tag","tagId":4,"operator":"equal","value":"Tokyo"},{"type":"tag","tagId":4,"operator":"equal","value":"Kanagawa"}]}

3. ユーザーID複数して、24時間前の課金合計が5000以上のユーザー

{"type":"and","conditions":[{"type":"tag","tagId":25,"operator":"in","value":"111,23,90,150,72,65,55,1320"},{"type":"event","goalId":5,"range":"relative","aggregation":"summation","operator":"greater_equal","value":50000,"begin":3600000,"end":0}]}

否定セグメント指定方法

Parameter	Value	Note
type	not	論理否定
conditions	タグ・イベントの掛けあわせ	JSON形式

1. 72時間で1回も起動していないユーザー

{"type":"not","condition":{"type":"event","goalId":1,"range":"relative","aggregation":"count","operator":"greater_equal","value":1.0,"begin":259200000,"end":0}}

既存セグメントの指定方法

Parameter	Value	Note
type	segment	セグメント指定の場合は必ず segment と入力してください
segmentId	任意のセグメントID	既に作成済みのセグメントIDを指定してください

1. セグメントを指定かつ、OSがiOSのユーザー

{"type":"and","conditions":[{"type":"segment","segmentId":10},{"type":"tag","tagId":4,"operator":"begin_with","value":"iOS"}]}