Unity Advertising Management API

https://services.docs.unity.com/advertise/v1
Admin
The Unity Advertising Management API is a streamlined solution for automating and optimizing acquire...
Tokens:55,436
Snippets:233
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Example JSON Response for Get Event Optimization Bids

Source: https://services.docs.unity.com/advertise/v1/index

Example JSON structure for a successful response when retrieving event optimization bids. It includes a total count and a list of results, each specifying a country and its associated bid.

```JSON
{
  "total": 1,
  "results": [
    {
      "country": "US",
      "bid": "0.755"
}
]

}
```

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

### Get Targeting Options Example Response

Source: https://services.docs.unity.com/advertise/v1/index

This snippet demonstrates a successful response (200 OK) for the 'Get targeting options' endpoint. It illustrates the structure of the JSON response, including app, device, category, and regional targeting settings.

```json
{
  "appTargeting": {
    "allowList": [
      "0a1b2c3D4E5f"
    ]
  },
  "deviceTargeting": {
    "limitedAdTracking": [
      "USERS_ALLOWING_AD_TRACKING"
    ],
    "osMin": "14.0",
    "osMax": "latest",
    "connectionType": [
      "wifi"
    ],
    "screenSize": [
      "small"
    ],
    "screenDensity": [
      "ldpi"
    ]
  },
  "categoryTargeting": {
    "allowList": [
      "Unknown"
    ]
  },
  "regionalTargeting": [
    {
      "country": "AD",
      "subdivisions": [
        3039162
      ]
    }
  ]
}
```

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

### List Apps Endpoint Request Example

Source: https://services.docs.unity.com/advertise/v1/index

This example shows how to call the 'List Apps' endpoint. It includes the HTTP method, URL with the organizationId path parameter, and optional query parameters like offset, limit, and filter.

```http
GET /advertise/v1/organizations/{organizationId}/apps?offset=0&limit=1000&filter[storeId]=com.store.id&filter[store]=google HTTP/1.1
Host: services.api.unity.com
```

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

### List Campaigns (JSON Response Example)

Source: https://services.docs.unity.com/advertise/v1/index

Example response for listing campaigns associated with a given app. The response includes the total number of campaigns and a list of campaign objects, each containing country and bid information.

```json
{
  "total": 1,
  "results": [
    {
      "country": "US",
      "bid": "0.755"
    }
  ]
}
```

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

### Construct List Apps API Call URL (Unix)

Source: https://services.docs.unity.com/advertise/v1/index

This example shows how to construct the URL for the 'List Apps' endpoint of the Unity Advertising Management API. It requires your organization ID, which should be appended to the base URL. This URL is used in conjunction with an authenticated HTTP GET request to retrieve a list of apps associated with your organization.

```shell
https://services.api.unity.com/advertise/v1/organizations/5772562874846/apps
```

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

### Delete App Endpoint Request Example

Source: https://services.docs.unity.com/advertise/v1/index

This example demonstrates how to call the 'Delete App' endpoint. It includes the HTTP method, URL with path parameters (organizationId and campaignSetId), and expected response status codes.

```http
DELETE /advertise/v1/organizations/{organizationId}/apps/{campaignSetId} HTTP/1.1
Host: services.api.unity.com
```

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

### Get Campaign Budget Response Sample

Source: https://services.docs.unity.com/advertise/v1/index

This JSON object is a sample response for the 'Get Budget' endpoint. It provides details on the total budget, daily spending, and overall spent amount for a campaign.

```json
{
  "total": "2500.20",
  "dailySpent": "1800.32",
  "spent": "1800.32",
  "daily": "2500.20"
}
```

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

### Example JSON Payload for Update Event Optimization Bids

Source: https://services.docs.unity.com/advertise/v1/index

Example JSON payload for updating event optimization bids. It's an array of objects, where each object specifies a country and the desired bid amount for that country.

```JSON
[
  {
    "country": "US",
    "bid": "0.755"
}

]
```

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

### Patch Advertise App v1 Request Payload Example

Source: https://services.docs.unity.com/advertise/v1/index

This is an example of the JSON payload used to patch an existing app's advertising configuration. It includes fields like adomain, appAttributionClickUrl, appAttributionStartUrl, appAttributionViewUrl, and appLevelAttributionUpdateType.

```json
{
  "adomain": "example.com",
  "appAttributionClickUrl": "https://example.com/{ifa}",
  "appAttributionStartUrl": "https://example.com/{ifa}",
  "appAttributionViewUrl": "https://example.com/{ifa}",
  "appLevelAttributionUpdateType": "newAudiences"
}
```

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

### Create Creative Pack Response - JSON

Source: https://services.docs.unity.com/advertise/v1/index

Example JSON response for a successful creative pack creation request. It details the ID, name, type, and the list of creative IDs that form the pack.

