Placement Level

Here you can find the endpoints and parameters for Placements, using the DT Management API.

Get Placement / Placements

Description

Return the placement’s configuration by placement ID.

Return all placements of a single app.

Method

GET https://console.fyber.com/api/management/v1/placement?placementId=

GET https://console.fyber.com/api/management/v1/placement?appId=

Headers

ContentType: application/json Authorization: Bearer <Access Token from Authentication Response>

Request Parameters

Key

Description

Type

Required

Example

placementId

The ID of the Placement

Number

Required

10804

appId

The ID of the app

Number

Required

170709

Example Request

https://console.fyber.com/api/management/v1/placement?placementId=10804

Response Parameters

Key

Description

Type

Example

placementId

The ID of the Placement

String

“24542”

status

The status of the placement. Can be either "active" or "inactive"

String

"active"

name

The name of the Placement

String

"int_13"

appId

The ID of the Placement's app

String

"12345"

placementType

The Placement type ("Banner", "Rewarded", "Interstitial", "MREC")

String

"Banner"

coppa

Children's Online Privacy Protection Act. Is the app directed to children under 13 years of age?

Boolean

false

createTypes (Interstitial only)

Allowed creative types for interstitial Placement

String array

["video", "display"]

bannerRefresh (Banner only)

Set the Refresh Interval for the app banner placement. This determines the frequency in which a banner placement is refreshed.

Number

floorPrices

The minimal price at which you are willing to sell your inventory. By default, it is set to $0.01 for all countries.

Object array (country: string, price: number)

[{ “country”: “WW”, “price”: 0.01 },{ “country”: “IL”, “price”: 0.05 }]

targetingEnabled

Enable audience targeting by countries or connection type

Boolean

true

geo

Geo target countries

Object (include: boolean, countries: string array)

{ "countries": [ "BT", "SG" ], "include": true }

connectivity

Targeted connection type (“Cellular”, “WIFI”)

String array

[“WIFI”]

capping

*only if enabled=true Limit the number of impressions per second / minute / day

Object (value: number, unit: string, enabled: boolean)

{ "value": 12, "unit": "minute", "enabled": true }

pacing

*only if enabled=true Set the pace for the maximum number of ad impressions per second / miמute / day / hour

Object (value: number, unit: string, enabled: boolean)

{ "value": 12, "unit": "minute", "enabled": true }

ssrConfig (Rewarded only)

*only if enabled=true

Object (currency: string, amount: number, enabled: boolean)

{"currency": "dollars", "amount": 3456, "enabled": true }

skipability

Ads can be skippable or non-skippable

String

"NonSkippable"

Response Example

{
  "placementId": "10804",
  "name": "Rewarded Placement",
  "appId": "170709",
  "placementType": "Rewarded",
  "status": "active",
  "coppa": true,
  "rewardedConfig": {
    "id": "",
    "currency": {
      "id": "dollars",
      "appId": "",
      "currency": "dollars"
    },
    "amount": 3456,
    "rewardingType": "server",
    "placementId": ""
  },
  "floorPrices": [
    {
      "country": "AF",
      "price": 0.05
    },
    {
      "country": "SG",
      "price": 0.03
    },
    {
      "country": "WW",
      "price": 0.01
    }
  ],
  "targetingEnabled": true,
  "geo": {
    "include": true,
    "countries": [
      "BT"
    ]
  },
  "capping": {
    "value": 12,
    "unit": "minute",
    "enabled": true
  },
  "pacing": {
    "value": 13,
    "unit": "second",
    "enabled": true
  }
}

Create a Placement

Description

Create a new placement

Method

POST https://console.fyber.com/api/management/v1/placement

Headers

ContentType: application/json Authorization: Bearer <Access Token from Authentication Response>

Request Parameters

Key

Description

Type

Required

Example

name

The name of the placement

String

Required

"int_13"

appId

The ID of the placement's app

String

Required

"12345"

placementType

The placement type ("Banner", "Rewarded", "Interstitial", "MREC")

