ユーザーのプロフィール情報を取得する
Messaging API、LINEログイン、LINE Front-end Framework（LIFF）、およびLINEミニアプリでは、ユーザーのプロフィール情報を取得できます。
取得できるプロフィール情報の種類は、取得方法によって異なります。またメールアドレスや住所のように、取得するためには別途の申請や契約が必要なプロフィール情報もあります。
このページでは、ユーザーのプロフィール情報の種類と、その取得方法について説明します。
ユーザーのプロフィール情報とは
ユーザーはLINEアプリの［設定］>［プロフィール］から、名前やプロフィール画像といったプロフィール情報を設定できます。［プロフィール］で設定できる情報について詳しくは、LINEヘルプセンターの「プロフィールとは？」を参照してください。
この［プロフィール］の他に、次のようなプロフィール情報があります。
共通プロフィール
共通プロフィールとは、LINEアプリやYahoo! JAPANに登録しているプロフィール情報を組み合わせて作るプロフィールです。ユーザーはアカウントセンターで共通プロフィールを設定できます。
共通プロフィールについて詳しくは、『LINEみんなの使い方ガイド』の「共通プロフィールを設定してクイック入力を利用する」を参照してください。
LINE Profile+
通常のプロフィール情報に加えて、ユーザーはLINEアプリの［設定］>［プロフィール］>［LINE Profile+］から、住所や電話番号といった追加の情報を登録することもできます。
［LINE Profile+］では、以下の情報を設定できます。
- 氏名（姓、名、ミドルネーム、フリガナなど）
- 性別
- 誕生日（［設定］>［プロフィール］>［誕生日］で登録した情報がLINE Profile+にも表示されます）
- 電話番号（［設定］>［アカウント］>［電話番号］で登録した情報がLINE Profile+にも表示されます）
- メールアドレス（［設定］>［アカウント］>［メールアドレス］で登録した情報がLINE Profile+にも表示されます）
- 住所（郵便番号、都道府県、市区町村、番地など）
ユーザーはLINE Profile+にこれらの情報を登録しておくことで、LINEのファミリーアプリや外部サービスの利用時に住所や電話番号などの面倒な手入力を省くことができます。詳しくは、LINEヘルプセンターの「プロフィールとは？」にある「LINE Profile+」を参照してください。
LINE Profile+に登録されたプロフィール情報を利用する方法については、『法人ユーザー向けオプションドキュメント』の「LINE Profile+」を参照してください。
プロフィール情報を取得する方法
LINEプラットフォームでは、以下の方法でユーザーのプロフィール情報を取得できます。
- 方法1. Messaging APIの「プロフィール情報を取得する」エンドポイントで取得する
- 方法2. LINEログインの「ユーザー情報を取得する」エンドポイントで取得する
- 方法3. LINEログインの「ユーザープロフィールを取得する」エンドポイントで取得する
- 方法4. LINEログインのIDトークンのペイロードで取得する
- 方法5. LIFFのliff.getProfile()メソッドで取得する
- 方法6. LIFFのliff.getDecodedIDToken()メソッドのペイロードで取得する
- 方法7. LINEミニアプリの「共通プロフィールのクイック入力」で取得する
方法1から方法6では、LINEのプロフィールやLINE Profile+の情報を取得できます。方法7では、共通プロフィールの情報を取得できます。
なお取得できる情報はメインプロフィールのみです。ユーザーのサブプロフィールは取得できません。
それぞれの方法で取得できるプロフィール情報の種類については、「取得できるプロフィール情報の種類」を参照してください。
取得できるプロフィール情報の種類
取得できるプロフィール情報の種類は、取得方法によって異なります。
以下の表は、「プロフィール情報を取得する方法」で説明した方法1から方法7で、それぞれ取得できるプロフィール情報の種類を示しています。
| 方法1 Messaging APIの 「プロフィール情報を取得する」 | 方法2 LINEログインの 「ユーザー情報を取得する」 | 方法3 LINEログインの 「ユーザープロフィールを取得する」 | 方法4 LINEログインの IDトークンのペイロード | 方法5 LIFFの liff.getProfile() | 方法6 LIFFのliff.getDecodedIDToken()の ペイロード | 方法7 LINEミニアプリの 「共通プロフィールのクイック入力」 | |
|---|---|---|---|---|---|---|---|
| ユーザーID | ✅（userId） | ✅（sub） | ✅（userId） | ✅（sub） | ✅（userId） | ✅（sub） | ❌ |
| 表示名 | ✅（displayName） | ✅（name） | ✅（displayName） | ✅（name） | ✅（displayName） | ✅（name） | ❌ |
| プロフィール画像 | ✅（pictureUrl） | ✅（picture） | ✅（pictureUrl） | ✅（picture） | ✅（pictureUrl） | ✅（picture） | ❌ |
| ステータスメッセージ | ✅（statusMessage） | ❌ | ✅（statusMessage） | ❌ | ✅（statusMessage） | ❌ | ❌ |
| 言語 | ✅（language） | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| メールアドレス | ❌ | ❌ | ❌ | ✅（email） | ❌ | ✅（email） | ✅（email） |
| 氏名 | ❌ | ❌ | ❌ | ✅（given_name、family_nameなど） | ❌ | ✅（given_name、family_nameなど） | ✅（given-name、family-nameなど） |
| 性別 | ❌ | ❌ | ❌ | ✅（gender） | ❌ | ✅（gender） | ✅（sex-enum） |
| 誕生日 | ❌ | ❌ | ❌ | ✅（birthdate） | ❌ | ✅（birthdate） | ✅（bday-year、bday-monthなど） |
| 住所 | ❌ | ❌ | ❌ | ✅（address） | ❌ | ✅（address） | ✅（address-level1、address-level2など） |
| 電話番号 | ❌ | ❌ | ❌ | ✅（phone_number） | ❌ | ✅（phone_number） | ✅（tel） |
方法4および方法6でメールアドレスを取得するには、メールアドレス取得権限の申請が必要です。詳しくは、『LINEログインドキュメント』の「メールアドレスの取得権限を申請する」を参照してください。
また、方法4および方法6で氏名、性別、誕生日、住所、電話番号を取得するには、法人ユーザー向けオプションであるLINE Profile+の利用契約が必要です。LINE Profile+の利用契約について詳しくは、『法人ユーザー向けオプションドキュメント』の「LINE Profile+」を参照してください。
方法7でプロフィール情報を取得するには、クイック入力の利用申請が必要です。クイック入力の利用申請について詳しくは、『LINEミニアプリドキュメント』の「共通プロフィールのクイック入力の概要」を参照してください。