Skip to main content

Placements Config Object

Placements configuration object.

idinteger<int32>required
Example: 1
namestringrequired
Example: Homepage placements
start_atintegerrequired
Example: 1735689600
end_atintegerrequired
Example: 1735776000
typePlacement_Type_Enum (string)required

Possible values: [web, in-game]

is_standardbooleanrequired
Example: true
date_addedintegerrequired
Example: 1735689600
date_updatedintegerrequired
Example: 1735776000
placements object[]required
  • Array [
  • idintegerrequired
    Example: 1
    config_typePlacement_Type_Enum (string)required

    Possible values: [web, in-game]

    config_idintegerrequired
    Example: 1
    namestringrequired
    Example: Homepage Placement
    name_localizedstring
    Example: Homepage Placement
    name_localization objectrequired
    property name*string
    display_positionintegerrequired

    Possible values: >= 1

    Example: 1
    totalintegerrequired

    Possible values: >= 1

    Example: 3
    filters objectrequired
    property name*string
    enabledbooleanrequired
    Example: true
    sizePlacement_Size_Enum (string)required

    Possible values: [small, medium, large]

    typestring
    Example: filter
    date_addedinteger<int32>required
    Example: 1735689600
    date_updatedinteger<int32>required
    Example: 1735689600
  • ]
  • Placements Config Object
    {
    "id": 1,
    "name": "Homepage placements",
    "start_at": 1735689600,
    "end_at": 1735776000,
    "type": "web",
    "is_standard": true,
    "date_added": 1735689600,
    "date_updated": 1735776000,
    "placements": [
    {
    "id": 1,
    "config_type": "web",
    "config_id": 1,
    "name": "Homepage Placement",
    "name_localized": "Homepage Placement",
    "name_localization": {
    "en-US": "Homepage Placement",
    "fr-FR": "Placement de la page d'accueil"
    },
    "display_position": 1,
    "total": 3,
    "filters": {
    "timespan": "today"
    },
    "enabled": true,
    "size": "small",
    "type": "filter",
    "date_added": 1735689600,
    "date_updated": 1735689600
    }
    ]
    }