The Country group API allows you to configure your campaign Country groups, set their budget, target different countries within each Country group and set bid and optimizer goal for each Country.
Authentication Type: Bearer API Authentication
Get campaign Country groups
Use this API to retrieve a list of all of your Country configurations per campaign.
Method: GET
Request Example URL: https://api.ironsrc.com/advertisers/v4/CountryGroup/:campaignId
Required parameters: campaignId
Response example
{ "campaignId": 8405744, "CountryGroups": [ { "id": 16854, "name": "12345", "budget": 700, "countries": [ { "Country": "AT", "bid": 6, "setupGoal": "default" }, { "Country": "AU", "bid": "default", "setupGoal": "default" }, { "Country": "CA", "bid": "default", "setupGoal": "default" }, { "Country": "CH", "bid": "default", "setupGoal": "default" }, { "Country": "CN", "bid": "default", "setupGoal": "default" }, { "Country": "DE", "bid": "default", "setupGoal": "default" }, { "Country": "DK", "bid": "default", "setupGoal": "default" }, { "Country": "FR", "bid": "default", "setupGoal": "default" }, { "Country": "GB", "bid": "default", "setupGoal": "default" }, { "Country": "IL", "bid": 11, "setupGoal": 4 }, { "Country": "JP", "bid": "default", "setupGoal": "default" }, { "Country": "NO", "bid": "default", "setupGoal": "default" }, { "Country": "NZ", "bid": "default", "setupGoal": "default" }, { "Country": "SE", "bid": "default", "setupGoal": "default" }, { "Country": "US", "bid": 7, "setupGoal": 3 } ] } ] }
If the campaign budget type is set as "Shared," meaning the budget is shared across all Country groups, the Country group response will not include "Budget." If the campaign budget type is set as "By Country," meaning the budget is managed per Country group, the Country group response will include "Budget." If the budget type is by Country, and there is no budget set for the Country group, the returned value will be "unlimited."
Get Country group setup
Use this API to retrieve a specific Country group configuration for a campaign.
Required Parameters: Campaign Id
Method: GET
Request Example URL: https://api.ironsrc.com/advertisers/v4/CountryGroup/:campaignId /:CountryGroupId
Required parameters: campaignId, CountryGroupId
Response example
[ { "campaignId": 16854, "name": "12345", "budget": 700, "countries": [ { "Country": "AT", "bid": 6, "setupGoal": "default" }, { "Country": "AU", "bid": "default", "setupGoal": "default" }, { "Country": "CA", "bid": "default", "setupGoal": "default" }, { "Country": "CH", "bid": "default", "setupGoal": "default" }, { "Country": "CN", "bid": "default", "setupGoal": "default" }, { "Country": "DE", "bid": "default", "setupGoal": "default" }, { "Country": "DK", "bid": "default", "setupGoal": "default" }, { "Country": "FR", "bid": "default", "setupGoal": "default" }, { "Country": "GB", "bid": "default", "setupGoal": "default" }, { "Country": "IL", "bid": 11, "setupGoal": 4 }, { "Country": "JP", "bid": "default", "setupGoal": "default" }, { "Country": "NO", "bid": "default", "setupGoal": "default" }, { "Country": "NZ", "bid": "default", "setupGoal": "default" }, { "Country": "SE", "bid": "default", "setupGoal": "default" }, { "Country": "US", "bid": 7, "setupGoal": 3 } ] } ]
Create Country group
Use this API to create a Country group.
Method: POST
Request Example URL: https://api.ironsrc.com/advertisers/v4/CountryGroup/:campaignId
Required parameters: campaignId
Body parameters
| Name | Required | Data type | Description |
|---|---|---|---|
| name | Yes | String | Name for Country group |
| dailyBudget | Yes, if campaign budget is by Country | number | 'unlimited' | Daily budget for Country group |
| countries | Yes | array | Countries values for Country group See Country Properties table below |
Country properties
| Name | Required | Data type | Description |
|---|---|---|---|
| Country | yes | string (only valid Country name) | Country code (2 letters representing the Country) |
| bid | yes | number | "default" | the bid for the specific Country. min: 0.001, max number after decimals : 3 |
| setupGoal | yes, if campaign is optimized | number | "default" | the setup goal for a specific Country. for ROAS campaigns: min : 0.1 max numbers after decimal point: 1 for TCPA campaigns: min : 0.1 max : 1000 max numbers after decimal point: 2 |
Full request example
{ "name": "name1377", "dailyBudget" : "unlimited", "countries": [ {"Country": "AT", "bid": 8, "setupGoal" : 12} ] }
Response example
{ "id": 382491 }
Update Country group
Use this API to update a specific Country groups configuration.
Authentication Type: Bearer
Method: PUT
Request Example URL: https://api.ironsrc.com/advertisers/v4/CountryGroup/:campaignId/:CountryGroupId
Required parameters: campaignId, CountryGroupId
Body parameters
| Name | Required | Data type | Description |
|---|---|---|---|
| name | No | String | Name for Country group |
| dailyBudget | no | number | 'unlimited' | Daily budget for Country group |
| countries | no | array | countries values for Country group See Country Properties table below |
Country properties
| Name | Required | Data type | Description |
|---|---|---|---|
| Country | yes | string (only valid Country name) | Country code (2 letters representing the Country) |
| bid | yes | number | "default" | The bid for the specific Country. min: 0.001, max number after decimals: 3 |
| setupGoal | yes, if campaign is optimized | number | "default" | The setup goal for a specific Country. For ROAS campaigns: min : 0.1 max numbers after decimal point: 1 for TCPA campaigns: min : 0.1 max : 1000 max numbers after decimal point: 2 |
Full request example
{ "countries": [ {"Country": "AT", "bid": "default", "setupGoal" : 12} ] }
Response example
{ "success": true }
Delete Country group
Use this API to delete a specific Country group.
Method: DELETE
Request Example URL: https://api.ironsrc.com/advertisers/v4/CountryGroup/:campaignId/:CountryGroupId
Required parameters: campaignId, CountryGroupId
Response example
{ "success": true }
Delete countries from Country group
Use this API to delete countries from a specific Country group.
Authentication Type: Bearer
Method: DELETE
Request Example URL: https://api.ironsrc.com/advertisers/v4/CountryGroup/:campaignId/:CountryGroupId/countries
Required parameters: campaignId, CountryGroupId
Body parameters
| Name | Required | Data type | Description |
|---|---|---|---|
| remove | yes | array <string> | an array of countries you want to remove from the Country group |
Full request example
{ "remove": ["GR", "EG", "QA"] }
Response example
{ "success": true }
Get default bid and setup goal
Use this API in order to get the default values for Country groups
Method: Get
Request Example URL: https://api.ironsrc.com/advertisers/v4/CountryGroup/:campaignId/default
Required parameters: campaignId
Full response example
{ "setupGoal" : 4, "bid" : 2 }
Update default bid and setup goal
Use this API to update default bids and goals for your campaigns.
Method: PUT
Request Example URL: https://api.ironsrc.com/advertisers/v4/CountryGroup/:campaignId/default
Required parameters: campaignId
Body parameters
| Name | Required | Data type | Description |
|---|---|---|---|
| setupGoal | No | number | the default setupGoal |
| bid | No | number | the default bid |
Full request example
{ "setupGoal" : 4, "bid" : 2 }
Response example
{ "success": true }