AppLovin MAX

https://support.axon.ai/en/max/advanced-features/ad-unit-management-api
Admin
AppLovin MAX is a mobile ad mediation platform that enables app developers to maximize revenue by...
Tokens:21,698
Snippets:145
Trust Score:7.4
Update:5 months ago
Show doc for...
Tokens:
Raw
### Ad Unit Configuration Example

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

This is an example of a complete ad unit configuration, including settings for AdMob, frequency capping, and bid floors. It shows the structure for defining ad networks, capping rules, and country-specific bids.

```json
{
  "id": "e74c3b7797b0ce7a",
  "experiment_name": "add_admob_inter_lines",
  "platform": "ios",
  "ad_format": "INTER",
  "package_name": "com.testapp.test",
  "disabled": false,
  "promote": false,
  "deprecate": false,
  "ad_network_settings": [
    {
      "ADMOB_NETWORK": {
        "disabled": true,
        "ad_network_app_id": "ca-app-pub-3555987499620362~3024971981",
        "ad_network_ad_units": []
      }
    }
  ],
  "frequency_capping_settings": [
    {
      "type": "time",
      "time_capping_settings": {
        "day_limit": 10,
        "minute_frequency": 10
      },
      "session_capping_settings": {
        "session_limit": 0
      },
      "countries" : {
        "type": "INCLUDE",
        "values" : [
          "ca",
          "us"
        ]
      }
    }
  ],
  "bid_floors": [
    {
      "country_group_name": "t1 eng",
      "cpm": "10.00",
      "countries": {
        "type": "INCLUDE",
        "values": [
          "au",
          "ca"
        ]
      }
    }
  ]
}
```

--------------------------------

### Ad Unit Response Body Example

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

This is an example of the JSON response body when retrieving ad units. It includes details such as name, platform, ad format, and ID.

```json
[
  {
    "name": "My Inter Ad Unit",
    "platform": "ios",
    "package_name": "com.test.app",
    "ad_format": "INTER",
    "id": "45de6aa565cf865f",
    "has_active_experiment": false,
    "disabled": false
  },
  {
    "name": "My Rewarded Ad Unit",
    "platform": "android",
    "package_name": "com.test.app",
    "ad_format": "REWARD",
    "id": "565c45df8e6aa65f",
    "has_active_experiment": false,
    "disabled": false
  }
]
```

--------------------------------

### View All Test Devices

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a GET request to view details about all your test devices.

```APIDOC
## GET /test_devices

### Description
Retrieves details about all test devices associated with the account.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/test_devices

### Response
#### Success Response (200)
* **test_devices** (array) - An array of test device objects.
  * **id** (string) - The unique ID of the test device.
  * **device_id** (string) - The device ID.
  * **device_type** (string) - The type of device.
  * **name** (string) - The name of the test device.
  * **created_at** (string) - The timestamp when the test device was created.

#### Response Example
{
  "test_devices": [
    {
      "id": "test_device_id_xyz",
      "device_id": "a1b2c3d4e5f6",
      "device_type": "android",
      "name": "My Test Android Phone",
      "created_at": "2023-10-27T12:00:00Z"
    },
    {
      "id": "test_device_id_uvw",
      "device_id": "fedcba987654",
      "device_type": "ios",
      "name": "Test iPhone",
      "created_at": "2023-10-26T15:00:00Z"
    }
  ]
}
```

--------------------------------

### Example Ad Unit Response Body

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

This is an example of a response body when retrieving ad unit details. It includes configurations for multiple ad networks, frequency capping, bid floors, and segments.