```json
{
  "id": "5feb4574ff3d91a3af53c67e",
  "name": "Video with end card",
  "type": "video",
  "creativeIds": [
  "5fd363cf5d84aa0ed76956b1",
  "5feb40a6ff3d91a3af53c678"
  ]
}
```

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

### ROAS Eligibility Response (JSON)

Source: https://services.docs.unity.com/advertise/v1/index

Example response for listing ROAS eligibility. It details countries eligible for ROAS campaigns and suggested IAP and ad revenue goals.

```json
{
  "total": 1,
  "results": [
    {
      "country": "US",
      "suggestedIapGoal": "12.34",
      "suggestedAdRevenueGoal": "12.34",
      "eligibility": [
        "iap"
      ]
    }
  ]
}
```

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

### Create Square End Card Creative Request (HTTP)

Source: https://services.docs.unity.com/advertise/v1/index

Example of an HTTP POST request to create a square end card creative. It demonstrates the multipart/form-data structure with 'creativeInfo' JSON and the image binary data.

```HTTP
POST /advertise/v1/organizations/<ORGANIZATION_ID>/apps/<CAMPAIGN_SET_ID>/creatives HTTP/1.1
Host: services.api.unity.com:443
Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>
Content-Type: multipart/form-data; boundary=--------------------------371131627955007232942795
Content-Length: 51165
----------------------------371131627955007232942795
Content-Disposition: form-data; name="creativeInfo"
Content-Type: application/json

{
  "name": "My Creative",
  "language": "en",
  "squareEndCard": {
    "fileName": "myCreative.jpeg"
  }
}
----------------------------371131627955007232942795
Content-Disposition: form-data; name="squareEndCardFile"; filename="myCreative.jpeg"

<IMAGE_BINARY_DATA>
----------------------------371131627955007232942795--
```

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

### Create Creative Pack - cURL

Source: https://services.docs.unity.com/advertise/v1/index

Creates a creative pack by combining 1-3 existing creatives. This example demonstrates creating a pack with a portrait video and a square end card. It requires the IDs of the creatives to include, the pack name, type, organization ID, campaign set ID, and authorization credentials. The response includes the ID, name, type, and creative IDs of the newly created pack.

```bash
curl --verbose \
 --request POST \
 --data '{"name": "Portrait video with square end card", "creativeIds": ["5fd363cf5d84aa0ed76956b1", "5feb40a6ff3d91a3af53c678"], "type": "video"}' \
 --header "Content-Type: application/json" \
 --header "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" \
 https://services.api.unity.com/advertise/v1/organizations/<ORGANIZATION_ID>/apps/<CAMPAIGN_SET_ID>/creative-packs
```

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

### Create Creative Pack

Source: https://services.docs.unity.com/advertise/v1/index

Creates a creative pack by combining 1-3 creatives.

```APIDOC
## POST /advertise/v1/organizations/<ORGANIZATION_ID>/apps/<CAMPAIGN_SET_ID>/creative-packs

### Description
Creates a creative pack from uploaded creatives.

### Method
POST

### Endpoint
`https://services.api.unity.com/advertise/v1/organizations/<ORGANIZATION_ID>/apps/<CAMPAIGN_SET_ID>/creative-packs`

### Parameters
#### Path Parameters
- **ORGANIZATION_ID** (string) - Required - Your organization ID.
- **CAMPAIGN_SET_ID** (string) - Required - The ID of the campaign set.

#### Query Parameters
None

#### Request Body
- **name** (string) - Required - The name of the creative pack.
- **creativeIds** (array) - Required - An array of creative IDs to include in the pack.
- **type** (string) - Required - The type of the creative pack (e.g., "video", "playable").

### Request Example
```
curl --verbose \
 --request POST \
 --data '{"name": "Portrait video with square end card", "creativeIds": ["5fd363cf5d84aa0ed76956b1", "5feb40a6ff3d91a3af53c678"], "type": "video"}' \
 --header "Content-Type: application/json" \
 --header "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" \
 https://services.api.unity.com/advertise/v1/organizations/<ORGANIZATION_ID>/apps/<CAMPAIGN_SET_ID>/creative-packs
```

### Response
#### Success Response (201)
- **id** (string) - The ID of the created creative pack.
- **name** (string) - The name of the creative pack.
- **type** (string) - The type of the creative pack.
- **creativeIds** (array) - An array of creative IDs included in the pack.