String

Required

"Rewarded"

coppa

Children's Online Privacy Protection Act. Is the app directed to children under 13 years of age?

Boolean

Required

false

creativeTypes (Interstitial only)

Allowed creative types for interstitial placement

String array

Optional

[“video”, “display״]

bannerRefresh (Banner only)

Set the Refresh Interval for the app banner placement. This determines the frequency in which a banner placement is refreshed.

Number

Optional

floorPrices

The minimal price at which you are willing to sell your inventory. By default, it is set to $0.01 for all countries.

Object Array (country: string, price: number)

Optional

[{ “country”: “WW”, “price”: 0.01 },{ “country”: “IL”, “price”: 0.05 }]

targetingEnabled

Enable audience targeting by countries or connection type

Boolean

Optional

true

geo

Geo target countries *only if targetingEnabled=true

Object (include: boolean, countries: string array)

Optional

{ "countries": ["BT", "SG" ], "include": true }

connectivity

Targeted connection type (“Cellular”, “WIFI”) **only if targetingEnabled=true

String array

Optional

[“WIFI”]

capping

*only if enabled=true Limit the number of impressions per second / minute / day

Object (value: number, unit: string, enabled: boolean)

Optional

{ "value": 12, "unit": "minute", "enabled": true }

pacing

*only if enabled=true Set the pace for the maximum number of ad impressions per second / miמute / day / hour

Object (value: number, unit: string, enabled: boolean)

Optional

{ "value": 12, "unit": "minute", "enabled": true }

ssrConfig (Rewarded only)

*only if enabled=true

Object (currency: string, amount: number, enabled: boolean)

Optional

{"currency": "dollars", "amount": 3456, "enabled": true }

skipability

Ads can be skippable or non-skippable

String

Optional

"NonSkippable"

Example Request

{
  "name": "int_13",
  "appId": "12345",
  "placementType": "Rewarded",
  "coppa": true,
  "ssrConfig": {
    "currency": "dollars",
    "amount": 3456,
    "enabled": true
  },
  "targetingEnabled": true,
  "geo": {
    "countries": [
      "BT",
      "SG"
    ],
    "include": true
  },
  "connectivity": [
    "WIFI"
  ],
  "floorPrices": [
    {
      "price": 0.05,
      "country": "AF"
    },
    {
      "price": 0.03,
      "country": "SG"
    }
  ],
  "capping": {
    "value": 12,
    "unit": "minute",
    "enabled": true
  },
  "pacing": {
    "value": 13,
    "unit": "second",
    "enabled": true
  }
}

Response Parameters

Key

Description

Type

Example

placementId

The ID of the newly created placement

String

“24542”

status

The status of the placement. Can be either "active" or "inactive"

String

“active”

name

The name of the placement

String

“int_13”

appId

The ID of the placement's app

String

“12354”

placementType

The placement type ("Banner", "Rewarded" or "Interstitial", "MREC")

String

“Banner”

coppa

Children's Online Privacy Protection Act. Is the app directed to children under 13 years of age?

Boolean

false

creativeTypes (Interstitial only)

Allowed creative types for interstitial placement

String Array

[“video”, “display״]

bannerRefresh (Banner only)

Set the Refresh Interval for the app banner placement. This determines the frequency in which a banner placement is refreshed.

Number

floorPrices

The minimal price at which you are willing to sell your inventory. By default, it is set to $0.01 for all countries.

Object array (country: string, price: number)

[{ “country”: “WW”, “price”: 0.01 },{ “country”: “IL”, “price”: 0.05 }]

targetingEnabled

Enable audience targeting by countries or connection type

Boolean

true

geo

Geo target countries

Object (include: boolean, countries: string array)

{ "countries": [ "BT", "SG" ], "include": true }

connectivity

Targeted connection type ("Cellular" or "WIFI")

String array

[“WIFI”]

capping

*only if enabled=true Limit the number of impressions per second / minute / day