```json
{
  "id": "1234567890abcdef",
  "name": "My Inter Ad Unit",
  "platform": "ios",
  "package_name": "com.test.app",
  "ad_format": "INTER",
  "has_active_experiment": false,
  "disabled": false,
  "ad_network_settings": [
    {
      "FACEBOOK_NETWORK": {
        "disabled": false,
        "ad_network_ad_units": [
           {
             "ad_network_ad_unit_id": "8247030622430922_5618972399256249",
             "disabled": false
           }
        ]
      }
    },
    {
      "ADMOB_NETWORK": {
        "disabled": false,
        "ad_network_app_id": "ca-app-pub-3555987499620362~3024971981",
        "ad_network_ad_units": [
          {
            "ad_network_ad_unit_id": "ca-app-pub-3555987499620362/4382996128",
            "disabled": false,
            "cpm": "30.00",
            "countries": {
              "type": "INCLUDE",
              "values": [
                "us",
                "ca",
                "gb",
                "au"
              ]
            }
          },
          {
            "ad_network_ad_unit_id": "ca-app-pub-3555987499620362/5476585941",
            "disabled": false,
            "cpm": "20.00",
            "countries": {
              "type": "EXCLUDE",
              "values": [
                "us",
                "ca",
                "gb",
                "au"
              ]
            }
          }
        ]
      }
    }
  ],
  "frequency_capping_settings": [
    {
      "type": "time",
      "time_capping_settings": {
        "day_limit": 10,
        "minute_frequency": 10
      },
      "session_capping_settings": {
        "session_limit": 0
      },
      "countries" : {
        "type": "INCLUDE",
        "values" : [
          "ca",
          "us"
        ]
      }
    }
  ],
  "bid_floors": [
    {
      "country_group_name": "t1 eng",
      "cpm": "10.00",
      "countries": {
        "type": "INCLUDE",
        "values": [
          "au",
          "ca",
          "gb",
          "nz",
          "us"
        ]
      }
    },
    {
      "country_group_name": "eea",
      "cpm": "5.00",
      "countries": {
        "type": "INCLUDE",
        "values": [
          "at",
          "pt",
          "ro",
          "se",
          "si",
          "sk"
        ]
      }
    }
  ],
  "banner_refresh_settings":{
    "interval": 0
  },
  "segments":[
    {
      "id": 347324,
      "name": "LAT iPads",
      "id_type": "no_id",
      "device_type": "tablets",
      "segment_keys": [
        [
          "+1:2"
        ]
      ]
    }
  ]
}
```

--------------------------------

### Mintegral Bidding Optional Placement ID Example

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

This example demonstrates how to include an optional Placement ID for Mintegral Bidding using the 'extraParameters' object. The 'ad_network_optional_placement_id' field within 'extraParameters' accommodates this value.

```json
{
  "MINTEGRAL_BIDDING": {
    "disabled": false,
    "targets": {},
    "ad_network_ad_units": [
      {
        "ad_network_ad_unit_id": "1232524",
        "extraParameters": null,
        "disabled": false,
        "cpm": "1.23",
        "countries": {
          "type": "INCLUDE",
          "values": []
        }
      }
    ],
    "ad_network_app_id": "testappId",
    "ad_network_app_key": "testappKey",
    "extraParameters": {
      "ad_network_optional_placement_id": "1234354"
    }
  }
}
```

--------------------------------

### View Test Device Details

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a GET request to view details about a particular test device.

```APIDOC
## GET /test_device/{test-device-ID}

### Description
Retrieves details about a specific test device.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/test_device/{test-device-ID}

### Parameters
#### Path Parameters
* **test-device-ID** (string) - Required - The ID of the test device to retrieve.

### Response
#### Success Response (200)
* **id** (string) - The unique ID of the test device.
* **device_id** (string) - The device ID.
* **device_type** (string) - The type of device.
* **name** (string) - The name of the test device.
* **created_at** (string) - The timestamp when the test device was created.

#### Response Example
{
  "id": "test_device_id_xyz",
  "device_id": "a1b2c3d4e5f6",
  "device_type": "android",
  "name": "My Test Android Phone",
  "created_at": "2023-10-27T12:00:00Z"
}
```

--------------------------------

### View Ad Unit Experiment Details

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a GET request to view details about an ad unit experiment.

```APIDOC
## GET /ad_unit_experiment/{ad-unit-ID}

### Description
Retrieves details about an ad unit experiment.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/ad_unit_experiment/{ad-unit-ID}

### Parameters
#### Path Parameters
* **ad-unit-ID** (string) - Required - The ID of the ad unit for which to retrieve experiment details.

### Response
#### Success Response (200)
* **experiment_id** (string) - The ID of the experiment.
* **status** (string) - The status of the experiment (e.g., ACTIVE, INACTIVE, PENDING).
* **created_at** (string) - The timestamp when the experiment was created.

#### Response Example
{
  "experiment_id": "exp_12345",
  "status": "ACTIVE",
  "created_at": "2023-10-25T14:00:00Z"
}
```

--------------------------------

### Get Experiment Waterfall for Segment

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Retrieves the experiment waterfall configuration for a specific segment ID and ad unit. Use this to test new waterfall setups.

```http
https://o.applovin.com/mediation/v1/ad_unit_experiment/1234567890abcdef/213
```

--------------------------------

### Ad Unit Response Body Example

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

This JSON structure represents a typical response body for ad unit management, including device type and segment keys.

