Android でカスタム キーワードを渡す

カスタム キーワードは、広告要求に付加される任意のキーと値のペアです。 これらは次の目的で使用できます。

メソッド

広告ユニットごとのキーワード

これらのキーワードは、特定の広告ユニットにスコープされます。

メソッド 説明
public void addCustomKeywords(String key, String value) 指定されたキーに対して 1 つの値を追加します。
public void addCustomKeywords(String key, ArrayList<String> values) 1 回の呼び出しで指定されたキーに対して複数の値を追加します。
public void removeCustomKeyword(String key) 指定したキーに関連付けられているすべての値を削除します。
public void clearCustomKeywords() すべてのカスタム キーワードを削除します。

要求レベルのキーワード

これらのキーワードは、特定の広告ユニットではなく、広告リクエスト全体が対象となります。 ANMultiAdRequestを使用する場合は、個々の広告ユニットではなく、ANMultiAdRequest オブジェクトに直接リクエストレベルのキーワードを設定します。

メソッド 説明
public void addCustomKeywordsTopLevel(String key, String value) 指定されたキーに対して単一の要求レベル値を追加します。
public void addCustomKeywordsTopLevel(String key, ArrayList<String> values) 1 回の呼び出しで、指定されたキーに対して複数の要求レベル値を追加します。
public void removeCustomKeywordTopLevel(String key) 指定されたキーに関連付けられているすべての要求レベルの値を削除します。
public void clearCustomKeywordsTopLevel() リクエストレベルのカスタム キーワードをすべて削除します。

広告ユニットごとのキーワード

これらのキーワードは、特定の広告ユニットにスコープされます。

// Banner
BannerAdView banner = new BannerAdView(this);
banner.addCustomKeywords("foo", "bar"); // Add single value
banner.addCustomKeywords("foo", new ArrayList<>(Arrays.asList("bar", "baz", "foe"))); // Add multiple values
banner.removeCustomKeyword("foo"); // Remove a specific key
banner.clearCustomKeywords(); // Remove all custom keywords
// Native
NativeAdRequest nativeAdRequest = new NativeAdRequest(this, "123456");
nativeAdRequest.addCustomKeywords("foo", "bar"); // Add single value
nativeAdRequest.addCustomKeywords("foo", new ArrayList<>(Arrays.asList("bar", "baz", "foe"))); // Add multiple values
nativeAdRequest.removeCustomKeyword("foo"); // Remove a specific key
nativeAdRequest.clearCustomKeywords(); // Remove all custom keywords

要求レベルのキーワード

リクエストレベルのキーワードを使って、特定の広告ユニットではなく広告リクエスト全体に適用されるターゲティングを添付できます。 ANMultiAdRequest を使用する場合は、これらのキーワードを個々の広告ユニットではなく、ANMultiAdRequest オブジェクトに直接設定します。

注:

ANMultiAdRequestの場合、ANMultiAdRequest オブジェクトに設定されたキーワードにより、個々の広告ユニットに設定されている要求レベルのキーワードがオーバーライドされます。

// Banner
banner.addCustomKeywordsTopLevel("foo", "bar"); // Add single request-level value
banner.addCustomKeywordsTopLevel("foo", new ArrayList<>(Arrays.asList("bar", "baz", "foe"))); // Add multiple request-level values
banner.removeCustomKeywordTopLevel("foo"); // Remove a specific key
banner.clearCustomKeywordsTopLevel(); // Remove all request-level keywords
// Native
nativeAdRequest.addCustomKeywordsTopLevel("foo", "bar"); // Add single request-level value
nativeAdRequest.addCustomKeywordsTopLevel("foo", new ArrayList<>(Arrays.asList("bar", "baz", "foe"))); // Add multiple request-level values
nativeAdRequest.removeCustomKeywordTopLevel("foo"); // Remove a specific key
nativeAdRequest.clearCustomKeywordsTopLevel(); // Remove all request-level keywords