Ads Unified Platform Publisher API • Unity Docs

Get organization test devices

Returns all test devices for the specified organization

Path parameters for "Get organization test devices"

organizationId

number

required

The Genesis ID of the organization

Query parameters for "Get organization test devices"

platform

string

Filter by Platform

HTTP response status codes for "Get organization test devices":

Successfully retrieved test devices

Authentication error

Permission denied

Resource not found

Code samples for "Get organization test devices":

Request example

curl -X GET \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/test-devices"

Response example

[ { "id": "550e8400-e29b-41d4-a716-446655440000", "platform": "iOS", "name": "QA iPhone 15", "advertisingId": "AEBE52E7-03EE-455A-B3C4-E57283966239" }]

Create test device

Creates a test device for the specified organization

Path parameters for "Create test device"

organizationId

number

required

The Genesis ID of the organization

Query parameters for "Create test device"

dryrun

boolean

Dry-run mode. When

true

, the request is fully validated but no changes are persisted (DB writes are rolled back and external calls are skipped). The response echoes the would-be result with an

x-dry-run: true

header. For application create/update, dry-run validates the request and business rules only — it does not reserve names or guarantee downstream acceptance.

Request body for "Create test device"

Media Type:

application/json

platform

string

example: iOS

Device platform

name

string

required

example: QA iPhone 15

Test device display name

advertisingId

string

required

example: AEBE52E7-03EE-455A-B3C4-E57283966239

Advertising device identifier

HTTP response status codes for "Create test device":

Successfully created test device

Invalid request data

Authentication error

Permission denied

Resource not found

Code samples for "Create test device":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "platform": "iOS", "name": "QA iPhone 15", "advertisingId": "AEBE52E7-03EE-455A-B3C4-E57283966239"}' \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/test-devices"

Response example

{ "id": "550e8400-e29b-41d4-a716-446655440000", "platform": "iOS", "name": "QA iPhone 15", "advertisingId": "AEBE52E7-03EE-455A-B3C4-E57283966239"}

Get test device

Returns test device details by id

Path parameters for "Get test device"

organizationId

number

required

The Genesis ID of the organization

testDeviceId

string

required

The Test Device ID

HTTP response status codes for "Get test device":

Successfully retrieved test device

Authentication error

Permission denied

Resource not found

Code samples for "Get test device":

Request example

curl -X GET \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/test-devices/{testDeviceId}"

Response example

{ "id": "550e8400-e29b-41d4-a716-446655440000", "platform": "iOS", "name": "QA iPhone 15", "advertisingId": "AEBE52E7-03EE-455A-B3C4-E57283966239"}

Update test device

Updates an existing test device

Path parameters for "Update test device"

organizationId

number

required

The Genesis ID of the organization

testDeviceId

string

required

The Test Device ID

Query parameters for "Update test device"

dryrun

boolean

Dry-run mode. When

true

, the request is fully validated but no changes are persisted (DB writes are rolled back and external calls are skipped). The response echoes the would-be result with an

x-dry-run: true

header. For application create/update, dry-run validates the request and business rules only — it does not reserve names or guarantee downstream acceptance.

Request body for "Update test device"

Media Type:

application/json

platform

string

example: iOS

Device platform

name

string

example: QA iPhone 15

Test device display name

advertisingId

string

example: AEBE52E7-03EE-455A-B3C4-E57283966239

Advertising device identifier

HTTP response status codes for "Update test device":

Successfully updated test device

Invalid request data

Authentication error

Permission denied

Resource not found

Code samples for "Update test device":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "platform": "iOS", "name": "QA iPhone 15", "advertisingId": "AEBE52E7-03EE-455A-B3C4-E57283966239"}' \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/test-devices/{testDeviceId}"

Response example

{ "id": "550e8400-e29b-41d4-a716-446655440000", "platform": "iOS", "name": "QA iPhone 15", "advertisingId": "AEBE52E7-03EE-455A-B3C4-E57283966239"}

Delete test device

Deletes a test device by id

Path parameters for "Delete test device"

organizationId

number

required

The Genesis ID of the organization

testDeviceId

string

required

The Test Device ID

Query parameters for "Delete test device"

dryrun

boolean

