Aller au contenu
ReadyZone Docs
Référence API

Publicités publiques

Lister les publicités publiques d’une zone.

GET /api/advertisements/public?companyRef={companyRef}

Accès : Public

Cas d’usage portail

Charger les publicités actives, leurs médias et leurs actions éventuelles dans le portail.

Paramètres

  • companyRef (query, optionnel)

Réponse

La réponse est un tableau JSON de publicités publiques actives.

AttributTypeNullableDescription
idstring (UUID)NonIdentifiant de la publicité.
categorystringNonCatégorie de la publicité.
typestringNontext, image, video ou mixed.
titlestringOuiTitre affiché.
contentstringNonContenu textuel.
mediaUrlstringOuiURL d’une image ou vidéo.
actionLabelstringOuiLibellé du bouton d’action.
actionUrlstringOuiURL ouverte par le bouton.
displayOrdernumberNonOrdre d’affichage.
isActivebooleanNonÉtat d’activation.
expirationAtstring (ISO 8601)OuiDate d’expiration.

Codes de statut

  • 200 OK
  • 400 Bad Request (référence invalide)

Sur cette page