Countries REST API
You can implement the countries web service to get a list of the countries supported by the Oracle Data Cloud platform. This API provides the unique IDs, ISO 3166-1 alpha-2 country codes, names, and country category IDs for the countries in which you can activate users.
DMP clients can use this API to get the country category IDs and pass them into the segment reach API for getting the reach of audiences in one or more countries and into the audiences API for targeting users in one or more countries.
Channel partners can use this API to lookup the countries included in the user data delivered into their platform.
Note: Users no longer create campaigns in the Oracle Data Cloud platform UI. The campaign workflow is now part of the audience workflow. The platform still uses campaigns to manage audience data delivery however. They are created automatically when a UI user delivers an audience. In the APIs, you create and use campaigns as before.
In this topic
Explore the API
The embedded I/O doc below enables you to explore the API. The I/O doc explains the parameters for each method and provides templates for your calls. You cannot make live API calls from the tool, however.
Open the link below in a new tab to see the I/O doc in a three-pane format.
For help with this API, contact My Oracle Support (MOS).
Service URI
The URI for the countries API is:
services.bluekai.com/rest/countries
Related API calls
You will typically make the following calls before you use the countries API:
- Audiences API: Create audiences containing the country category codes returned by the countries API so you can target users in one or more countries.
- Inventory reach API: Get the reach of your target audiences in one or more countries.
You will typically calls after you use the countries API:
- User data API: Deliver user data from the profile store into your system. The user data will include country category IDs representing users' country locations.
GET response data
GET requests return a list of one or more countries with the following properties:
| Property | Type | Description |
|---|---|---|
category
|
object | Contains the category ID (integer) of the country (for example, 408098 for the United States). You add this country category ID to audience segments in the following APIs:
|
code
|
string | The two-letter code for the country, such as US |
createdAt
|
string | A timestamp indicating when the country was added to the Oracle Data Cloud platform |
id
|
integer | The unique ID assigned to the country in the Oracle Data Cloud platform, such as 1 for the United States |
isHidden
|
boolean | Indicates whether the country is visible in the Oracle Data Cloud platform UI |
name
|
string | The name of the country, such as United States |
status
|
string | Indicates whether the country can be used for targeting and analytics. Countries with an "active" status can be used. |
updatedAt
|
string | A timestamp indicating when the country was modified in the Oracle Data Cloud platform |
Embargoed Countries
Oracle Data Cloud participates in data embargoes for Crimea, Cuba, Iran, North Korea, Sudan, and Syria. Data linked to these countries is not ingested, stored, or delivered. These countries are therefore not included in the Countries API GET response.