Dry-run mode. When

true

, the request is fully validated but no changes are persisted (DB writes are rolled back and external calls are skipped). The response echoes the would-be result with an

x-dry-run: true

header. For application create/update, dry-run validates the request and business rules only — it does not reserve names or guarantee downstream acceptance.

HTTP response status codes for "Delete test device":

No content

Authentication error

Permission denied

Resource not found

Code samples for "Delete test device":

Request example

curl -X DELETE \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/test-devices/{testDeviceId}"

Response example

Get applications for an organization

Returns all applications associated with a specific organization

Path parameters for "Get applications for an organization"

organizationId

number

required

The Genesis ID of the organization

HTTP response status codes for "Get applications for an organization":

Successfully retrieved organization applications

Authentication error

Permission denied

Resource not found

Code samples for "Get applications for an organization":

Request example

curl -X GET \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications"

Response example

[ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "My Game App", "gameId": 12345, "platform": "iOS", "iconUrl": "https://example.com/icon.png", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "storeId": "com.example.app", "store": "AppleAppStore", "testMode": "forceAll", "kidsSettings": false, "coppa": false, "mixedAudience": false }]

Create an application

Creates a new application for a specific organization

Path parameters for "Create an application"

organizationId

number

required

The Genesis ID of the organization

Query parameters for "Create an application"

dryrun

boolean

Dry-run mode. When

true

, the request is fully validated but no changes are persisted (DB writes are rolled back and external calls are skipped). The response echoes the would-be result with an

x-dry-run: true

header. For application create/update, dry-run validates the request and business rules only — it does not reserve names or guarantee downstream acceptance.

Request body for "Create an application"

Media Type:

application/json

name

string

required

Application name

platform

string

required

Application platform

iconUrl

string

Application icon URL

storeId

string

Store identifier

store

string

Store name

privacy

Privacy settings

projectId

string

ID of the project to associate the new app with

projectName

string

Name for a new project to create and associate the app with. Only used when projectId is not provided; defaults to the application name when omitted.

HTTP response status codes for "Create an application":

Successfully created application

Invalid request data

Authentication error

Permission denied

Code samples for "Create an application":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "platform": "string", "iconUrl": "https://example.com", "storeId": "string", "store": "string", "privacy": { "coppa": true, "mixedAudience": true }, "projectId": "string", "projectName": "string"}' \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications"

Response example

{ "id": "550e8400-e29b-41d4-a716-446655440000", "name": "My Game App", "gameId": 12345, "platform": "iOS", "iconUrl": "https://example.com/icon.png", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "storeId": "com.example.app", "store": "AppleAppStore", "testMode": "forceAll", "kidsSettings": false, "coppa": false, "mixedAudience": false}

Get an application by ID

Returns application metadata for a specific application within an organization

Path parameters for "Get an application by ID"

organizationId

number

required

The Genesis ID of the organization

applicationId

string

required

The Unity App ID

HTTP response status codes for "Get an application by ID":

Successfully retrieved application

Invalid request data

Authentication error

Permission denied

Resource not found

Code samples for "Get an application by ID":

Request example

curl -X GET \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications/{applicationId}"

Response example

{ "id": "550e8400-e29b-41d4-a716-446655440000", "name": "My Game App", "gameId": 12345, "platform": "iOS", "iconUrl": "https://example.com/icon.png", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "storeId": "com.example.app", "store": "AppleAppStore", "testMode": "forceAll", "kidsSettings": false, "coppa": false, "mixedAudience": false}

Update an application

Updates an existing application for a specific organization (partial update)

Path parameters for "Update an application"

organizationId

number

required

The Genesis ID of the organization

applicationId

string

required

The Unity App ID

Query parameters for "Update an application"

dryrun

boolean

Dry-run mode. When

true

, the request is fully validated but no changes are persisted (DB writes are rolled back and external calls are skipped). The response echoes the would-be result with an

x-dry-run: true

header. For application create/update, dry-run validates the request and business rules only — it does not reserve names or guarantee downstream acceptance.

Request body for "Update an application"

Media Type:

application/json

name

string

Application name

storeId

string

Store identifier

store

string

Store name

privacy

Privacy settings

kidsSettings

