Skip to main content
Un compte n’installe une app qu’une seule fois, quel que soit le nombre d’expériences qu’il ajoute ; une installation contient donc un état qui appartient au compte plutôt qu’à une expérience, comme un curseur de synchronisation ou l’ID du compte auquel il est lié dans un autre système. Utilisez l’API App Installations pour lister les comptes sur lesquels votre app est installée, en récupérer un et mettre à jour les metadata et l’external_id que votre app y conserve. Un compte peut aussi lister les apps installées sur lui, et un développeur toutes les installations de son app. Seuls l’app et son développeur voient metadata et external_id, et seule l’app peut les modifier.

Endpoints

Attributs

string
requis
ID de l’installation de l’app, préfixé par aag_.
object
requis
Compte sur lequel l’app est installée.

Propriétés

string
requis
ID du compte, préfixé par biz_.
string
requis
Nom d’affichage du compte.
object
requis
App installée.

Propriétés

string
requis
ID de l’app, préfixé par app_.
object
requis
Compte qui développe l’app.

Propriétés

string
requis
ID du compte, préfixé par biz_.
string
requis
Nom d’affichage du compte.
object
requis
Icône de l’app. Utilise l’icône d’app par défaut lorsqu’aucune n’est téléversée.

Propriétés

string
requis
URL de l’image de l’icône. Toujours présente : l’icône d’app par défaut lorsqu’aucune n’est téléversée.
string
requis
Nom d’affichage de l’app.
string
requis
Date de la première installation de l’app sur le compte, sous forme d’horodatage ISO 8601. Une réinstallation ultérieure de l’app conserve la date d’origine.
string | null
requis
L’identifiant propre à votre app pour cette installation, comme l’ID du compte lié dans un autre système, ou null lorsqu’aucun n’est défini. 255 caractères au maximum et unique parmi les installations de votre app, afin que vous puissiez retrouver une installation avec GET /app_installations?external_id= ; définir un identifiant déjà utilisé par une autre installation renvoie une erreur 409. Seuls l’app et son développeur le voient ; pour le compte sur lequel l’app est installée, il vaut toujours null.
object | null
requis
Clés et valeurs de type chaîne que votre app stocke à propos de cette installation, comme un curseur de synchronisation ou l’ID du compte lié dans un autre système. Vide jusqu’à ce que votre app définisse une clé, et conservé si le compte supprime puis réinstalle l’app. 50 clés au maximum ; les clés font au plus 100 caractères et les valeurs au plus 500. Seule l’app peut le modifier. Seuls l’app et son développeur le voient ; pour le compte sur lequel l’app est installée, il vaut toujours null.
boolean
requis
Indique si l’app demande désormais des autorisations que le compte n’a pas encore approuvées.
string
requis
Date de dernière modification de l’installation, par exemple une mise à jour de metadata ou une modification des autorisations de l’app par le compte, sous forme d’horodatage ISO 8601.
AppInstallation