カスタムオーディエンスを広告パートナーに送信するための追加ユーザー識別子を設定します。
追加識別子について
AppsFlyer Audiencesは、広告パートナーにカスタムオーディエンスを送信するため、以下のデバイス識別子に標準で対応しています。
- iOS: IDFA
- Android(Google Play):GAID
- Android(サードパーティのアプリストア):OAIDとIMEI
一部の広告パートナーは、追加のユーザー識別子によるカスタムオーディエンスのマッチングにも対応しています。 AppsFlyer SDKまたはS2S-mobile APIで明示的に設定すると、Audiencesでこれらの識別子を使用できます。
追加識別子には電話番号やメールアドレスなどを使用できますが、SHA256でハッシュ化した場合にのみ利用できます。 追加識別子の使用には、追加識別子の利用規約が適用されます。
次の手順
- 利用可能な識別子の表から、使用する追加識別子を必要に応じて選択します。すべての広告パートナーがすべての識別子に対応しているわけではありません。
- 開発者:以下を参照し、選択した識別子を設定します。
- 利用可能な識別子の表に記載されたパラメータと形式の要件
- SDKとS2Sのリファレンスとコード例
- Audiencesの管理画面で、以下を行います。
- アカウント単位のユーザー識別子の共有ポリシーを設定します。
- 各パートナー接続でアップロードする識別子を選択します。
利用可能な識別子
以下の表から、1つ以上の識別子を選択して設定できます。
追加識別子 | パラメータと形式
| 識別子 | パラメータ名 | 形式 | ハッシュ化前の値の例 |
| メールアドレス | email_sha256 |
SDK v7.0.0以前:
SDK v7.0.1以降:プレーンテキスト。 SDKが自動的に正規化・ハッシュ化します。 |
name@domain.com |
| 電話番号 (下記の注意を参照) |
v7.0.0以前(またはS2S):phone_number_sha256 v7.0.1以降:phone_number_hashed |
v7.0.0以前(またはS2S):
v7.0.1以降:プレーンテキスト。 SDKが国番号と電話番号を連結し、自動的に正規化・ハッシュ化します。 |
442070313000 |
|
E164形式の電話番号 (下記の注意を参照) |
v7.0.0以前(またはS2S):phone_number_e164_sha256 v7.0.1以降:phone_number_e164_hashed |
v7.0.0以前(またはS2S):
v7.0.1以降:プレーンテキスト。 SDKが国番号と電話番号を連結し、自動的に正規化・ハッシュ化します。 |
+442070313000 |
注意 広告パートナーによって、対応する電話番号の形式が異なります。電話番号を使用する場合は、電話番号とE164形式の電話番号の両方を設定してください。 | |||
SDKリファレンスとコード例
SDK経由でAudiencesの識別子を送信する場合:
- ハッシュ化したメールアドレスや電話番号以外の識別子には、
setAdditionalDataを使用します。 - ハッシュ化したメールアドレスの場合:
- SDK v7.0.1以降:
setUserEmailを使用します。 - SDK v7.0.0以前:
setUserEmailsを使用します。
- SDK v7.0.1以降:
- ハッシュ化した電話番号の場合:
- SDK v7.0.1以降:
setUserPhoneを使用します(推奨)。 - SDK v7.0.0以前:カスタムデータを指定し、
setAdditionalDataを使用します。
- SDK v7.0.1以降:
注意
バージョンによる以下の違いに注意してください。
- メールアドレス:SDK v7.0.1から、setUserEmails(iOS/Android)は完全に削除され、setUserEmailに置き換わりました。非推奨化ではなく、互換性のない変更です。 v7.0.0以前のアプリでは、引き続きsetUserEmailsを使用してください。 v7.0.1以降のアプリでは、setUserEmailへの切り替えが必要です。使用するコード例を選ぶ前に、実装済みのSDKのバージョンを確認してください。
- 電話番号:SDK v7.0.1から、専用のsetUserPhone APIを利用できます。 Advanced Matching用の電話番号識別子を送信する推奨方法です。これは互換性のない変更ではありません。setAdditionalDataも引き続き使用できます。新規実装時やv7.0.1以降へのアップグレード時には、setUserPhoneへの移行を推奨します。 v7.0.0以前にはsetUserPhoneがないため、引き続きsetAdditionalDataを使用する必要があります。
iOS SDKの設定
ハッシュ化した電話番号を追加ユーザー識別子に設定するには:
SDK v7.0.0以前 | setAdditionalData
Objective-C
NSDictionary *customData = @{
@"audiences": @{
@"phone_number_sha256": @"6C91C4C640F6EF0162833260DB4F13DEC0DF2B683092F4DBA7E874BEF1ACEA37",
@"phone_number_e164_sha256":@"F3D7E96C73FB0DE1B66ACFCE541D7AF758FBD4F3FA3AF0EA4E10110000D3625E"
}
};
[[AppsFlyerLib shared] setAdditionalData:customData];Swift
let customData: Dictionary = [
"audiences" : [
"phone_number_sha256":"6C91C4C640F6EF0162833260DB4F13DEC0DF2B683092F4DBA7E874BEF1ACEA37",
"phone_number_e164_sha256":"F3D7E96C73FB0DE1B66ACFCE541D7AF758FBD4F3FA3AF0EA4E10110000D3625E"
]
]
AppsFlyerLib.shared().customData = customData注意
渡す前に、両方の値をSHA-256でハッシュ化する必要があります。
SDK v7.0.1以降 | setUserPhone(推奨)
メソッドのシグネチャ
- (void)setUserPhone:(NSString *_Nonnull)countryCode
phoneNumber:(NSString *_Nonnull)phoneNumber;使用例
Objective-C
[[AppsFlyerLib shared] setUserPhone:@"1" phoneNumber:@"(650) 555-1212"];Swift
AppsFlyerLib.shared().setUserPhone(countryCode: "1", phoneNumber: "(650) 555-1212")注意
国番号と国内電話番号をプレーンテキストで渡してください。国内電話番号には、記号や空白を含められます。 SDKが両方の値を連結し、端末内で正規化・ハッシュ化(SHA-256)します。事前にハッシュ化しないでください。
ハッシュ化したメールアドレスを追加ユーザー識別子に設定するには:
SDK v7.0.0以前
メソッドのシグネチャ
- (void)setUserEmails:(NSArray<NSString *> *_Nullable)userEmails
withCryptType:(EmailCryptType)type;使用例
Objective-C
NSArray *emails = @[@"name@domain.com"];
[[AppsFlyerLib shared] setUserEmails:emails withCryptType:EmailCryptTypeSHA256];Swift
let emails: Array = ["name@domain.com"]
AppsFlyerLib.shared().setUserEmails(emails, with: EmailCryptTypeSHA256)SDK v7.0.1以降
メソッドのシグネチャ
- (void)setUserEmail:(NSString *_Nonnull)email;使用例
Objective-C
[[AppsFlyerLib shared] setUserEmail:@"name@domain.com"];Swift
AppsFlyerLib.shared().setUserEmail("name@domain.com")注意
メールアドレスをプレーンテキストで渡してください。 SDKが端末内で正規化・ハッシュ化(SHA-256)します。事前にハッシュ化しないでください。 1回の呼び出しで指定できるメールアドレスは1つのみです。setUserEmailを再度呼び出すと、以前の値に追加されるのではなく、その値が上書きされます。
Android SDKの設定
ハッシュ化した電話番号を追加ユーザー識別子に設定するには:
SDK v7.0.0以前 | setAdditionalData
Java
HashMap<String, Object> audiences = new HashMap<>();
audiences.put("phone_number_sha256", "6C91C4C640F6EF0162833260DB4F13DEC0DF2B683092F4DBA7E874BEF1ACEA37");
audiences.put("phone_number_e164_sha256", "F3D7E96C73FB0DE1B66ACFCE541D7AF758FBD4F3FA3AF0EA4E10110000D3625E");
HashMap<String, Object> customDataMap = new HashMap<>();
customDataMap.put("audiences", audiences);
AppsFlyerLib.getInstance().setAdditionalData(customDataMap);
Kotlin
val audiences = hashMapOf<String, Any>(
"phone_number_sha256" to "6C91C4C640F6EF0162833260DB4F13DEC0DF2B683092F4DBA7E874BEF1ACEA37",
"phone_number_e164_sha256" to "F3D7E96C73FB0DE1B66ACFCE541D7AF758FBD4F3FA3AF0EA4E10110000D3625E"
)
val customDataMap = hashMapOf<String, Any>("audiences" to audiences)
AppsFlyerLib.getInstance().setAdditionalData(customDataMap)注意
渡す前に、両方の値をSHA-256でハッシュ化する必要があります。
SDK v7.0.1以降 | setUserPhone(推奨)
メソッドのシグネチャ
public abstract void setUserPhone(String countryCode, String phoneNumber);使用例
Java
AppsFlyerLib.getInstance().setUserPhone("1", "(650) 555-1212");Kotlin
AppsFlyerLib.getInstance().setUserPhone("1", "(650) 555-1212")注意
国番号と国内電話番号をプレーンテキストで渡してください。 SDKが両方の値を連結し、端末内で正規化・ハッシュ化(SHA-256)します。事前にハッシュ化しないでください。
ハッシュ化したメールアドレスを追加ユーザー識別子に設定するには:
SDK v7.0.0以前
メソッドのシグネチャ
public abstract void setUserEmails(
AppsFlyerProperties.EmailsCryptType cryptMethod,
String... emails
);使用例
Java
AppsFlyerLib.getInstance().setUserEmails(
AppsFlyerProperties.EmailsCryptType.SHA256,
"name@domain.com",
"another_name@another_domain.com"
);Kotlin
AppsFlyerLib.getInstance().setUserEmails(
AppsFlyerProperties.EmailsCryptType.SHA256,
"name@domain.com",
"another_name@another_domain.com"
);SDK v7.0.1以降
メソッドのシグネチャ
public abstract void setUserEmail(String email);使用例
AppsFlyerLib.getInstance().setUserEmail("name@domain.com");注意
v7.0.1以降では、1回の呼び出しで指定できるメールアドレスは1つのみです。複数のメールアドレスには対応していません。setUserEmailを再度呼び出すと、以前の値に追加されるのではなく、その値が上書きされます。
S2Sリファレンスとコード例
S2S経由でAudiencesの識別子を送信する場合は、すべての識別子(ハッシュ化したメールアドレスを含む)に、custom_dataパラメータを使用します。 1つ以上の識別子を送信できます。
S2Sによる識別子の送信
形式:
- ネストされたJSON
- キーの値は
audiencesである必要があります。 - 以下のコード例のように、すべての値を文字列化する必要があります。
- パラメータ名は、上記の利用可能な識別子の表と一致させてください。
基本形式:
"custom_data" : {
\"audiences\" : {
\"parameter_name_a\" : \"hashed_identifer_a\",
\"parameter_name_a\" : \"hashed_identifer_b\",
\"parameter_name_c\" : \"hashed_identifer_c\"
}
}
ハッシュ化した電話番号とメールアドレスを設定した例:
"custom_data" : {
\"audiences\" : {
\"phone_number_sha256\" : \"6C91C4C640F6EF0162833260DB4F13DEC0DF2B683092F4DBA7E874BEF1ACEA37\",
\"phone_number_e164_sha256\" : \"F3D7E96C73FB0DE1B66ACFCE541D7AF758FBD4F3FA3AF0EA4E10110000D3625E\",
\"email_sha256\" : \"34D31BE18022626DE6B311D6A76E791176D2691B6EEF406F524D8F56364C187A\"
}
}
関連情報
- Audiencesのパートナー接続
- Audiencesのユーザー識別子の共有ポリシー