送信したメッセージの統計情報を取得する

# 送信したメッセージの統計情報を取得する

複数のユーザーに送信したプッシュメッセージやマルチキャストメッセージについて、ユーザーがメッセージをどのように操作したかを示す統計情報を、ユニットごとに集計できます。

通常、プッシュメッセージやマルチキャストメッセージでは、ユーザーのプライバシー保護の観点から、メッセージの開封やURLのタップなど、ユーザーがメッセージに対して行った操作については、統計情報を取得できません。しかし、任意の「ユニット」単位で情報を集計し、個人が特定できない形にすることで、統計情報の取得が可能です。

下図のように、ユニット名を付与してメッセージを送信することで、ユニットごとのメッセージの統計情報を取得できるようになります。

# メッセージの統計情報とは

メッセージについて、ユニットごとに以下のような統計情報が取得できます。

メッセージを開封した人数
メッセージ内のいずれかのURLをタップした人数
メッセージ内のいずれかの動画または音声の再生を開始した人数

メッセージの統計情報を取得することで、送信したメッセージに対してユーザーがどのような操作をしたかを知ることができます。このような統計情報を用いることで、以下のような情報を確認できます。

取得した統計情報を用いた例

送信対象の人数	開封数	開封率	URLタップ数	URLタップ率
500	433	87%	323	65%

# 集計される統計情報についての注意点

統計情報の数値は、多少の誤差を含むことがあります。またプライバシーを保護するため、次のような場合、個人の操作に関する統計情報の値はnullになります。

集計された統計情報の値が20未満だった場合。
集計された統計情報の値が20以上であっても、そのイベントを発生させた実人数が20人未満だった場合。
- たとえば、動画が再生開始された回数が30回だったとしても、動画を再生開始した人数が15人だった場合は、どちらの値もnullになります。

# ユニット名を付与する

統計情報を取得するには、プッシュメッセージやマルチキャストメッセージを送信する際に、任意の集計単位のユニット名を付与する必要があります。ユニット名を付与するには、プッシュメッセージやマルチキャストメッセージの送信時に、リクエストボディのcustomAggregationUnitsプロパティにユニット名を指定してください。メッセージ送信時に指定できるユニット名は1つだけです。プッシュメッセージやマルチキャストメッセージの送信方法について詳しくは、『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種類のユニット名を付与してメッセージを送信できます。

たとえば3月にpromotion_0001からpromotion_1000まで1,000種類のユニット名を付与してメッセージを送信したとします。その場合、翌月（4月）に同じpromotion_0001からpromotion_1000までの1,000種類のユニット名を付与してメッセージを送信することも可能ですし、新しいユニット名であるpromotion_1001からpromotion_2000までの1,000種類を付与してメッセージを送信することも可能です。

なお、1,001種類目以降のユニット名を付与してメッセージを送ると、そのユニット名はメッセージに付与されていないものとして扱われます。たとえばpromotion_0001からpromotion_1500まで1,500種類のユニット名を付与してメッセージを送ろうとした場合、1,001種類目となるpromotion_1001以降については、メッセージは送信されますがユニット名はメッセージに付与されません。

当月中に付与したユニット名の数は、「当月中に付与したユニット名の種類数を取得する」エンドポイントで取得できます。

ユニット名の制限について

ユニット名を付与する際には「当月中に最大で1,000種類まで」という制限がありますが、メッセージの送信後にユニットごとの統計情報を取得する際には、fromからtoまでの集計対象期間に存在するすべてのユニットの統計情報が取得できます。

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

ユニット名を付与して送信したプッシュメッセージやマルチキャストメッセージの統計情報は、「ユニットごとの統計情報を取得する」エンドポイントで取得できます。以下の例では、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

なお、当月中に付与したユニット名は、「当月に付与したユニット名のリストを取得する」エンドポイントで取得できます。前月以前に付与したユニット名を確認するためのエンドポイントはありません。

# URLを含むメッセージの統計情報を取得する例

以下の手順は、URLを含むメッセージの統計情報をユニットごとに取得する例です。

# 1. ユニット名を付与してメッセージを送信する

まず、複数のユーザーに同じ内容のメッセージを送ります。

ここでは、マルチキャストメッセージを使って、150人のユーザーにメッセージを送るとします。このとき、customAggregationUnitsプロパティでユニット名を指定します。

curl -v -X POST https://api.line.me/v2/bot/message/multicast \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {channel access token}' \
-d '{
    "to": ["U4af4980629...","U0c229f96c4...",...], // 150件のユーザーID
    "messages":[
        {
            "type": "text",
            "text": "🆕 新商品が入荷しました！\nhttps://example.com/new-item/"
        }
    ],
    "customAggregationUnits": [
        "new-item-message-yyyymmdd"
    ]
}'

# 2.　統計情報を取得して集計する

メッセージを送信してから数日待ち、ユニットごとの統計情報を取得します。

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

この例では、以下のような統計情報が取得できます。

{
  "overview": {
    "uniqueImpression": 111,
    "uniqueClick": 74,
    "uniqueMediaPlayed": null,
    "uniqueMediaPlayed100Percent": null
  },
  "messages": [
    {
      "seq": 1,
      "impression": 111,
      "uniqueImpression": 111,
      "mediaPlayed": null,
      "mediaPlayed25Percent": null,
      "mediaPlayed50Percent": null,
      "mediaPlayed75Percent": null,
      "mediaPlayed100Percent": null,
      "uniqueMediaPlayed": null,
      "uniqueMediaPlayed25Percent": null,
      "uniqueMediaPlayed50Percent": null,
      "uniqueMediaPlayed75Percent": null,
      "uniqueMediaPlayed100Percent": null
    }
  ],
  "clicks": [
    {
      "seq": 1,
      "url": "https://example.com/new-item/",
      "click": 74,
      "uniqueClick": 74,
      "uniqueClickOfRequest": 74
    }
  ]
}

これらの情報を用いて、メッセージの開封率や、URLのタップ率などを確認できます。

送信対象の人数	開封数	開封率	URLタップ数	URLタップ率
150	111	74%	74	67%

# ナローキャストメッセージまたはブロードキャストメッセージの統計情報を取得する

「ユーザーの操作に基づく統計情報を取得する」エンドポイントを使うことで、LINE公式アカウントから送信したナローキャストメッセージまたはブロードキャストメッセージに対して、ユーザーがどのように操作したかを示す統計情報を確認できます。詳しくは、『Messaging APIリファレンス』の「ユーザーの操作に基づく統計情報を取得する」を参照してください。