La personnalisation avec les métadonnées

Il est possible de personnaliser l'affichage grâce à des métadonnées.

Ces métadonnées sont récupérées directement auprès de l'API dans les modes d'usage de collecte et de relecture ou fournis par l'utilisateur pendant la conception.

Les métadonnées fournies doivent respecter ce type :

type Logo = {
  label: string
  url: string
}

type Metadata = {
  context: 'household' | 'business'
  label: string
  logos?: { main: Logo; secondaries?: Logo[] }
  objectives: string
  personalization?: {
    name: string
    value: string
  }[]
}

• Le context sert à savoir si l'enquête concerne une entreprise ou un ménage. Il n'est pas utilisé aujourd'hui.
• Le label de l'enquête (label) sert à personnaliser l'entête.
• Les logos servent à personnaliser l'entête et le pied de page
  • le logo principal (main) est utilisé dans les deux élements
  • les logos secondaires (secondaries) servent uniquement au pied de page
• L'objectif court de l'enquête (objectives) sert à personnaliser la page d'accueil.
• La personalization sert à fournir les variables whoAnswers1, whoAnswers2 whoAnswers3. Ceci est temporaire, l'api doit prochainement renvoyer des métadonnées sous le format décris ici. Le code est prêt à recevoir ce nouveau format.