### Dictionary Item Schema Example

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/DictionaryBrowserApi

This snippet shows an example of the schema for an item within the browser dictionary. It includes fields for id, name, and associated device formats.

```json
{
  "id": 0,
  "name": "string",
  "device_formats": [
    0
  ]
}
```

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

### WhitelistEditSchema Example - JSON

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/WhitelistEditSchema

This snippet demonstrates the structure of the WhitelistEditSchema, specifically how to provide an array of integer placement IDs. The 'required' field is also shown, though its value is null in this example.

```json
{
  "placement_ids": [
    1,
    2
  ],
  "required": null
}
```

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

### Country Schema Example

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/CountryApi

Example JSON structure for country information, including id, name, and code. This schema is used for representing country data within the API.

```json
{
  "id": 0,
  "name": "string",
  "code": "string"
}
```

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

### CustomBidsCollection Schema Example - JSON

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/CustomBidsCollection

This JSON example demonstrates the structure of the CustomBidsCollection object. It includes an array of bid items, each specifying a placement ID, price, and country code, along with the total count of items.

```json
{
  "items": [
    {
      "placement_id": 1,
      "price": 1.22,
      "country_code": "US"
    }
  ],
  "itemCount": 1
}
```

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

### CampaignInfo Schema Example (JSON)

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/CampaignInfo

This JSON object represents the structure of the CampaignInfo schema. It includes fields for campaign identification, status, format, pricing details, and various limits for budget, impressions, clicks, and conversions.

```json
{
  "id": 0,
  "alias": "string",
  "active": 0,
  "activity": 0,
  "is_ssp": "string",
  "format": "string",
  "pricing_type": "string",
  "pricing_settings": [
    {
      "price": 0,
      "country_code": "string"
    }
  ],
  "total_budget_limit": null,
  "daily_budget_limit": null,
  "hourly_budget_limit": null,
  "total_impressions_limit": 0,
  "daily_impressions_limit": 0,
  "hourly_impressions_limit": 0,
  "total_clicks_limit": 0,
  "daily_clicks_limit": 0,
  "hourly_clicks_limit": 0,
  "total_conversions_limit": 0,
  "daily_conversions_limit": 0,
  "hourly_conversions_limit": 0
}
```

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

### City Schema Example (JSON)

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/City

This code snippet demonstrates the expected JSON structure for a City object. It includes the 'id' (number) and 'name' (string) fields, both of which are required.

```json
{
  "id": 0,
  "name": "string"
}
```

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

### Advertisers API v3.0.0 Documentation

Source: https://docs.adsterratools.com/public/v3/partners-api

This section details the available endpoints for the Advertisers API, including information on authentication and the base URL.

```APIDOC
## Advertisers API v3.0.0

### Description
This API allows you to manage your advertising campaigns, banners, statistics, and other related features.

### API Base URL
Production server: `https://api3.adsterratools.com/advertiser`

### Security
**API Key Authentication**

A token (API Key) is required for authentication. You can acquire a token from the Tracking page in your user panel. The token is valid until manually invalidated. Only one valid token can exist at a time.

Include the API Key in the header parameter `X-API-Key`.

**Example:**
```
X-API-Key: YOUR_API_KEY
```

**Important:** The method of passing the API Key has changed; it is now passed in the header instead of as part of the URL.

### Rate Limit
1200 requests per minute, per user.

### Endpoints Overview
- balance
- banner
- campaign
- campaigns
- linking
- statistics
- dictionary
- custom-bids

### Schemas Overview
- CampaignInfo
- WhitelistEditSchema
- CustomBidsCollection
- DictionaryBrowserApi
- DictionaryItem
- Country
- Region
- City
```

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

### WhitelistEditSchema

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/WhitelistEditSchema

Schema for editing the whitelist, specifically for managing placement IDs.

```APIDOC
## WhitelistEditSchema

### Description
Schema for editing the whitelist, used to manage placement IDs.

### Parameters
#### Request Body
- **placement_ids** (array[integer]) - Required - Array of placement IDs to be added to the whitelist.

### Request Example
```json
{
  "placement_ids": [
    1,
    2
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating successful update.

#### Response Example
```json
{
  "message": "Whitelist updated successfully."
}
```
```

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

### DictionaryBrowserApi

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/DictionaryBrowserApi

Provides information about an item from the browser dictionary, including its ID, name, and associated device formats.

```APIDOC
## GET /websites/adsterratools_public_v3/dictionaryBrowserApi

### Description
Retrieves information about a specific item from the browser dictionary.

### Method
GET

### Endpoint
/websites/adsterratools_public_v3/dictionaryBrowserApi

### Parameters
#### Query Parameters
- **id** (number) - Required - The unique identifier for the dictionary item.
- **name** (string) - Required - The name of the dictionary item.

### Request Example
```json
{
  "id": 0,
  "name": "string",
  "device_formats": [
    0
  ]
}
```

### Response
#### Success Response (200)
- **id** (number) - The unique identifier of the dictionary item.
- **name** (string) - The name of the dictionary item.
- **device_formats** (array[integer]) - An array of integers representing the device formats associated with the browser item.

#### Response Example
```json
{
  "id": 0,
  "name": "string",
  "device_formats": [
    0
  ]
}
```
```

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

### CampaignInfo Schema

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/CampaignInfo

Details about the CampaignInfo schema, including available fields and their types.

