Mediation

Manage Placements

Create New Placement πŸ”—

  1. Navigate to Mediation > Placements. You will be redirected to the Helium dashboard.
  2. Select an app on the top right dropdown. Then click New Placement +. If an app is not selected, you will be prompted to import an app.
  3. Select an Ad Format.
  4. Select a a pre-defined Ad Placement Name or create your own custom name.
    • Custom name has a maximum of 50 characters and only numbers, letters, and hyphens are allowed.
    • The Ad Placement Name will be used in the Mediation SDK integration.
  5. Set the Creative Types setting.

Advanced Settings πŸ”—

Creative Types πŸ”—

All creative types are allowed by default. Allowing all creative types will help maximize your earnings. See Ad Formats for more information on creative type to ad type compatilibities.

A/B Test πŸ”—

Enabling A/B test for this placement to experiment and determine what settings is most effective.

Best practice is to not enable A/B test until you finish setting up both Bidding and/or Waterfall within the placement.

Rewarded Callbacks πŸ”—

When creating or editing a Rewarded placement, you will see a new toggle for configuring a rewarded callback under Advanced Settings. Click the toggle to enable rewarded callbacks on your placement.

Here you will be able to configure the following options:

Option Definition
Method The HTTP method to make the callback request with. Both GET and POST are supported
Max Retries The number of times Mediation will retry the callback if your server does not respond with a 200 OK. min=0, max=10
URL The URL to make the callback request to. Must be <https://>
Body Optional field that is only available when the method is POST. Supports the same macros as URL

Supported Macros πŸ”—

The following macros can be appended to the URL or the Body when using the POST method.

Macro Definition Required?
%%TRANSACTION_ID%% A unique impression ID associated with the rewarded event Required
%%SERVER_TIMESTAMP%% A UNIX timestamp set by the Mediation server when the event is processed Required
%%USER_ID%% A publisher specific user ID associated Required
%%VERIFICATION%% A SHA256 hash encrypted with your rewarded secret key by the Mediation server Required
%%SDK_TIMESTAMP%% A UNIX timestamp set by the Mediation SDK when the event is processed Optional
%%CPM_PRICE%% The CPM price of the ad unit that was served Optional
%%AD_REVENUE%% The actual ad revenue value from the impression. CPM_PRICE / 1000 Optional
%%CUSTOM_DATA%% A key value JSON payload provided via the SDK that contains custom data Optional

Make sure all the required macros are present otherwise you will not be able to save the callback.

An example of a URL containing all the required macros:

https://myserver.com/page?id=%%TRANSACTION_ID%%&user=%%USER_ID%%&hash=%%VERIFICATION%%&ts=%%SERVER_TIMESTAMP%%

Creating a Rewarded Secret Key πŸ”—

To create or obtain your account’s secret key, it is available under Tools β†’ General Settings

Verifying rewarded callbacks on the publisher server πŸ”—

When a rewarded ad is shown, Mediation will ping your server’s endpoint. An example of a Body containing all the required macros:

{
   "tx": "%%TRANSACTION_ID%%",
   "usr": "%%USER_ID%%",
   "sdk": %%SDK_TIMESTAMP%%,
   "svt": %%SERVER_TIMESTAMP%%,
   "hash": "%%VERIFICATION%%"
}

When you receive the callback, you can verify that the request is authentic by regenerating the %%VERIFICATION%% hash with the following method:

message = %%SERVER_TIMESTAMP%% + %%TRANSACTION_ID%% + %%USER_ID%%
  SHA256(secret_key, message)

Note that the secret key will be the same value available from Tools in the Dashboard. You will then need to verify that the result of the operation above equals the value of the %%VERIFICATION%% hash.

Bidding Settings πŸ”—

Adding Bidding Networks πŸ”—

Review our Partner Network Details chart for a complete list of available bidding networks and instructions on connecting their network with Chartboost Mediation.

  • Make sure the network partner credentials here exactly match the information in your account on each network dashboard.
  • Make sure all desired bidding networks are active.

eCPM Floor πŸ”—

  • If you are using bidding only in this Mediation placement, you can enable eCPM floor by either setting a global floor or country-specific floors.
  • Country level eCPM floor takes precedence over the global eCPM floor. For any countries that don’t have country level eCPM floor, the Mediation will use the global eCPM floor.
  • If you are using both bidding and waterfall in this Mediation placement, you should not enable eCPM floor, since you would want bidding partners to compete in all ad requests with non-bidding networks/line items.

Waterfall Settings πŸ”—

Each waterfall can contain a set of ad groups specific to an ad format type. Each ad group will contain a set of line items which is a specific partner network ad placement.

A single app can have multiple waterfalls for different use case needs.

To get started, click on + Add under Ad Groups and select + Create a new Ad Group. Existing ad groups can also be linked to this placement.

Ad Groups πŸ”—

  1. Give your ad group a Name that is easily identifiable for you.
  2. You cannot change the Type (Ad Format) of an ad group.
  3. Set the country list to target. To set a specific list of country, choose Include specified countries or Exclude specified countries in the dropdown. Then, in the Select Country dropdown, select the country to include/exclude and click the + button.

Line Items πŸ”—

Line Items are specific to a partner network. Review our Partner Network Details chart for a complete list of available waterfall networks and instructions on connecting their network and partner placement with Chartboost Mediation.

Make sure your line items are added to the group.

  1. Click + Add a line item to bring up existing line items.
  2. Check the Add to Ad Group box in the network partner placements row.
  3. Click + Add Selected Items button on the bottom right corner

Last modified November 27, 2023