boolean

Kids settings flag. When true, triggers a USF update with coppa=true.

HTTP response status codes for "Update an application":

Successfully updated application

Invalid request data

Authentication error

Permission denied

Resource not found

Resource conflict

Code samples for "Update an application":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "name": "string", "storeId": "string", "store": "string", "privacy": { "coppa": true, "mixedAudience": true }, "kidsSettings": true}' \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications/{applicationId}"

Response example

{ "id": "550e8400-e29b-41d4-a716-446655440000", "name": "My Game App", "gameId": 12345, "platform": "iOS", "iconUrl": "https://example.com/icon.png", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "storeId": "com.example.app", "store": "AppleAppStore", "testMode": "forceAll", "kidsSettings": false, "coppa": false, "mixedAudience": false}

Get test mode

Get application test mode value.

Path parameters for "Get test mode"

organizationId

number

required

The Genesis ID of the organization

applicationId

string

required

The Unity App ID

HTTP response status codes for "Get test mode":

Successfully retrieved test mode

Authentication error

Permission denied

Resource not found

Code samples for "Get test mode":

Request example

curl -X GET \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications/{applicationId}/test-mode"

Response example

{ "id": "550e8400-e29b-41d4-a716-446655440000", "gameId": 12345, "testMode": "forceAll"}

Update test mode

Update application test mode value.

Path parameters for "Update test mode"

organizationId

number

required

The Genesis ID of the organization

applicationId

string

required

The Unity App ID

Query parameters for "Update test mode"

dryrun

boolean

Dry-run mode. When

true

, the request is fully validated but no changes are persisted (DB writes are rolled back and external calls are skipped). The response echoes the would-be result with an

x-dry-run: true

header. For application create/update, dry-run validates the request and business rules only — it does not reserve names or guarantee downstream acceptance.

Request body for "Update test mode"

Media Type:

application/json

testMode

string

required

example: forceAll

Test Mode

HTTP response status codes for "Update test mode":

Successfully updated test mode

Invalid request data

Authentication error

Permission denied

Resource not found

Code samples for "Update test mode":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "testMode": "forceAll"}' \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications/{applicationId}/test-mode"

Response example

{ "id": "550e8400-e29b-41d4-a716-446655440000", "gameId": 12345, "testMode": "forceAll"}

Get placements

Returns all placements for a specific organization and application

Path parameters for "Get placements"

organizationId

number

required

The Genesis ID of the organization

applicationId

string

required

The Unity App ID

Query parameters for "Get placements"

isArchived

boolean

Filter by Archive/Unarchive

adFormat

array

Filter by ad formats

HTTP response status codes for "Get placements":

Successfully retrieved placements

Authentication error

Permission denied

Resource not found

Code samples for "Get placements":

Request example

curl -X GET \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications/{applicationId}/placements"

Response example

[ { "id": "550e8400-e29b-41d4-a716-446655440000", "key": "Rewarded_Placement", "name": "Rewarded Video", "gameId": 12345, "adFormat": "rewarded", "status": "active", "adFormatConfigurations": {}, "applicationId": "550e8400-e29b-41d4-a716-446655440000", "archivedAt": "2024-01-01T00:00:00.000Z", "createdAt": "2024-01-01T00:00:00.000Z", "updatedAt": "2024-01-01T00:00:00.000Z" }]

Create placement

Creates a new placement for a specific organization and application

Path parameters for "Create placement"

organizationId

number

required

The Genesis ID of the organization

applicationId

string

required

The Unity App ID

Query parameters for "Create placement"

dryrun

boolean

Dry-run mode. When

true

, the request is fully validated but no changes are persisted (DB writes are rolled back and external calls are skipped). The response echoes the would-be result with an

x-dry-run: true

header. For application create/update, dry-run validates the request and business rules only — it does not reserve names or guarantee downstream acceptance.

Request body for "Create placement"

Media Type:

application/json

name

string

required

example: Rewarded Placement

Placement name

adFormat

string

required

example: rewarded

Placement Ad format type

adFormatConfigurations

Ad Format Configuration. Structure depends on adFormat

HTTP response status codes for "Create placement":

Successfully created placement

Invalid request data

Authentication error

