Implement key-value segmentation

Page Summary

outlined_flag

• Key-value segmentation is currently in limited access and requires reaching out to your Google account manager.

• It allows you to define custom targeting for users through an ad request.

• You attach key-value pairs to an ad request after setting them up in the AdMob UI.

• You can test your key-value segmentation setup by checking the mediation_group_name in the ad response's response info.

Key-value segmentation lets you define custom targeting to segment users through an ad request. For details on key-value segmentation, such as adding a key-value pair in the AdMob UI, see Add key-value segmentation to a mediation group.

This page guides you through implementing key-value segmentation when configuring an ad request using the Google Mobile Ads Unity SDK.

Before you begin

To set up key-value segmentation in your app, you must first add key-value segmentation to a mediation group.

Attach key-value pairs to an ad request

After setting up your custom key-value pairs in the AdMob UI, attach the pairs to an ad request in your application.

1. Create a key-value pair object representing your custom targeting data.

2. Set the CustomTargeting property of the ad request to this object.

The following example covers the previous steps to segment users by duration in an app:

var daysInApp = 1;

// Step 1: Create the key-value pair dictionary with custom targeting data.
var customTargeting = new Dictionary<string, string> {
  ["USER_DURATION"] = daysInApp < 3 ? "NEW" : "MATURE",
};

// Step 2: Create an ad request with custom targeting.
var request = new AdRequest() {
  CustomTargeting = customTargeting,
};

Test the key-value segmentation setup

To test your implementation on custom key-value pairs, send an ad request and check the response info object. Verify the value of the mediation_group_name field matches your expected mediation group name.

The following example verifies a mediation group name in the ad response:

{
  "Response ID": "r6_DZtitA8Gi2OMPyKeksAI",
  ...
  "Response Extras": {
    "mediation_group_name": "Mediation group for new users"
  }
}