Avant de pouvoir utiliser les rapports portant sur des comptes, vous devrez les instrumenter. Les étapes spécifiques de ce processus dépendent de la manière dont vous envoyez des données à Amplitude.
Une fois que vous aurez instrumenté les groupes, une nouvelle liste déroulante sera visible dans le module de droite du panneau de configuration de certains graphiques. Vous pourrez alors produire des rapports portant sur un compte et indiquer si vous souhaitez voir les événements déclenchés par des utilisateurs ou par des groupes.
REMARQUE : Amplitude a une limite de cinq types de groupes par projet.
SDK
Vous pouvez configurer des rapports portant sur des comptes dans les SDK d’Amplitude en suivant les instructions suivantes, selon le SDK que vous utilisez :
API Identify
Si vous envoyez des données à Amplitude côté serveur, utilisez la clé groups dans votre objet d’identification. Cela associera un utilisateur donné à un certain groupe. Veuillez consulter la documentation relative à l’ API Identify pour en savoir plus sur l’instrumentation des groupes via l’API Identify d’Amplitude.
API HTTP
Si vous envoyez des données à Amplitude côté serveur, utilisez la clé groups dans votre objet d’événement. Cela ajoutera des groupes relatifs à l’événement (des groupes qui ne persistent que sur cet événement spécifique). Veuillez consulter la documentation relative à l’ API HTTP pour en savoir plus sur l’instrumentation des groupes via l’API HTTP d’Amplitude.
Segment
REMARQUE : le Cloud Segment <> Amplitude (n’importe quelle source côté serveur de Segment ou l’intégration côté client dégroupée) et l’intégration du mode appareil (intégration Segment-Amplitude groupée) prennent désormais en charge la définition des types de groupes et des propriétés de groupe via l’appel group de Segment. Reportez-vous à la documentation de Segment accessible via ce lien pour en savoir plus.
Pour définir des types de groupes dans Amplitude par le biais de Segment, vous devez activer les paramètres de destination Amplitude suivants et leur fournir les valeurs adéquates :
- Group Type Trait : ce paramètre spécifie quelle caractéristique de vos appels
groupSegment contiendra le type de groupe souhaité. - Group Value Trait : ce paramètre spécifie quelle caractéristique de vos appels
groupSegment contiendra la valeur de groupe souhaitée.
Par exemple, si vous avez le code suivant :
analytics.group("placeholder", {
groupType: "org name", // Segment trait "groupType" groupValue: "Amplitude", // Segment trait "groupValue" employees: "120" // group property });
Et ce qui suit dans les paramètres de destination Amplitude de Segment :
Alors, l’intégration crée « org name » comme type de groupe dans Amplitude et associe l’utilisateur actuel à « org name » = « Amplitude ».
REMARQUE : ce que vous transmettez comme groupID (dans le code ci-dessus, "placeholder") dans l’appel group n’a pas d’importance, car cette valeur n’est mappée à aucun élément du côté d’Amplitude.
Pour définir les propriétés de groupe via le code d’instrumentation, vous aurez besoin d’au moins une source dans Segment utilisant l’intégration du mode Cloud Segment <> Amplitude (n’importe quelle bibliothèque de serveur ainsi que l’intégration côté client dégroupée). Les données dans Amplitude munies de la propriété d’utilisateur [Amplitude] Library = segment seront envoyées via une intégration du mode Cloud. Vous pouvez utiliser cette propriété d’utilisateur pour vérifier le type d’intégration que vous avez installée dans Amplitude pour chacune de vos sources Segment. Vous pouvez également appeler les fonctions du SDK Amplitude pour définir les propriétés du groupe :
analytics.ready(function() { var groupIdentify = new amplitude.Identify().set('employees', 100); amplitude.getInstance().groupIdentify('orgId', '1234', groupIdentify);
});
Toutes les caractéristiques supplémentaires qui sont transmises dans l’appel group apparaîtront dans Amplitude sous forme de propriétés de groupe. Par exemple, dans le code ci-dessus, employees sera défini comme une propriété de groupe dans Amplitude :
Création de groupes à l’aide de l’API Group Identify
À l’aide de l’API Group Identify, vous pouvez créer un groupe lié avec toutes les propriétés de groupe attendues ou mettre à jour les propriétés de groupe d’un groupe existant. Dans les exemples de requêtes, les paramètres et les clés sont en italique. Les valeurs soulignées représentent ce que vous devez remplacer par les paramètres qui vous intéressent.
Par ailleurs, les opérations de propriété de groupe ($set, $setOnce, $add, $append, $unset) sont prises en charge dans cette API Group Identify.
Format de requête
Envoyez une requête POST ou GET à https://api.amplitude.com/groupidentify avec deux paramètres de requête :
| Paramètre | Description |
|---|---|
| api_key (obligatoire) |
Clé d’API issue de la page Settings de votre projet. « 040062a5d38552315b98302ba4f2f » |
| identification (obligatoire) | Un objet d’identification JSON unique (voir ci-dessous pour les champs). |
Exemple de requête (unique)
curl --data 'api_key=040062a5d38552315b98302ba4f2f' --data 'identification={"group_properties":{"org csm":"Lucas","org plan":"Enterprise","org owner":"Luis"},"group_value":"1234","group_type":"org id"}' https://api.amplitude.com/groupidentify
Exemple de requête (par lot)
curl --data 'api_key=040062a5d38552315b98302ba4f2f' --data 'identification=[{"group_properties":{"org csm":"Lucas","org plan":"Enterprise","org owner":"Luis"},"group_value":"success","group_type":"org id"},{"group_properties":{"org csm":"Sarah","org plan":"Growth","org owner":"Sandy"},"group_value":"1234","group_type":"org id"}]' https://api.amplitude.com/groupidentify
REMARQUE : les limites de chargement répertoriées ici s’appliquent à ces requêtes.
Clés pour le paramètre identification
Les clés suivantes peuvent être envoyées dans l’objet d’identification JSON. Notez que les clés group_type et group_value sont toutes deux obligatoires.
| Clé | Description |
|---|---|
|
group_type (obligatoire) chaîne de caractères |
Un type de groupe individuel (par exemple compte ou société).
|
|
group_value (obligatoire) chaîne de caractères |
Une valeur individuelle spécifique appartenant au type de groupe ci-dessus. « group_type » : « org id », « group_value » : « 12345678 » ou « group_type » : « account name », « group_value » : « Acme Corp » |
|
group_properties (facultatif) dictionnaire |
Un dictionnaire de paires clé-valeur qui représentent des données supplémentaires liées au groupe. Chaque valeur distincte apparaîtra sous la forme d’un segment de groupe sur le tableau de bord Amplitude. Vous pouvez stocker des valeurs de propriété dans un tableau et les valeurs de date seront transformées en valeurs de chaîne. Par ailleurs, les opérations de propriété de groupe ( {"arr" : "10000", "cs": ["Justin", "Ben"], "renewal_date": “01/01/2018" } |