Permission denied

Resource conflict

Code samples for "Create placement":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "Rewarded Placement", "adFormat": "rewarded", "adFormatConfigurations": { "name": "coins", "value": 100, "adminSettings": { "allowSkip": false, "allowSkipInSeconds": 5, "videoPlayableSkipInSeconds": 5, "closeTimerDuration": 5, "tapsToClose": 2, "muteVideo": true, "disableVideoControlsFade": true, "useCloseIconInsteadOfSkipIcon": true } }}' \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications/{applicationId}/placements"

Response example

{ "id": "550e8400-e29b-41d4-a716-446655440000", "key": "Rewarded_Placement", "name": "Rewarded Video", "gameId": 12345, "adFormat": "rewarded", "status": "active", "adFormatConfigurations": {}, "applicationId": "550e8400-e29b-41d4-a716-446655440000", "archivedAt": "2024-01-01T00:00:00.000Z", "createdAt": "2024-01-01T00:00:00.000Z", "updatedAt": "2024-01-01T00:00:00.000Z"}

Get a placement details

Get an existing placement details for a specific organization and application

Path parameters for "Get a placement details"

organizationId

number

required

The Genesis ID of the organization

applicationId

string

required

The Unity App ID

placementId

string

required

The Placement ID

HTTP response status codes for "Get a placement details":

Successfully retrieved placement

Authentication error

Permission denied

Resource not found

Code samples for "Get a placement details":

Request example

curl -X GET \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications/{applicationId}/placements/{placementId}"

Response example

{ "id": "550e8400-e29b-41d4-a716-446655440000", "key": "Rewarded_Placement", "name": "Rewarded Video", "gameId": 12345, "adFormat": "rewarded", "status": "active", "adFormatConfigurations": {}, "applicationId": "550e8400-e29b-41d4-a716-446655440000", "archivedAt": "2024-01-01T00:00:00.000Z", "createdAt": "2024-01-01T00:00:00.000Z", "updatedAt": "2024-01-01T00:00:00.000Z"}

Update a placement

Updates an existing placement for a specific organization and application

Path parameters for "Update a placement"

organizationId

number

required

The Genesis ID of the organization

applicationId

string

required

The Unity App ID

placementId

string

required

The Placement ID

Query parameters for "Update a placement"

dryrun

boolean

Dry-run mode. When

true

, the request is fully validated but no changes are persisted (DB writes are rolled back and external calls are skipped). The response echoes the would-be result with an

x-dry-run: true

header. For application create/update, dry-run validates the request and business rules only — it does not reserve names or guarantee downstream acceptance.

Request body for "Update a placement"

Media Type:

application/json

name

string

required

example: Rewarded Placement

Placement name

adFormat

string

required

example: rewarded

Placement Ad format type

adFormatConfigurations

Ad Format Configuration. Structure depends on adFormat

HTTP response status codes for "Update a placement":

Successfully updated placement

Invalid request data

Authentication error

Permission denied

Resource not found

Code samples for "Update a placement":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "name": "Rewarded Placement", "adFormat": "rewarded", "adFormatConfigurations": { "name": "coins", "value": 100, "adminSettings": { "allowSkip": false, "allowSkipInSeconds": 5, "videoPlayableSkipInSeconds": 5, "closeTimerDuration": 5, "tapsToClose": 2, "muteVideo": true, "disableVideoControlsFade": true, "useCloseIconInsteadOfSkipIcon": true } }}' \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications/{applicationId}/placements/{placementId}"

Response example

{ "id": "550e8400-e29b-41d4-a716-446655440000", "key": "Rewarded_Placement", "name": "Rewarded Video", "gameId": 12345, "adFormat": "rewarded", "status": "active", "adFormatConfigurations": {}, "applicationId": "550e8400-e29b-41d4-a716-446655440000", "archivedAt": "2024-01-01T00:00:00.000Z", "createdAt": "2024-01-01T00:00:00.000Z", "updatedAt": "2024-01-01T00:00:00.000Z"}

Archive (soft delete) a placement

Archive an existing placement for a specific organization and application

Path parameters for "Archive (soft delete) a placement"

organizationId

number

required

The Genesis ID of the organization

applicationId