```json
{
  "device_type": "tablets",
  "segment_keys": [
    [
      "+1:2"
    ]
  ]
}
```

--------------------------------

### Get Ad Unit Details

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a GET request to retrieve details about a specific ad unit.

```APIDOC
## GET /ad_unit/{ad-unit-ID}

### Description
Retrieves details about a specific ad unit.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/ad_unit/{ad-unit-ID}

### Parameters
#### Path Parameters
* **ad-unit-ID** (string) - Required - The ID of the ad unit to retrieve.

### Response
#### Success Response (200)
* **id** (string) - The ID of the ad unit.
* **app_id** (string) - The ID of the app.
* **name** (string) - The name of the ad unit.
* **ad_format** (string) - The ad format.
* **created_at** (string) - The timestamp when the ad unit was created.
* **updated_at** (string) - The timestamp when the ad unit was last updated.

#### Response Example
{
  "id": "ad_unit_id_123",
  "app_id": "app_id_abc",
  "name": "My Existing Ad Unit",
  "ad_format": "INTERSTITIAL",
  "created_at": "2023-10-26T09:00:00Z",
  "updated_at": "2023-10-27T11:30:00Z"
}
```

--------------------------------

### Create Experiment Request Body

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

When creating a new experiment, exclude the `id` field or set it to null. This example shows the minimal required fields for experiment creation.

```json
{
  "experiment_name": "test_adjusting_frequency_cap",
  "frequency_capping_settings": […]
}
```

--------------------------------

### View All Ad Units

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a GET request to retrieve details about all your ad units.

```APIDOC
## GET /ad_units

### Description
Retrieves details about all ad units associated with the account.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/ad_units

### Response
#### Success Response (200)
* **ad_units** (array) - An array of ad unit objects.
  * **id** (string) - The ID of the ad unit.
  * **app_id** (string) - The ID of the app.
  * **name** (string) - The name of the ad unit.
  * **ad_format** (string) - The ad format.
  * **created_at** (string) - The timestamp when the ad unit was created.

#### Response Example
{
  "ad_units": [
    {
      "id": "ad_unit_id_123",
      "app_id": "app_id_abc",
      "name": "My Existing Ad Unit",
      "ad_format": "INTERSTITIAL",
      "created_at": "2023-10-26T09:00:00Z"
    },
    {
      "id": "ad_unit_id_456",
      "app_id": "app_id_def",
      "name": "Another Ad Unit",
      "ad_format": "BANNER",
      "created_at": "2023-10-27T08:00:00Z"
    }
  ]
}
```

--------------------------------

### Get Test Devices

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Retrieves a list of test devices configured for the mediation platform. The response format is identical to the `/test_device` endpoint.

```APIDOC
## GET /mediation/v1/test_devices

### Description
Retrieves a list of test devices.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/test_devices

### Response
#### Success Response (200)
- **name** (string) - The name of the test device.
- **device_id** (string) - The unique identifier for the test device.
- **disabled** (boolean) - Indicates if the test device is disabled.
- **network** (string) - The network associated with the test device.

#### Response Example
```json
[
  {
    "name": "My Test Device",
    "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
    "disabled": false,
    "network": "APPLOVIN_NETWORK"
  },
  {
    "name": "My Test Device 2",
    "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe2",
    "disabled": false,
    "network": "FACEBOOK_NETWORK"
  }
]
```
```

--------------------------------

### Get Test Devices

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Retrieves a list of test devices configured for mediation. These devices are used for testing ad implementations.

```json
[
  {
    "name": "My Test Device",
    "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
    "disabled": false,
    "network": "APPLOVIN_NETWORK"
  },
  {
    "name": "My Test Device 2",
    "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe2",
    "disabled": false,
    "network": "FACEBOOK_NETWORK"
  }
]
```

--------------------------------

### Get All Ad Units

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Retrieves a list of all active ad units. Supports pagination and field selection for detailed information.