#### Response Example
```json
{
  "id": "5feb4574ff3d91a3af53c67e",
  "name": "Portrait video with square end card",
  "type": "video",
  "creativeIds": [
    "5fd363cf5d84aa0ed76956b1",
    "5feb40a6ff3d91a3af53c678"
  ]
}
```
```

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

### Get Campaign Budget Endpoint URL

Source: https://services.docs.unity.com/advertise/v1/index

This string represents the production server URL for the 'Get Budget' endpoint in the Unity Ads API v1. It includes placeholders for organizationId, campaignSetId, and campaignId.

```string
https://services.api.unity.com/advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/campaigns/{campaignId}/budget
```

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

### Create App Request Sample

Source: https://services.docs.unity.com/advertise/v1/index

This is a sample JSON payload for creating a new app through the Unity Ads API. It includes essential details such as the app store, store ID, advertiser domain, and attribution URLs.

```json
{
  "store": "apple",
  "storeId": "1234567",
  "adomain": "example.com",
  "appAttributionClickUrl": "https://example.com/{ifa}",
  "appAttributionStartUrl": "https://example.com/{ifa}",
  "appAttributionViewUrl": "https://example.com/{ifa}"
}
```

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

### Example JSON Response for Campaign Creation

Source: https://services.docs.unity.com/advertise/v1/index

This JSON object represents a successful response when creating or retrieving campaign data. It includes campaign details such as ID, name, goal, bidding strategy, and budget information. The 'results' array contains detailed campaign objects.

```json
{
  "total": 1,
  "results": [
    {
      "id": "5eb26a338a232100e4bb6361",
      "name": "CPI campaign for My Game",
      "goal": "installs",
      "billingType": "cpi",
      "enabled": true,
      "attributionClickUrl": "https://example.com/{ifa}",
      "attributionStartUrl": "https://example.com/{ifa}",
      "attributionViewUrl": "https://example.com/{ifa}",
      "scheduleStart": "2020-08-25",
      "scheduleEnd": "2020-11-02",
      "createdAt": "2020-07-20T18:30:51.243Z",
      "updatedAt": "2020-08-25T11:55:20.651Z",
      "biddingStrategy": "manual",
      "cpiBids": [
        {
          "country": "US",
          "bid": "0.201"
        }
      ],
      "sourceBids": [
        {
          "country": "US",
          "sourceAppId": "0a1b2c3D4E5f",
          "bid": "0.201"
        }
      ],
      "retentionBids": [
        {
          "country": "US",
          "baseBid": "0.755",
          "maxBid": "0.255"
        }
      ],
      "eventOptimizationBids": [
        {
          "country": "US",
          "bid": "0.755"
        }
      ],
      "eventOptimizationType": "level_complete",
      "sdkEventName": "level_complete_1",
      "budget": {
        "total": "2500.20",
        "dailySpent": "1800.32",
        "spent": "1800.32",
        "daily": "2500.20"
      }
    }
  ]
}
```

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

### App List Response Sample

Source: https://services.docs.unity.com/advertise/v1/index

This JSON sample represents the response when listing apps associated with an organization. It includes pagination details like total count, offset, and limit, along with a list of app objects.

```json
{
  "total": 1,
  "offset": 0,
  "limit": 1000,
  "results": [
    {
      "id": "5eb26a338a232100e4bb5893",
      "name": "My Game",
      "store": "apple",
      "storeId": "com.companyname.appname",
      "adomain": "example.com",
      "gameId": 500000007,
      "createdAt": "2020-07-20T18:30:51.243Z",
      "updatedAt": "2020-08-25T11:55:20.651Z",
      "appAttributionClickUrl": "https://example.com/{ifa}",
      "appAttributionStartUrl": "https://example.com/{ifa}",
      "appAttributionViewUrl": "https://example.com/{ifa}"
}
]

}
```

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

### API Versioning

Source: https://services.docs.unity.com/advertise/v1/index

Information on how the API is versioned and how to construct API endpoints.

```APIDOC
## Versioning

Our API endpoints are versioned and typically structured in the following format:

```
<BASE_URL>/<VERSION>/<API_NAMESPACE>/<...>

```

where `<VERSION>` is the version number of the API (example: v1).

The API may receive non-breaking changes without its version number being changed. Breaking changes are introduced only to new API versions.