string

required

The Unity App ID

placementId

string

required

The Placement ID

Query parameters for "Archive (soft delete) a placement"

dryrun

boolean

Dry-run mode. When

true

, the request is fully validated but no changes are persisted (DB writes are rolled back and external calls are skipped). The response echoes the would-be result with an

x-dry-run: true

header. For application create/update, dry-run validates the request and business rules only — it does not reserve names or guarantee downstream acceptance.

HTTP response status codes for "Archive (soft delete) a placement":

No content

Authentication error

Permission denied

Resource not found

Code samples for "Archive (soft delete) a placement":

Request example

curl -X DELETE \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications/{applicationId}/placements/{placementId}"

Response example

Un-Archive (restore) a placement

Un-Archive an existing placement for a specific organization and application

Path parameters for "Un-Archive (restore) a placement"

organizationId

number

required

The Genesis ID of the organization

applicationId

string

required

The Unity App ID

placementId

string

required

The Placement ID

Query parameters for "Un-Archive (restore) a placement"

dryrun

boolean

Dry-run mode. When

true

, the request is fully validated but no changes are persisted (DB writes are rolled back and external calls are skipped). The response echoes the would-be result with an

x-dry-run: true

header. For application create/update, dry-run validates the request and business rules only — it does not reserve names or guarantee downstream acceptance.

HTTP response status codes for "Un-Archive (restore) a placement":

Successfully un-archived placement

Invalid request data

Authentication error

Permission denied

Resource not found

Code samples for "Un-Archive (restore) a placement":

Request example

curl -X PATCH \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/applications/{applicationId}/placements/{placementId}/restore"

Response example

Get placements for an organization

Returns all active iOS/Android placements across every application in the organization

Path parameters for "Get placements for an organization"

organizationId

number

required

The Genesis ID of the organization

HTTP response status codes for "Get placements for an organization":

Successfully retrieved organization placements

Authentication error

Permission denied

Resource not found

Code samples for "Get placements for an organization":

Request example

curl -X GET \ "https://services.api.unity.com/ads/publisher/public/v1/organizations/{organizationId}/placements"

Response example

[ { "placementId": "Banner_Android", "name": "Banner Android", "placementType": "bidding", "gameId": 1052964, "adFormat": "banner", "platform": "android", "storeId": "com.google" }]

Ads Unified Platform Publisher Public API

Get organization test devices

Path parameters for "Get organization test devices"

organizationId

Query parameters for "Get organization test devices"

platform

HTTP response status codes for "Get organization test devices":

200Successfully retrieved test devices

401Authentication error

403Permission denied

404Resource not found

Code samples for "Get organization test devices":

Request example

Response example

GET/public/v1/organizations/{organizationId}/test-devices

Create test device

Path parameters for "Create test device"

organizationId

Query parameters for "Create test device"

dryrun

Request body for "Create test device"

platform

name

advertisingId

HTTP response status codes for "Create test device":

201Successfully created test device

400Invalid request data

401Authentication error

403Permission denied

404Resource not found

Code samples for "Create test device":

Request example

Response example

POST/public/v1/organizations/{organizationId}/test-devices

Get test device

Path parameters for "Get test device"

organizationId

testDeviceId

HTTP response status codes for "Get test device":

200Successfully retrieved test device

401Authentication error

403Permission denied

404Resource not found

Code samples for "Get test device":

Request example

Response example

GET/public/v1/organizations/{organizationId}/test-devices/{testDeviceId}

Update test device

Path parameters for "Update test device"

organizationId

testDeviceId

Query parameters for "Update test device"

dryrun

Request body for "Update test device"

platform

name

advertisingId

HTTP response status codes for "Update test device":

200Successfully updated test device

400Invalid request data

401Authentication error

403Permission denied

404Resource not found

Code samples for "Update test device":

Request example

Response example

PATCH/public/v1/organizations/{organizationId}/test-devices/{testDeviceId}

Delete test device

Path parameters for "Delete test device"

organizationId

testDeviceId

Query parameters for "Delete test device"

dryrun

HTTP response status codes for "Delete test device":

204No content

401Authentication error

403Permission denied

404Resource not found

Code samples for "Delete test device":

Request example