```APIDOC
## GET /ad_units

### Description
Use this endpoint to view basic details of all active ad units. A `GET` request to this endpoint returns only those ad units that are active. This API does not allow you to disable or activate ad units. Do that in the UI instead.
You can get a more detailed view of all active ad units if you include the query parameter `fields` in your request. Set its value to a comma-delimited list of names of the fields you would like to see. Possible `fields` include `ad_network_settings`, `frequency_capping_settings`, and `bid_floors`. The field values that are returned when you request these other fields are the same as those in the corresponding objects that would be returned automatically if you were to request a single ad unit by using the `/ad_unit/«ad-unit-ID»` endpoint.
If there are too many ad units, your request to this endpoint may time out or return a `500` response code. You can limit the number of ad units returned by adding the query parameter `limit`. Set its value to an integer that indicates how many ad units the request should return. To paginate through all ad units, add the query parameter `offset`. Set its value to an integer that describes how many ad units in the total list to skip before the first result in the result set. If this `offset` value is larger than the total number of ad units, the response will return an empty array.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/ad_units

### Query Parameters
- **fields** (string) - Optional - A comma-delimited list of fields to include in the response (e.g., `ad_network_settings,frequency_capping_settings,bid_floors`).
- **limit** (integer) - Optional - The maximum number of ad units to return.
- **offset** (integer) - Optional - The number of ad units to skip before returning results.

### Response
#### Success Response (200)
- **ad_format** (string) - The format of the ad unit.
- **disabled** (boolean) - Whether this ad unit is disabled.
- **has_active_experiment** (boolean) - Whether this ad unit has an active experiment.
- **id** (string) - The ad unit ID.
- **name** (string) - The name of the ad unit.
- **package_name** (string) - The package name or bundle ID of the app associated with this ad unit.
- **platform** (string) - The platform of the ad unit.

### Response Example
```json
[
  {
    "name": "My Inter Ad Unit",
    "platform": "ios",
    "package_name": "com.test.app",
    "ad_format": "INTER",
    "id": "45de6aa565cf865f",
    "has_active_experiment": false,
    "disabled": false
  },
  {
    "name": "My Rewarded Ad Unit",
    "platform": "android",
    "package_name": "com.test.app",
    "ad_format": "REWARD",
    "id": "565c45df8e6aa65f",
    "has_active_experiment": false,
    "disabled": false
  }
]
```
```

--------------------------------

### Edit Test Device Request Body

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

To modify an existing test device, send a POST request to the `/test_device/«test-device-ID»` endpoint with the updated fields. This example shows disabling the device and changing its associated network.

```json
{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": true,
  "network": "FACEBOOK_NETWORK"
}
```

--------------------------------

### Get Waterfall for Segment

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Retrieves the waterfall configuration for a specific segment ID and ad unit. This allows for targeted mediation setups.

```http
https://o.applovin.com/mediation/v1/ad_unit/1234567890abcdef/213
```

--------------------------------

### Create Test Device

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a POST request to create a new test device.

```APIDOC
## POST /test_device

### Description
Creates a new test device entry.

### Method
POST

### Endpoint
https://o.applovin.com/mediation/v1/test_device

### Request Body
* **device_id** (string) - Required - The unique identifier for the test device.
* **device_type** (string) - Required - The type of device (e.g., 'ios', 'android').
* **name** (string) - Optional - A descriptive name for the test device.

### Request Example
{
  "device_id": "a1b2c3d4e5f6",
  "device_type": "android",
  "name": "My Test Android Phone"
}

### Response
#### Success Response (201)
* **id** (string) - The unique ID generated for the test device.
* **device_id** (string) - The provided device ID.
* **device_type** (string) - The provided device type.
* **name** (string) - The provided name.
* **created_at** (string) - The timestamp when the test device was created.

#### Response Example
{
  "id": "test_device_id_xyz",
  "device_id": "a1b2c3d4e5f6",
  "device_type": "android",
  "name": "My Test Android Phone",
  "created_at": "2023-10-27T12:00:00Z"
}
```

--------------------------------

### Manage Test Device Configurations

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a POST request to manage the configurations of a test device.

```APIDOC
## POST /test_device/{test-device-ID}

### Description
Manages the configurations of an existing test device.

### Method
POST

### Endpoint
https://o.applovin.com/mediation/v1/test_device/{test-device-ID}

### Parameters
#### Path Parameters
* **test-device-ID** (string) - Required - The ID of the test device to manage.

### Request Body
* **name** (string) - Optional - A new descriptive name for the test device.
* **active** (boolean) - Optional - Whether the test device is active.

### Request Example
{
  "name": "Updated Test Phone Name",
  "active": false
}

### Response
#### Success Response (200)
* **message** (string) - A confirmation message indicating the test device configurations have been updated.

#### Response Example
{
  "message": "Test device configurations updated successfully."
}
```

--------------------------------

### Get Waterfall for a Segment

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a GET request to retrieve the waterfall configuration for a specific segment of an ad unit.