```APIDOC
## CampaignInfo Schema

### Description
Provides detailed information about a campaign.

### Fields
- **id** (integer) - Unique identifier for the campaign.
- **alias** (string) - A user-defined name for the campaign.
- **active** (integer) - Indicates if the campaign is currently active (1 for active, 0 for inactive).
- **activity** (integer) - A deprecated field for campaign activity. Use `active` instead. Will be removed after 31 Jan 2026.
- **is_ssp** (string) - Indicates if the campaign is associated with an SSP.
- **format** (string) - The format of the campaign (e.g., banner, video).
- **pricing_type** (string) - The type of pricing model used for the campaign (e.g., CPC, CPM).
- **pricing_settings** (array[object]) - An array of pricing settings, typically including price and country code.
  - **price** (number) - The price associated with a specific pricing setting.
  - **country_code** (string) - The country code for which this pricing setting applies.
- **total_budget_limit** (null) - The overall budget limit for the campaign.
- **daily_budget_limit** (null) - The daily budget limit for the campaign.
- **hourly_budget_limit** (null) - The hourly budget limit for the campaign.
- **total_impressions_limit** (integer or null) - The total impression limit for the campaign.
- **daily_impressions_limit** (integer or null) - The daily impression limit for the campaign.
- **hourly_impressions_limit** (integer or null) - The hourly impression limit for the campaign.
- **total_clicks_limit** (integer or null) - The total click limit for the campaign.
- **daily_clicks_limit** (integer or null) - The daily click limit for the campaign.
- **hourly_clicks_limit** (integer or null) - The hourly click limit for the campaign.
- **total_conversions_limit** (integer or null) - The total conversion limit for the campaign.
- **daily_conversions_limit** (integer or null) - The daily conversion limit for the campaign.
- **hourly_conversions_limit** (integer or null) - The hourly conversion limit for the campaign.

### Request Example
```json
{
  "id": 0,
  "alias": "string",
  "active": 0,
  "activity": 0,
  "is_ssp": "string",
  "format": "string",
  "pricing_type": "string",
  "pricing_settings": [
    {
      "price": 0,
      "country_code": "string"
    }
  ],
  "total_budget_limit": null,
  "daily_budget_limit": null,
  "hourly_budget_limit": null,
  "total_impressions_limit": 0,
  "daily_impressions_limit": 0,
  "hourly_impressions_limit": 0,
  "total_clicks_limit": 0,
  "daily_clicks_limit": 0,
  "hourly_clicks_limit": 0,
  "total_conversions_limit": 0,
  "daily_conversions_limit": 0,
  "hourly_conversions_limit": 0
}
```
```

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

### Country Information API

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/CountryApi

Retrieve information about countries, including their ID, name, and two-letter ISO code.

```APIDOC
## GET /websites/adsterratools_public_v3/dictionary/country

### Description
Retrieves a list of countries with their associated information.

### Method
GET

### Endpoint
/websites/adsterratools_public_v3/dictionary/country

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the country.
- **name** (string) - The name of the country.
- **code** (string) - The two-letter country code according to ISO.

#### Response Example
```json
{
  "id": 0,
  "name": "string",
  "code": "string"
}
```
```

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

### Custom Bids API

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/CustomBidsCollection

Manages custom bids for ad placements, allowing specific pricing per country and placement.

```APIDOC
## GET /websites/adsterratools_public_v3/custom-bids

### Description
Retrieves a collection of custom bids.

### Method
GET

### Endpoint
/websites/adsterratools_public_v3/custom-bids

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **limit** (integer) - Optional - The number of items to return per page.
- **placement_id** (integer) - Optional - Filter by placement ID.
- **country_code** (string) - Optional - Filter by country code.

### Response
#### Success Response (200)
- **items** (array[object]) - A list of custom bid objects.
  - **placement_id** (integer) - The ID of the ad placement.
  - **price** (number) - The custom bid price.
  - **country_code** (string) - The country code associated with the bid.
- **itemCount** (integer) - The total number of custom bid items.

#### Response Example
```json
{
  "items": [
    {
      "placement_id": 1,
      "price": 1.22,
      "country_code": "US"
    }
  ],
  "itemCount": 1
}
```
```

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

### DictionaryItem API

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/DictionaryItem

Retrieves information about a specific item from the dictionary list.

```APIDOC
## GET /websites/adsterratools_public_v3/dictionary/{id}

### Description
Retrieves detailed information about a specific item from the dictionary list, identified by its unique ID.

### Method
GET

### Endpoint
/websites/adsterratools_public_v3/dictionary/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique identifier of the dictionary item.

### Response
#### Success Response (200)
- **id** (number) - The unique identifier of the dictionary item.
- **name** (string) - The name of the dictionary item.

#### Response Example
```json
{
  "id": 1,
  "name": "Example Item"
}
```
```

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

### Region API

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/Region

Provides information about the region of a specific country.

```APIDOC
## GET /websites/adsterratools_public_v3/region

### Description
Retrieves information about a specific region within a country.

### Method
GET

### Endpoint
/websites/adsterratools_public_v3/region

### Parameters
#### Query Parameters
- **id** (number) - Required - The unique identifier for the region.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (number) - The unique identifier for the region.
- **name** (string) - The name of the region.

#### Response Example
```json
{
  "id": 0,
  "name": "string"
}
```

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

### City Information API

Source: https://docs.adsterratools.com/public/v3/partners-api/schemas/City

Retrieves information about a specific city within a region and country. It returns the city's ID and name.

```APIDOC
## GET /cities/{cityId}

### Description
Retrieves information about a specific city, including its ID and name.

### Method
GET

### Endpoint
`/cities/{cityId}`

### Parameters
#### Path Parameters
- **cityId** (number) - Required - The unique identifier for the city.

### Response
#### Success Response (200)
- **id** (number) - The unique identifier for the city.
- **name** (string) - The name of the city.

#### Response Example
```json
{
  "id": 0,
  "name": "string"
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.