日本語

# 任意の集計単位で統計情報を取得する

多くのエンドユーザーにプッシュメッセージやマルチキャストメッセージを送信する場合に、統計情報を集計できる機能です。この集計単位のことを「ユニット」と呼びます。ユニットを作成する手続きはありません。メッセージ送信時に任意のユニット名を付与するだけで、ユニットごとに統計情報を確認できます。

ユニット名を付与してメッセージを送ることでユニットごとの統計情報が取得できる：

ユニットごとの統計情報集計のワークフロー

# メッセージ送信時に任意の集計単位のユニット名を付与する

プッシュメッセージやマルチキャストメッセージを送信する際に、任意の集計単位のユニット名を付与します。プッシュメッセージやマルチキャストメッセージの送信方法について詳しくは、『Messaging APIリファレンス』の「メッセージ」を参照してください。

以下の例では、promotion_aというユニット名を付与してプッシュメッセージを送信しています。

curl -v -X POST https://api.line.me/v2/bot/message/push \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {channel access token}' \
-d '{
    "to": "U4af4980629...",
    "messages":[
        {
            "type": "text",
            "text": "Hello, world1"
        }
    ],
    "customAggregationUnits": [
        "promotion_a"
    ]
}'
ユニット名の後付けや変更について

既に送信したメッセージに後からユニット名を付与したり、ユニット名を変更したりすることはできません。

ユニット名を付与するときは吹き出しの内容を揃えましょう

同じユニット名を付与してメッセージを送ると、メッセージの内容や吹き出し数、吹き出しの順番が異なっていても、統計情報はまとめて集計されます。同一のユニット名を付与した複数のメッセージを送るときは、吹き出しの内容を揃えて送ることをおすすめします。

# 利用できるユニット数の上限

ユニットには、1つのチャネルにつき当月中に最大で1,000種類のユニット名を利用できます。ユニットの数は毎月1日にリセットされて、また1からカウントされます。当月中に1,000種類を超えるユニット名を付与した場合、メッセージの送信はできますが、当該ユニット名は付与されていないものとして扱われます。

当月中に利用したユニットの数は、「当月に利用したユニットの数を取得する」で取得できます。

# ユニットごとの統計情報を取得する

ユニット名を付与して送信したプッシュメッセージやマルチキャストメッセージの統計情報は、「ユニットごとの統計情報を取得する」で取得できます。

以下の例では、promotion_aという名前のユニットの統計情報を取得しています。

curl -v -X GET https://api.line.me/v2/bot/insight/message/event/aggregation \
-H 'Authorization: Bearer {channel access token}' \
--data-urlencode 'customAggregationUnit=promotion_a' \
--data-urlencode 'from=20210301' \
--data-urlencode 'to=20210331' \
-G

なお、当月中に利用したユニット名は、「当月に利用したユニット名のリストを取得する」で取得できます。