```APIDOC
## GET /ad_unit/{ad-unit-ID}/{segment-ID}

### Description
Retrieves the waterfall configuration for a specific segment of an ad unit.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/ad_unit/{ad-unit-ID}/{segment-ID}

### Parameters
#### Path Parameters
* **ad-unit-ID** (string) - Required - The ID of the ad unit.
* **segment-ID** (string) - Required - The ID of the segment.

### Response
#### Success Response (200)
* **waterfall** (array) - An array of ad network objects representing the waterfall.
  * **ad_network_id** (string) - The ID of the ad network.
  * **instance_name** (string) - The name of the ad network instance.
  * **bid_floor** (number) - The bid floor for this ad network.
  * **priority** (integer) - The priority of this ad network in the waterfall.

#### Response Example
{
  "waterfall": [
    {
      "ad_network_id": "network_id_1",
      "instance_name": "AdMob Network",
      "bid_floor": 0.5,
      "priority": 1
    },
    {
      "ad_network_id": "network_id_2",
      "instance_name": "Meta Audience Network",
      "bid_floor": 0.4,
      "priority": 2
    }
  ]
}
```

--------------------------------

### Get Waterfall for Ad Unit Experiment Segment

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a GET request to retrieve the waterfall for a segment of an ad unit experiment.

```APIDOC
## GET /ad_unit_experiment/{ad-unit-ID}/{segment_id}

### Description
Retrieves the waterfall configuration for a specific segment within an ad unit experiment.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/ad_unit_experiment/{ad-unit-ID}/{segment_id}

### Parameters
#### Path Parameters
* **ad-unit-ID** (string) - Required - The ID of the ad unit.
* **segment_id** (string) - Required - The ID of the segment within the experiment.

### Response
#### Success Response (200)
* **waterfall** (array) - An array of ad network objects representing the waterfall for the experiment segment.
  * **ad_network_id** (string) - The ID of the ad network.
  * **instance_name** (string) - The name of the ad network instance.
  * **bid_floor** (number) - The bid floor for this ad network.
  * **priority** (integer) - The priority of this ad network in the waterfall.

#### Response Example
{
  "waterfall": [
    {
      "ad_network_id": "network_id_exp_1",
      "instance_name": "Experiment Network A",
      "bid_floor": 0.7,
      "priority": 1
    }
  ]
}
```

--------------------------------

### Promote Experiment Response Body

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

A successful promotion request returns a confirmation message.

```json
{
  "message": "Experiment successfully promoted"
}
```

--------------------------------

### Create Test Device

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Creates a new test device. You can only create a single test device per request.

```APIDOC
## POST /test_device

### Description
Creates a new test device. Include the required fields in the request body.

### Method
POST

### Endpoint
https://o.applovin.com/mediation/v1/test_device

### Parameters
#### Request Body
- **name** (string) - Required - The name of the test device.
- **device_id** (string) - Required - The IDFA of the test device.
- **disabled** (boolean) - Required - Whether the status of the device is disabled.
- **network** (string) - Required - Network for which the device ID is enabled for test mode.

### Request Example
{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": false,
  "network": "APPLOVIN_NETWORK"
}

### Response
#### Success Response (200)
- **name** (string) - The name of the test device.
- **device_id** (string) - The IDFA of the test device.
- **disabled** (boolean) - Whether the status of the device is disabled.
- **network** (string) - Network for which the device ID is enabled for test mode.

#### Response Example
{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": false,
  "network": "APPLOVIN_NETWORK"
}
```

--------------------------------

### Get Waterfall for Segment

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Retrieves the waterfall configuration for a specific segment of an ad unit.

```APIDOC
## GET /mediation/v1/ad_unit/{ad_unit_id}/{segment_id}

### Description
Get the waterfall for a specific segment ID for an ad unit.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/ad_unit/{ad_unit_id}/{segment_id}

### Parameters
#### Path Parameters
- **ad_unit_id** (string) - Required - The ID of the ad unit.
- **segment_id** (string) - Required - The ID of the segment.

### Request Example
Get the waterfall for segment ID 213 for ad unit 1234567890abcdef:
```
https://o.applovin.com/mediation/v1/ad_unit/1234567890abcdef/213
```
```

--------------------------------

### Create Experiment Response Body

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

The response body for creating an experiment includes the assigned `id` and other configuration details. Note that `ad_network_settings` and `bid_floors` are often represented as collapsed objects in responses.

```json
{
  "id": "e74c3b7797b0ce7a",
  "experiment_name": "test_adjusting_frequency_cap",
  "disabled": false,
  "promote": false,
  "deprecate": false,
  "ad_network_settings":[{…}], // same as parent ad unit
  "frequency_capping_settings": […],
  "bid_floors":[{…}] // same as parent ad unit
}
```