The current API version is **v1**. For all API updates, view our [API changelog](https://docs.unity.com/manual/Ads/APIChangelog).

```

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

### Get Creative API

Source: https://services.docs.unity.com/advertise/v1/index

This endpoint returns a creative by the creative ID and campaign set ID.

```APIDOC
## GET /advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/creatives/{creativeId}

### Description
This endpoint returns a creative by the creative ID and campaign set ID.

### Method
GET

### Endpoint
`/advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/creatives/{creativeId}`

### Parameters
#### Path Parameters
- **organizationId** (integer) - Required - Core ID of the organization.
- **campaignSetId** (string) - Required - Unique identifier for an App.
- **creativeId** (string) - Required - The unique identifier for the creative.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the creative.
- **name** (string) - The name of the creative.
- **language** (string) - The language of the creative.
- **type** (string) - The type of the creative.
- **files** (array) - A list of files associated with the creative.
  - **name** (string) - The name of the file.
  - **url** (string) - The URL to access the file.
- **createdAt** (string) - The timestamp when the creative was created.
- **status** (string) - The status of the creative.

#### Response Example (200)
```json
{
  "id": "5eb26a338a232100e4cc9945",
  "name": "My Creative",
  "language": "en",
  "type": "landscapeVideo",
  "files": [
    {
      "name": "string",
      "url": "https://example.com/directory/image.jpg"
    }
  ],
  "createdAt": "2020-07-20T18:30:51.243Z",
  "status": "approved"
}
```

#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **404** Not Found
```

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

### POST /websites/services_unity_advertise_v1/organizations/{organizationId}/campaigns/{campaignSetId}

Source: https://services.docs.unity.com/advertise/v1/index

Creates a new advertising campaign. This endpoint facilitates the campaign setup process, including assigning creatives, setting bids based on campaign goals, and defining budget and schedule.

```APIDOC
## POST /websites/services_unity_advertise_v1/organizations/{organizationId}/campaigns/{campaignSetId}

### Description
This endpoint is used to create a campaign. In order to complete the campaign setup, take the following steps:
1. You can Upload Creatives or use the old ones if you already have uploaded them.
2. You can Create Creative Pack or use any approved creative pack you already have.
3. You should Assign Creative Pack to the campaign.
4. Depending on the `goal` of your campaign you need to update CPI/ROAS/Retention bids by calling the right Bids endpoint.
5. Finally if you prepared all requirements you can change the `enabled` status by calling the Update Campaign endpoint.

**Note**: The campaign must have the below prerequisites to go live:
  * At least one assigned and approved creative pack.
  * Tracking attribution links.
  * Specify countries you would like to advertise in.
  * The organization is required to have a budget and also, you can optionally update the campaign-level budget.

**Note**: If null values are passed for the links (`attributionClickUrl`, `attributionStartUrl`, or `attributionViewUrl`), and the app that campaign belongs to has one or many app-level attribution urls set, a modified campaign would automatically get the app-level attribution url values.

### Method
POST

### Endpoint
`/websites/services_unity_advertise_v1/organizations/{organizationId}/campaigns/{campaignSetId}`

### Parameters
#### Path Parameters
- **organizationId** (integer) - Required - Core ID of the organization. You can look up your Organization's ID by opening up the Acquire Dashboard and by looking up the ID from the browser's address bar: `https://dashboard.unity3d.com/organizations/<ORGANIZATION_ID_IS_HERE>/acquire/about`. For more information about the IDs, refer to the Resource IDs documentation.
- **campaignSetId** (string) - Required - Unique identifier for an App.

#### Request Body
- **name** (string) - Required - The name of the campaign.
- **goal** (string) - Required - The campaign's objective (e.g., "installs", "conversions").
- **billingType** (string) - Required - The type of billing for the campaign (e.g., "cpi", "cpc", "cpa").
- **attributionClickUrl** (string) - Optional - The URL for click attribution.
- **attributionStartUrl** (string) - Optional - The URL for start attribution.
- **attributionViewUrl** (string) - Optional - The URL for view attribution.
- **scheduleStart** (string) - Optional - The start date for the campaign schedule (YYYY-MM-DD).
- **scheduleEnd** (string) - Optional - The end date for the campaign schedule (YYYY-MM-DD).
- **biddingStrategy** (string) - Optional - The bidding strategy for the campaign (e.g., "manual", "automatic").
- **cpiBids** (array) - Optional - An array of bid objects for CPI campaigns.
  - **country** (string) - Required - The country code.
  - **bid** (string) - Required - The bid amount.
- **sourceBids** (array) - Optional - An array of bid objects for source-specific bids.
  - **country** (string) - Required - The country code.
  - **sourceAppId** (string) - Required - The source app identifier.
  - **bid** (string) - Required - The bid amount.
- **retentionBids** (array) - Optional - An array of bid objects for retention campaigns.
  - **country** (string) - Required - The country code.
  - **baseBid** (string) - Required - The base bid amount.
  - **maxBid** (string) - Required - The maximum bid amount.
- **eventOptimizationBids** (array) - Optional - An array of bid objects for event optimization campaigns.
  - **country** (string) - Required - The country code.
  - **bid** (string) - Required - The bid amount.
- **eventOptimizationType** (string) - Optional - The type of event to optimize for.
- **sdkEventName** (string) - Optional - The name of the SDK event to track.
- **budget** (object) - Optional - The campaign budget configuration.
  - **total** (string) - Optional - The total budget for the campaign.
  - **daily** (string) - Optional - The daily budget for the campaign.

### Request Example
```json
{
  "name": "CPI campaign for My Game",
  "goal": "installs",
  "billingType": "cpi",
  "attributionClickUrl": "https://example.com/{ifa}",
  "attributionStartUrl": "https://example.com/{ifa}",
  "attributionViewUrl": "https://example.com/{ifa}",
  "scheduleStart": "2020-08-25",
  "scheduleEnd": "2020-11-02",
  "biddingStrategy": "manual",
  "cpiBids": [
    {
      "country": "US",
      "bid": "0.201"
    }
  ],
  "sourceBids": [
    {
      "country": "US",
      "sourceAppId": "0a1b2c3D4E5f",
      "bid": "0.201"
    }
  ],
  "retentionBids": [
    {
      "country": "US",
      "baseBid": "0.755",
      "maxBid": "0.255"
    }
  ],
  "eventOptimizationBids": [
    {
      "country": "US",
      "bid": "0.755"
    }
  ],
  "eventOptimizationType": "level_complete",
  "sdkEventName": "level_complete_1",
  "budget": {
    "total": "2500.20",
    "daily": "2500.20"
  }
}
```

### Response
#### Success Response (200)
- **total** (integer) - The total number of results.
- **results** (array) - An array of campaign objects.
  - **id** (string) - The unique identifier for the campaign.
  - **name** (string) - The name of the campaign.
  - **goal** (string) - The campaign's objective.
  - **billingType** (string) - The type of billing for the campaign.
  - **enabled** (boolean) - Indicates if the campaign is enabled.
  - **attributionClickUrl** (string) - The URL for click attribution.
  - **attributionStartUrl** (string) - The URL for start attribution.
  - **attributionViewUrl** (string) - The URL for view attribution.
  - **scheduleStart** (string) - The start date for the campaign schedule.
  - **scheduleEnd** (string) - The end date for the campaign schedule.
  - **createdAt** (string) - The timestamp when the campaign was created.
  - **updatedAt** (string) - The timestamp when the campaign was last updated.
  - **biddingStrategy** (string) - The bidding strategy for the campaign.
  - **cpiBids** (array) - An array of bid objects for CPI campaigns.
  - **sourceBids** (array) - An array of bid objects for source-specific bids.
  - **retentionBids** (array) - An array of bid objects for retention campaigns.
  - **eventOptimizationBids** (array) - An array of bid objects for event optimization campaigns.
  - **eventOptimizationType** (string) - The type of event to optimize for.
  - **sdkEventName** (string) - The name of the SDK event to track.
  - **budget** (object) - The campaign budget configuration.
    - **total** (string) - The total budget for the campaign.
    - **dailySpent** (string) - The amount spent daily.
    - **spent** (string) - The total amount spent.
    - **daily** (string) - The daily budget for the campaign.

#### Response Example
```json
{
  "total": 1,
  "results": [
    {
      "id": "5eb26a338a232100e4bb6361",
      "name": "CPI campaign for My Game",
      "goal": "installs",
      "billingType": "cpi",
      "enabled": true,
      "attributionClickUrl": "https://example.com/{ifa}",
      "attributionStartUrl": "https://example.com/{ifa}",
      "attributionViewUrl": "https://example.com/{ifa}",
      "scheduleStart": "2020-08-25",
      "scheduleEnd": "2020-11-02",
      "createdAt": "2020-07-20T18:30:51.243Z",
      "updatedAt": "2020-08-25T11:55:20.651Z",
      "biddingStrategy": "manual",
      "cpiBids": [
        {
          "country": "US",
          "bid": "0.201"
        }
      ],
      "sourceBids": [
        {
          "country": "US",
          "sourceAppId": "0a1b2c3D4E5f",
          "bid": "0.201"
        }
      ],
      "retentionBids": [
        {
          "country": "US",
          "baseBid": "0.755",
          "maxBid": "0.255"
        }
      ],
      "eventOptimizationBids": [
        {
          "country": "US",
          "bid": "0.755"
        }
      ],
      "eventOptimizationType": "level_complete",
      "sdkEventName": "level_complete_1",
      "budget": {
        "total": "2500.20",
        "dailySpent": "1800.32",
        "spent": "1800.32",
        "daily": "2500.20"
      }
    }
  ]
}
```

#### Error Responses
- **400** - Bad Request: The request was invalid.
- **401** - Unauthorized: Authentication failed.
- **403** - Forbidden: Insufficient permissions.
- **404** - Not Found: The requested resource was not found.
- **429** - Too Many Requests: Rate limit exceeded.
- **500** - Internal Server Error: An error occurred on the server.
- **503** - Service Unavailable: The service is temporarily unavailable.
```

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

### Get Campaign Budget

Source: https://services.docs.unity.com/advertise/v1/index

Retrieves the current campaign budget details for a specified campaign within an organization.

```APIDOC
## GET /advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/campaigns/{campaignId}/budget

### Description
This endpoint is used to get campaign budget for a certain campaign.

### Method
GET

### Endpoint
`/advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/campaigns/{campaignId}/budget`

### Parameters
#### Path Parameters
- **organizationId** (integer) - Required - Core ID of the organization. You can look up your Organization's ID by opening up the Acquire Dashboard and by looking up the ID from the browser's address bar: `https://dashboard.unity3d.com/organizations/<ORGANIZATION_ID_IS_HERE>/acquire/about` For more information about the IDs, refer to the Resource IDs documentation.
- **campaignSetId** (string) - Required - Unique identifier for an App.
- **campaignId** (string) - Required - ID of the campaign

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **total** (string) - Total budget amount.
- **dailySpent** (string) - Amount spent daily.
- **spent** (string) - Total amount spent.
- **daily** (string) - Daily budget limit.

#### Response Example
```json
{
  "appTargeting": {
    "allowList": [
      "0a1b2c3D4E5f"
    ]
  },
  "deviceTargeting": {
    "limitedAdTracking": [
      "USERS_ALLOWING_AD_TRACKING"
    ],
    "osMin": "14.0",
    "osMax": "latest",
    "connectionType": [
      "wifi"
    ],
    "screenSize": [
      "small"
    ],
    "screenDensity": [
      "ldpi"
    ]
  },
  "categoryTargeting": {
    "allowList": [
      "Unknown"
    ]
  },
  "regionalTargeting": [
    {
      "country": "AD",
      "subdivisions": [
        3039162
      ]
    }
  ]
}
```
```

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

### Enable Response Compression with cURL

Source: https://services.docs.unity.com/advertise/v1/index

Demonstrates how to enable response compression (gzip) for API requests using cURL. This requires setting the 'Accept-Encoding' header to 'gzip' in the request.

```shell
curl -H "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" -H "Accept-Encoding: gzip" https://services.api.unity.com/advertise/v1/organizations/5772680389521/apps/5ee23a52c10f9455722a5ead/campaigns/5ee23a557de7e87ee0958dfc/source-bids
```

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

### GET /advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/audience-pinpointer/retention-info

Source: https://services.docs.unity.com/advertise/v1/index

Retrieves information about countries eligible for Retention campaigns.

```APIDOC
## List Retention Eligibility

This endpoint returns information about which countries are currently available to be used in the Retention campaigns.

### Method
GET

### Endpoint
`/advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/audience-pinpointer/retention-info`

### Path Parameters
- **organizationId** (integer) - Required - Core ID of the organization.
- **campaignSetId** (string) - Required - Unique identifier for an App.

### Response
#### Success Response (200)
- **total** (integer) - The total number of results.
- **results** (array) - An array of country objects.
  - **country** (string) - The country code.

#### Response Example
```json
{
  "total": 1,
  "results": [
    {
      "country": "US"
    }
  ]
}
```
```

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

### GET /organizations/{organizationId}/apps/{campaignSetId}

Source: https://services.docs.unity.com/advertise/v1/index

Retrieves detailed information about a specific app using its ID.

```APIDOC
## GET /organizations/{organizationId}/apps/{campaignSetId}

### Description
Returns the app information for a given app ID.

### Method
GET

### Endpoint
`/organizations/{organizationId}/apps/{campaignSetId}`

### Parameters
#### Path Parameters
- **organizationId** (integer) - Required - The core ID of the organization.
- **campaignSetId** (string) - Required - Unique identifier for an App.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the app.
- **name** (string) - The name of the app.
- **store** (string) - The app store (e.g., 'apple').
- **storeId** (string) - The app's identifier in the store.
- **adomain** (string) - The advertiser domain of the app.
- **gameId** (integer) - The game ID associated with the app.
- **createdAt** (string) - Timestamp when the app was created.
- **updatedAt** (string) - Timestamp when the app was last updated.
- **appAttributionClickUrl** (string) - URL for click attribution.
- **appAttributionStartUrl** (string) - URL for start attribution.
- **appAttributionViewUrl** (string) - Deprecated URL for view attribution.

#### Response Example
```json
{
  "id": "5eb26a338a232100e4bb5893",
  "name": "My Game",
  "store": "apple",
  "storeId": "com.companyname.appname",
  "adomain": "example.com",
  "gameId": 500000007,
  "createdAt": "2020-07-20T18:30:51.243Z",
  "updatedAt": "2020-08-25T11:55:20.651Z",
  "appAttributionClickUrl": "https://example.com/{ifa}",
  "appAttributionStartUrl": "https://example.com/{ifa}",
  "appAttributionViewUrl": "https://example.com/{ifa}"
}
```
```

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

### Patch Advertise App v1 Response Sample (200 OK)

Source: https://services.docs.unity.com/advertise/v1/index

This is a sample successful response (200 OK) when patching an app's advertising configuration. It returns the updated app details, including its ID, name, store, store ID, adomain, game ID, and attribution URLs.

```json
{
  "id": "5eb26a338a232100e4bb5893",
  "name": "My Game",
  "store": "apple",
  "storeId": "com.companyname.appname",
  "adomain": "example.com",
  "gameId": 500000007,
  "createdAt": "2020-07-20T18:30:51.243Z",
  "updatedAt": "2020-08-25T11:55:20.651Z",
  "appAttributionClickUrl": "https://example.com/{ifa}",
  "appAttributionStartUrl": "https://example.com/{ifa}",
  "appAttributionViewUrl": "https://example.com/{ifa}"
}
```

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

### GET /advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/campaigns/{campaignId}/retention-bids

Source: https://services.docs.unity.com/advertise/v1/index

Retrieves the retention bids for a specific campaign.

```APIDOC
## List Retention Bids

This endpoint returns campaign's retention bids.

### Method
GET

### Endpoint
`/advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/campaigns/{campaignId}/retention-bids`

### Path Parameters
- **organizationId** (integer) - Required - Core ID of the organization.
- **campaignSetId** (string) - Required - Unique identifier for an App.
- **campaignId** (string) - Required - ID of the campaign.

### Response
#### Success Response (200)
- **total** (integer) - The total number of results.
- **results** (array) - An array of retention bid objects.
  - **country** (string) - The country code.
  - **baseBid** (string) - The base bid amount.
  - **maxBid** (string) - The maximum bid amount.

#### Response Example
```json
{
  "total": 1,
  "results": [
    {
      "country": "US",
      "baseBid": "0.755",
      "maxBid": "0.255"
    }
  ]
}
```
```

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

### GET /advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/campaigns/{campaignId}/cpi-bids

Source: https://services.docs.unity.com/advertise/v1/index

Retrieves a list of CPI bids for a specific campaign.

```APIDOC
## GET /advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/campaigns/{campaignId}/cpi-bids

### Description
Retrieves a list of CPI bids for a specific campaign, including country and bid amount.

### Method
GET

### Endpoint
`/advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/campaigns/{campaignId}/cpi-bids`

### Parameters
#### Path Parameters
- **organizationId** (integer) - Required - Core ID of the organization. Example: `5772680389521`
- **campaignSetId** (string) - Required - Unique identifier for an App. Example: `5eb26a338a232100e4bb5893`
- **campaignId** (string) - Required - ID of the campaign. Example: `5eb26a338a232100e4bb6361`

### Response
#### Success Response (200)
- **total** (integer) - The total number of results.
- **results** (array) - A list of CPI bids.
  - **country** (string) - Country code in ISO 3166-1 alpha-2 format.
  - **bid** (string) - The bid amount in dollars.

#### Response Example
```json
{
  "total": 1,
  "results": [
    {
      "country": "US",
      "bid": "0.201"
    }
  ]
}
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **403** Forbidden
- **404** Not Found
- **429** Too Many Requests
- **500** Internal Server Error
- **503** Service Unavailable
```

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

### GET /advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/creatives/{creativeId}

Source: https://services.docs.unity.com/advertise/v1/index

Retrieves details for a specific advertising creative associated with an organization and app.

```APIDOC
## GET /advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/creatives/{creativeId}

### Description
Retrieves details for a specific advertising creative associated with an organization and app.

### Method
GET

### Endpoint
`/advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/creatives/{creativeId}`

### Parameters
#### Path Parameters
- **organizationId** (integer) - Required - Core ID of the organization. Example: 5772680389521
- **campaignSetId** (string) - Required - Unique identifier for an App. Regex: `^[0-9a-fA-F]{24}$`. Example: 5eb26a338a232100e4bb5893
- **creativeId** (string) - Required - ID of the creative. Regex: `^[0-9a-fA-F]{24}$`. Example: 5eb26a338a232100e4cc9945

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the creative.
- **name** (string) - The name of the creative.
- **language** (string) - The language of the creative.
- **type** (string) - The type of the creative (e.g., "landscapeVideo").
- **files** (array) - A list of files associated with the creative.
  - **name** (string) - The name of the file.
  - **url** (string) - The URL of the file.
- **createdAt** (string) - The timestamp when the creative was created.
- **status** (string) - The current status of the creative (e.g., "approved").

#### Response Example
```json
{
  "id": "5eb26a338a232100e4cc9945",
  "name": "My Creative",
  "language": "en",
  "type": "landscapeVideo",
  "files": [
    {
      "name": "string",
      "url": "https://example.com/directory/image.jpg"
    }
  ],
  "createdAt": "2020-07-20T18:30:51.243Z",
  "status": "approved"
}
```
```

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

### GET /advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/audience-pinpointer/roas-info

Source: https://services.docs.unity.com/advertise/v1/index

Retrieves information about countries eligible for ROAS campaigns and related ROAS data.

```APIDOC
## GET /advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/audience-pinpointer/roas-info

### Description
This endpoint returns information about which countries are currently eligible to be used in Return On Ad Spend (ROAS) campaigns and additional ROAS-related information.

### Method
GET

### Endpoint
https://services.api.unity.com/advertise/v1/organizations/{organizationId}/apps/{campaignSetId}/audience-pinpointer/roas-info

### Parameters
#### Path Parameters
- **organizationId** (integer) - Required - Core ID of the organization.
- **campaignSetId** (string) - Required - Unique identifier for an App.

#### Query Parameters
- **postInstallWindow** (string) - Optional - Post-install window of the ROAS campaign (defaults to D7 if not provided). Enum: "d0" "d7"

### Response
#### Success Response (200)
- **total** (integer) - The total number of results.
- **results** (array) - A list of countries and ROAS information for those countries that are eligible for ROAS campaigns.
  - **country** (string) - Country code in ISO 3166-1 alpha-2 format.
  - **suggestedIapGoal** (string) - Suggested In-App Purchase goal for ROAS campaigns.
  - **suggestedAdRevenueGoal** (string) - Suggested Ad Revenue goal for ROAS campaigns.
  - **eligibility** (array) - List of eligibility criteria (e.g., "iap").

#### Response Example
```json
{
  "total": 1,
  "results": [
    {
      "country": "US",
      "suggestedIapGoal": "12.34",
      "suggestedAdRevenueGoal": "12.34",
      "eligibility": [
        "iap"
      ]
    }
  ]
}
```
```

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

### Create Creative

Source: https://services.docs.unity.com/advertise/v1/index

Allows uploading creative assets such as videos and images. Supports various creative types including square end cards, end card pairs, portrait videos, landscape videos, and playable ads.

```APIDOC
## POST /organizations/{organizationId}/apps/{appId}/creatives

### Description
Uploads creative assets to be used in ad campaigns. Supports various types like videos, images, and playable ads.

### Method
POST

### Endpoint
`/organizations/{organizationId}/apps/{appId}/creatives`

### Parameters
#### Path Parameters
- **organizationId** (string) - Required - The ID of the organization.
- **appId** (string) - Required - The ID of the app.

#### Request Body
- **creativeInfo** (object) - Required - Information about the creative, including name, language, and type.
  - **name** (string) - Required - The name of the creative.
  - **language** (string) - Required - The language of the creative (e.g., "en").
  - **video** (object) - Optional - Video specific information.
    - **fileName** (string) - Required - The name of the video file.
- **videoFile** (file) - Optional - The video file to upload.
- **imageFile** (file) - Optional - The image file to upload.

### Request Example
```bash
curl --verbose \
 --form 'creativeInfo={"name": "My Portrait Video", "language": "en", "video": {"fileName":"myPortraitVideo.mp4"}}' \
 --form "videoFile=@/path/to/your/file/myPortraitVideo.mp4" \
 --header "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" \
 https://services.api.unity.com/advertise/v1/organizations/<ORGANIZATION_ID>/apps/<CAMPAIGN_SET_ID>/creatives
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the created creative.
- **name** (string) - The name of the creative.
- **language** (string) - The language of the creative.
- **type** (string) - The type of the creative (e.g., "portraitVideo").
- **createdAt** (string) - The timestamp when the creative was created.
- **status** (string) - The current status of the creative (e.g., "uploaded").

#### Response Example
```json
{
  "id": "5fd363cf5d84aa0ed76956b1",
  "name": "My Portrait Video",
  "language": "en",
  "type": "portraitVideo",
  "createdAt": "2020-12-11T12:19:29.004Z",
  "status": "uploaded"
}
```
```

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

### List Apps with Limit using Unity Ads Management API (curl)

Source: https://services.docs.unity.com/advertise/v1/index

This curl command shows how to list applications with a specified limit on the number of returned apps. It includes the Authorization header and appends the 'limit' query parameter to the request URL. This is useful for paginating or controlling the size of the response.

```curl
curl -H "Authorization: Basic N2UwZjExNTItZTBkZC00YjE0LThlMzctMDRjYWIwN2VmZWIwOk5LeG9ScDJtMnczZTlnekpmc3NOUW5UZnlwRmd0Sm43" \ https://services.api.unity.com/advertise/v1/organizations/5772562874846/apps?limit=1

```
Tokens:
Raw