Object (value: number, unit: string, enabled" boolean)

{ "value": 12, "unit": "minute", "enabled": true }

pacing

*only if enabled=true Set the pace for the maximum number of ad impressions per second / miמute / day / hour

Object (value: number, unit: string, enabled" boolean)

{ "value": 12, "unit": "minute", "enabled": true }

ssrConfig (Rewarded only)

*only if enabled=true

Object (currency: unit: string, amount, number enabled" boolean)

{"currency": "dollars", "amount": 3456, "enabled": true }

skipability

Ads can be skippable or non-skippable

String

"NonSkippable"

Example Response

{
  "PlacementId": "245254",
  "name": "Rewarded Placement",
  "appId": "170709",
  "placementType": "Rewarded",
  "status": "active",
  "coppa": true,
  "rewardedConfig": {
    "id": "",
    "currency": {
      "id": "dollars",
      "appId": "",
      "currency": "dollars"
    },
    "amount": 3456,
    "rewardingType": "server",
    "placementId": ""
  },
  "floorPrices": [
    {
      "country": "AF",
      "price": 0.05
    },
    {
      "country": "SG",
      "price": 0.03
    },
    {
      "country": "WW",
      "price": 0.01
    }
  ],
  "targetingEnabled": true,
  "geo": {
    "include": true,
    "countries": [
      "BT"
    ]
  },
  "capping": {
    "value": 12,
    "unit": "minute",
    "enabled": true
  },
  "pacing": {
    "value": 13,
    "unit": "second",
    "enabled": true
  }
}

Update a Placement

Description

Update an existing placement by Placement ID.

Method

PUT https://console.fyber.com/api/management/v1/placement

Headers

ContentType: application/json Authorization: Bearer <Access Token from Authentication Response>

Request Parameters

Key

Description

Type

Required

Example

placementId

The ID of the placement

String

Required

"123123"

status

The status of the placement. Can be either "active" or "inactive"

String

Optional

"active"

name

The name of the placement

String

Optional

"int_13"

coppa

Children's Online Privacy Protection Act. Is the app directed to children under 13 years of age?

Boolean

Optional

false

creativeTypes (Interstitial only)

Allowed creative types for Interstitial placement

String array

Optional

[“video”, “display״]

bannerRefresh (Banner only)

Set the Refresh Interval for the app banner placement. This determines the frequency in which a banner placement is refreshed.

Number

Optional

floorPrices

The minimal price at which you are willing to sell your inventory. By default, it is set to $0.01 for all countries.

Object array (country: string, price: number)

Optional

[{ “country”: “WW”, “price”: 0.01 },{ “country”: “IL”, “price”: 0.05 }]

targetingEnabled

Enable audience targeting by countries or connection type

Boolean

Optional

true

geo

Geo target countries *only if targetingEnabled=true

Object (include: boolean, countries: string array)

Optional

{ "countries": [ "BT", "SG" ], "include": true }

connectivity

Targeted connection type ("Cellular" or "WIFI") *only if targetingEnabled=true

String array

Optional

[“WIFI”]

capping

*only if enabled=true Limit the number of impressions per second / minute / day

Object (value: number, unit: string, enabled" boolean)

Optional

{ "value": 12, "unit": "minute", "enabled": true }

pacing

*only if enabled=true Set the pace for the maximum number of ad impressions per second / miמute / day / hour

Object (value: number, unit: string, enabled" boolean)

Optional

{ "value": 12, "unit": "minute", "enabled": true }

ssrConfig (Rewarded only)

*only if enabled=true

Object (currency: unit: string, amount, number enabled" boolean)

Optional

{"currency": "dollars", "amount": 3456, "enabled": true }

skipability

Ads can be skippable or non-skippable

String

Optional

"NonSkippable"

Example Request

{
  "placementId": "12345",
  "name": "updated_name",
  "status": "active",
  "coppa": true,
  "ssrConfig": {
    "currency": "dollars",
    "amount": 3456,
    "enabled": true
  },
  "targetingEnabled": true,
  "geo": {
    "countries": ["BT", "SG"],
    "include": true
  },
  "connectivity": ["WIFI"],
  "floorPrices": [
    {
      "price": 0.05,
      "country": "AF"
    },
    {
      "price": 0.03,
      "country": "SG"
    }
  ],
  "capping": {
    "value": 12,
    "unit": "minute",
    "enabled": true
  },
  "pacing": {
    "value": 13,
    "unit": "second",
    "enabled": true
  }
}

Response Parameters

Key

Description

Type

Example

placementId

The ID of the newly created placement

String

"24542"

status

The status of the placement. Can be either "active" or "inactive"

String

"active"

name

The name of the placement

String

"int_13"

appId

The ID of the placement's app

String

"12345"

placementType

The placement type ("Banner", "Rewarded", "Interstitial", "MREC")

String

"Banner"

coppa

Children's Online Privacy Protection Act. Is the app directed to children under 13 years of age?

Boolean

false

creativeTypes (Interstitial only)

Allowed creative types for Interstitial placement

String array

[“video”, “display״]

bannerRefresh (Banner only)

Set the Refresh Interval for the app banner placement. This determines the frequency in which a banner placement is refreshed.

Number

floorPrices

The minimal price at which you are willing to sell your inventory. By default, it is set to $0.01 for all countries.

Object array (country: string, price: number)

[{ “country”: “WW”, “price”: 0.01 },{ “country”: “IL”, “price”: 0.05 }]

targetingEnabled

Enable audience targeting by countries or connection type

Boolean

true

geo

Geo target countries *only if targetingEnabled=true

Object (include: boolean, countries: string array)

{ "countries": [ "BT", "SG" ], "include": true }

connectivity

Targeted connection type ("Cellular" or "WIFI") *only if targetingEnabled=true

String array

[“WIFI”]

capping

*only if enabled=true Limit the number of impressions per second / minute / day

Object (value: number, unit: string, enabled" boolean)

{ "value": 12, "unit": "minute", "enabled": true }

pacing

*only if enabled=true Set the pace for the maximum number of ad impressions per second / miמute / day / hour

Object (value: number, unit: string, enabled" boolean)

{ "value": 12, "unit": "minute", "enabled": true }

ssrConfig (Rewarded only)

*only if enabled=true

Object (currency: unit: string, amount, number enabled" boolean)

{"currency": "dollars", "amount": 3456, "enabled": true }

skipability

Ads can be skippable or non-skippable

String

"NonSkippable"

Example Response

{
  "placementId": "243713",
  "name": "changedBanner",
  "appId": "170709",
  "placementType": "Banner",
  "status": "active",
  "coppa": false,
  "bannerRefresh": 88,
  "floorPrices": [
    {
      "country": "WW",
      "price": 0.01
    }
  ],
  "targetingEnabled": false
}

Delete a Placement

Description

Delete an existing placement.

Method

DELETE https://console.fyber.com/api/management/v1/placement

Headers

ContentType: application/json Authorization: Bearer <Access Token from Authentication Response>

Request Parameters

Key

Description

Required

Type

placementId

The ID of the placement

Required

String

Example Request

{ "placementId": "123123" }

Example Response

{ "message": "Placement 123123 has been deleted successfully." }

Last updated 14 days ago

Good night

hashtagGet Placement / Placements

hashtagExample Request

hashtagResponse Parameters

hashtagResponse Example

hashtagCreate a Placement

hashtagRequest Parameters

hashtagResponse Parameters

hashtagExample Response

hashtagUpdate a Placement

hashtagRequest Parameters

hashtagExample Request

hashtagResponse Parameters

hashtagExample Response

hashtagDelete a Placement

hashtagRequest Parameters

hashtagExample Request

hashtagExample Response

Get Placement / Placements

Example Request

Response Parameters

Response Example

Create a Placement

Request Parameters

Response Parameters

Example Response

Update a Placement

Request Parameters

Example Request

Response Parameters

Example Response

Delete a Placement

Request Parameters

Example Request

Example Response