--------------------------------

### Create Ad Unit Experiment

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a POST request to create a new ad unit experiment if the ad unit does not have an active one.

```APIDOC
## POST /ad_unit_experiment/{ad-unit-ID}

### Description
Creates a new ad unit experiment for a given ad unit, provided no active experiment exists.

### Method
POST

### Endpoint
https://o.applovin.com/mediation/v1/ad_unit_experiment/{ad-unit-ID}

### Parameters
#### Path Parameters
* **ad-unit-ID** (string) - Required - The ID of the ad unit for which to create an experiment.

### Request Body
* **experiment_name** (string) - Required - The name for the new experiment.
* **traffic_percentage** (number) - Required - The percentage of traffic to allocate to this experiment (0-100).

### Request Example
{
  "experiment_name": "New Experiment A",
  "traffic_percentage": 50
}

### Response
#### Success Response (201)
* **experiment_id** (string) - The ID of the newly created experiment.
* **status** (string) - The status of the new experiment (usually PENDING or ACTIVE).

#### Response Example
{
  "experiment_id": "exp_67890",
  "status": "PENDING"
}
```

--------------------------------

### Promote Experiment

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Promotes an existing ad unit experiment. Updates to ad unit settings made simultaneously are ignored.

```APIDOC
## POST /experiments/promote

### Description
Promotes an existing ad unit experiment. Any updates to ad unit settings made simultaneously are ignored.

### Method
POST

### Endpoint
/experiments/promote

### Request Body
- **id** (string) - Required - The unique identifier for the experiment.
- **experiment_name** (string) - Required - The name of the experiment.
- **promote** (boolean) - Required - Set to true to promote the experiment.
- **deprecate** (boolean) - Optional - Indicates if the experiment should be deprecated.

### Request Example
```json
{
  "id": "e74c3b7797b0ce7a",
  "experiment_name": "test_adjusting_frequency_cap",
  "promote": true,
  "deprecate": false
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the experiment was promoted.

#### Response Example
```json
{
  "message": "Experiment successfully promoted"
}
```
```

--------------------------------

### Get Experiment Waterfall for Segment

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Retrieves the experiment waterfall configuration for a specific segment of an ad unit.

```APIDOC
## GET /mediation/v1/ad_unit_experiment/{ad_unit_id}/{segment_id}

### Description
Get the experiment waterfall for a specific segment ID for an ad unit.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/ad_unit_experiment/{ad_unit_id}/{segment_id}

### Parameters
#### Path Parameters
- **ad_unit_id** (string) - Required - The ID of the ad unit.
- **segment_id** (string) - Required - The ID of the segment.

### Request Example
Get the experiment waterfall for segment ID 213 for ad unit 1234567890abcdef:
```
https://o.applovin.com/mediation/v1/ad_unit_experiment/1234567890abcdef/213
```
```

--------------------------------

### View All Test Devices

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Retrieves basic details of all test devices in your account, including both disabled and enabled devices.

```APIDOC
## GET /test_devices

### Description
Retrieves basic details of all test devices in your account.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/test_devices

### Response
#### Success Response (200)
- **name** (string) - The name of the test device.
- **device_id** (string) - The IDFA of the test device.
- **disabled** (boolean) - Whether the status of the device is disabled.
- **network** (string) - Network for which the device ID is enabled for test mode.

#### Response Example
{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": false,
  "network": "APPLOVIN_NETWORK"
}
```

--------------------------------

### Create Experiment

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Creates a new ad unit experiment. The `id` field should be excluded or set to null in the request body.

```APIDOC
## POST /experiments

### Description
Creates a new ad unit experiment.

### Method
POST

### Endpoint
/experiments

### Request Body
- **experiment_name** (string) - Required - The name of the experiment.
- **frequency_capping_settings** (array) - Optional - Settings for frequency capping.
- **ad_network_settings** (array) - Optional - Settings for ad networks.
- **bid_floors** (array) - Optional - Bid floor settings.

### Request Example
```json
{
  "experiment_name": "test_adjusting_frequency_cap",
  "frequency_capping_settings": [
    {
      "type": "time",
      "time_capping_settings": {
        "day_limit": 10,
        "minute_frequency": 10
      },
      "session_capping_settings": {
        "session_limit": 0
      },
      "countries" : {
        "type": "INCLUDE",
        "values" : [
          "ca",
          "us"
        ]
      }
    }
  ]
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the experiment.
- **experiment_name** (string) - The name of the experiment.
- **disabled** (boolean) - Indicates if the experiment is disabled.
- **promote** (boolean) - Indicates if the experiment is promoted.
- **deprecate** (boolean) - Indicates if the experiment is deprecated.
- **ad_network_settings** (array) - Settings for ad networks.
- **frequency_capping_settings** (array) - Settings for frequency capping.
- **bid_floors** (array) - Bid floor settings.

#### Response Example
```json
{
  "id": "e74c3b7797b0ce7a",
  "experiment_name": "test_adjusting_frequency_cap",
  "disabled": false,
  "promote": false,
  "deprecate": false,
  "ad_network_settings":[{...}],
  "frequency_capping_settings": [
    {
      "type": "time",
      "time_capping_settings": {
        "day_limit": 10,
        "minute_frequency": 10
      },
      "session_capping_settings": {
        "session_limit": 0
      },
      "countries" : {
        "type": "INCLUDE",
        "values" : [
          "ca",
          "us"
        ]
      }
    }
  ],
  "bid_floors":[{...}]
}
```
```

--------------------------------

### Manage Ad Network Configurations

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a POST request to manage the ad network configurations of an existing ad unit.

```APIDOC
## POST /ad_unit/{ad-unit-ID}

### Description
Manages the ad network configurations for a specific ad unit.

### Method
POST

### Endpoint
https://o.applovin.com/mediation/v1/ad_unit/{ad-unit-ID}

### Parameters
#### Path Parameters
* **ad-unit-ID** (string) - Required - The ID of the ad unit to manage.

### Request Body
* **ad_network_settings** (array) - Optional - An array of ad network settings objects.
  * **ad_network_id** (string) - Required - The ID of the ad network.
  * **instance_name** (string) - Optional - The name of the ad network instance.
  * **sdk_version** (string) - Optional - The SDK version of the ad network.
  * **placement** (string) - Optional - The placement ID for the ad network.
  * **bid_floor** (number) - Optional - The bid floor for this ad network.
  * **active** (boolean) - Optional - Whether this ad network configuration is active.

### Request Example
{
  "ad_network_settings": [
    {
      "ad_network_id": "network_id_1",
      "instance_name": "AdMob Network",
      "sdk_version": "10.0.0",
      "placement": "placement_xyz",
      "bid_floor": 0.5,
      "active": true
    }
  ]
}

### Response
#### Success Response (200)
* **message** (string) - A confirmation message indicating the ad network settings have been updated.

#### Response Example
{
  "message": "Ad network settings updated successfully."
}
```

--------------------------------

### View or Edit Test Device

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

View or edit a specific test device configuration using its ID.

```APIDOC
## GET /test_device/«test-device-ID»

### Description
Retrieves the configuration of a specific test device.

### Method
GET

### Endpoint
https://o.applovin.com/mediation/v1/test_device/«test-device-ID»

### Parameters
#### Path Parameters
- **test-device-ID** (string) - Required - The unique identifier of the test device.

### Response
#### Success Response (200)
- **name** (string) - The name of the test device.
- **device_id** (string) - The IDFA of the test device.
- **disabled** (boolean) - Whether the status of the device is disabled.
- **network** (string) - Network for which the device ID is enabled for test mode.

#### Response Example
{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": false,
  "network": "APPLOVIN_NETWORK"
}
```

```APIDOC
## POST /test_device/«test-device-ID»

### Description
Edits the configuration of a specific test device. You can change the `disabled` status or the `network`.

### Method
POST

### Endpoint
https://o.applovin.com/mediation/v1/test_device/«test-device-ID»

### Parameters
#### Path Parameters
- **test-device-ID** (string) - Required - The unique identifier of the test device.

#### Request Body
- **name** (string) - Optional - The name of the test device.
- **device_id** (string) - Optional - The IDFA of the test device.
- **disabled** (boolean) - Optional - Whether the status of the device is disabled.
- **network** (string) - Optional - Network for which the device ID is enabled for test mode.

### Request Example
{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": true,
  "network": "FACEBOOK_NETWORK"
}

### Response
#### Success Response (200)
- **name** (string) - The name of the test device.
- **device_id** (string) - The IDFA of the test device.
- **disabled** (boolean) - Whether the status of the device is disabled.
- **network** (string) - Network for which the device ID is enabled for test mode.

#### Response Example
{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": true,
  "network": "FACEBOOK_NETWORK"
}
```

--------------------------------

### Manage Ad Unit Experiments

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Create, view, edit, promote, or deprecate ad unit experiments for a specific ad unit. Supports detailed field selection.

```APIDOC
## POST /ad_unit_experiment/«ad-unit-ID»

### Description
Use this endpoint to create, view, edit, promote, or deprecate ad unit experiments. To get a more detailed view of all ad unit experiments, include the query parameter `fields` in your request. Set its value to a comma-separated list of field names whose values you would like to see. Possible `fields` include `ad_network_settings`, `frequency_capping_settings`, and `bid_floors`. See the descriptions above of the objects that correspond to these `fields` values.
A `POST` request to this endpoint only applies changes to those fields that are present in your request. If any fields are missing in your request, the values corresponding to those missing fields in your ad unit remain the same as those in the parent ad unit. For example, if you only define the `experiment_name` value, the ad unit experiment will otherwise be a precise copy of the parent ad unit.

### Method
POST

### Endpoint
https://o.applovin.com/mediation/v1/ad_unit_experiment/«ad-unit-ID»

### Query Parameters
- **fields** (string) - Optional - A comma-separated list of fields to include in the response (e.g., `ad_network_settings,frequency_capping_settings,bid_floors`).

### Request Body
(The request body structure for creating/editing experiments is not explicitly defined in the source, but it would typically include fields like `experiment_name`, `ad_network_settings`, etc.)

### Response
(Success response details for this endpoint are not explicitly defined in the source.)

### Possible errors
Name| Description| Example  
---|---|---
`Bad Request`| HTTP Response Code| `400`  
`Unauthorized`| HTTP Response Code| `401`  
`Forbidden`| HTTP Response Code| `403`
```

--------------------------------

### Promote Experiment Request Body

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

To promote an experiment, set the `promote` field to `true`. Similar to deprecation, any ad unit setting updates in the same request are disregarded.

```json
{
  "id": "e74c3b7797b0ce7a",
  "experiment_name": "test_adjusting_frequency_cap",
  "promote": true,
  "deprecate": false
}
```

--------------------------------

### Target URL for Creating an Ad Unit

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Use this URL to make POST requests to create a new ad unit. Ensure you include the required fields in the request body. Note that you cannot create more ad units for combinations that already have an active ad unit using this endpoint; use the UI for such cases.

```bash
https://o.applovin.com/mediation/v1/ad_unit
```

--------------------------------

### Manage Ad Unit Experiment

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Make a POST request to promote or deprecate an ad unit experiment.

```APIDOC
## POST /ad_unit_experiment/{ad-unit-ID}

### Description
Manages an existing ad unit experiment by promoting it to production or deprecating it.

### Method
POST

### Endpoint
https://o.applovin.com/mediation/v1/ad_unit_experiment/{ad-unit-ID}

### Parameters
#### Path Parameters
* **ad-unit-ID** (string) - Required - The ID of the ad unit associated with the experiment.

### Request Body
* **action** (string) - Required - The action to perform: 'PROMOTE' or 'DEPRECATE'.

### Request Example
{
  "action": "PROMOTE"
}

### Response
#### Success Response (200)
* **message** (string) - A confirmation message indicating the action was successful.

#### Response Example
{
  "message": "Experiment promoted successfully."
}
```

--------------------------------

### View All Active Ad Units

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Use this endpoint to retrieve basic details of all active ad units. Query parameters like `fields`, `limit`, and `offset` can be used to customize the response.

```bash
https://o.applovin.com/mediation/v1/ad_units
```

--------------------------------

### Configure Time-Based Frequency Cap

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Use this object to set the maximum number of ads per day and the time interval between ads. Set `day_limit` and `minute_frequency` to 0 if the cap type is session-based.

```json
{
  "day_limit": 10,
  "minute_frequency": 10
}
```

--------------------------------

### Configure Device Type Targeting for Segmentation

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Specify the device types for which this segmentation rule applies. Options include 'all', 'phones', and 'tablets'.

```json
"tablets"
```

--------------------------------

### Target URL for Ad Unit Experiments

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

This is the target URL for the `/ad_unit_experiment/«ad-unit-ID»` endpoint. It allows for the creation, viewing, editing, promotion, or deprecation of ad unit experiments. The `fields` query parameter can be used to specify which details to retrieve.

```bash
https://o.applovin.com/mediation/v1/ad_unit_experiment/«ad-unit-ID»?fields=ad_network_settings,frequency_capping_settings,bid_floors
```
Tokens:
Raw