Associer des utilisateurs à des points de terminaison Amazon Pinpoint - Amazon Pinpoint

Avis de fin de support : le 30 octobre 2026, le support d'Amazon Pinpoint AWS prendra fin. Après le 30 octobre 2026, vous ne pourrez plus accéder à la console Amazon Pinpoint ni aux ressources Amazon Pinpoint (points de terminaison, segments, campagnes, parcours et analyses). Pour plus d'informations, consultez la page de fin de support d'Amazon Pinpoint. Remarque : en ce qui APIs concerne les SMS, la voix, le push mobile, l'OTP et la validation des numéros de téléphone ne sont pas concernés par cette modification et sont pris en charge par AWS la messagerie utilisateur final.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Associer des utilisateurs à des points de terminaison Amazon Pinpoint

Un point de terminaison peut inclure des attributs qui définissent un utilisateur, c'est-à-dire une personne de votre public. Par exemple, un utilisateur peut représenter une personne qui a installé votre application mobile, ou une personne disposant d'un compte sur votre site web.

Vous définissez un utilisateur en spécifiant un ID utilisateur unique et, éventuellement, des attributs d'utilisateur personnalisés. Si une personne utilise votre application sur plusieurs appareils, ou si cette personne peut recevoir un message à plusieurs adresses, vous pouvez attribuer le même ID d'utilisateur à plusieurs points de terminaison. Dans ce cas, Amazon Pinpoint synchronise les attributs utilisateur entre les points de terminaison. Par conséquent, si vous ajoutez un attribut utilisateur à un point de terminaison, Amazon Pinpoint ajoute cet attribut pour chaque point de terminaison qui inclut le même ID d'utilisateur.

Vous pouvez ajouter des attributs utilisateur pour suivre les données qui s'appliquent à une personne et ne varient pas en fonction de l'appareil que celle-ci utilise. Par exemple, vous pouvez ajouter des attributs pour le nom, l'âge ou le statut du compte d'une personne.

Astuce

Si votre application utilise des groupes d'utilisateurs Amazon Cognito pour gérer l'authentification des utilisateurs, Amazon Cognito peut ajouter automatiquement des IDs utilisateurs et des attributs à vos points de terminaison. Pour la valeur d'ID utilisateur du point de terminaison, Amazon Cognito attribue la valeur sub affectée à l'utilisateur dans le groupe d'utilisateurs. Pour en savoir plus sur l'ajout d'utilisateurs avec Amazon Cognito, consultez Utilisation d'Amazon Pinpoint Analytics avec des groupes d'utilisateurs Amazon Cognito dans le Guide du développeur d'Amazon Cognito.

Une fois que vous avez ajouté des définitions utilisateur à vos points de terminaison, vous disposez d'autres options pour segmenter votre public. Vous pouvez définir un segment en fonction des attributs utilisateur ou vous pouvez définir un segment en important une liste d'utilisateurs IDs. Lorsque vous envoyez un message à un segment basé sur des utilisateurs, les destinations potentielles incluent chaque point de terminaison associé à chaque utilisateur du segment.

Vous disposez également d'autres options pour envoyer des messages à votre public. Vous pouvez utiliser une campagne pour envoyer un message à un segment d'utilisateurs, ou vous pouvez envoyer un message directement à une liste d'utilisateurs IDs. Pour personnaliser votre message, vous pouvez inclure des variables de message remplacées par des valeurs d'attributs utilisateur.

Exemples

Les exemples suivants vous indiquent comment ajouter une définition d'utilisateur à un point de terminaison.

AWS CLI

Vous pouvez utiliser Amazon Pinpoint en exécutant des commandes avec l' AWS CLI.

Exemple Commande de mise à jour du point de terminaison

Pour ajouter un utilisateur à un point de terminaison, utilisez la commande update-endpoint. Pour le paramètre --endpoint-request, vous pouvez définir un nouveau point de terminaison, qui peut inclure un utilisateur. Sinon, pour mettre à jour un point de terminaison existant, vous pouvez fournir uniquement les attributs que vous voulez modifier. L'exemple suivant ajoute un utilisateur à un point de terminaison existant en fournissant uniquement les attributs utilisateur :

$ aws pinpoint update-endpoint \ > --application-id application-id \ > --endpoint-id endpoint-id \ > --endpoint-request file://endpoint-request-file.json

Où :

  • application-idest l'ID du projet Amazon Pinpoint dans lequel vous ajoutez ou mettez à jour un point de terminaison.

  • endpoint-idest l'ID que vous attribuez à un nouveau point de terminaison ou l'ID d'un point de terminaison existant que vous mettez à jour.

  • endpoint-request-file.jsonest le chemin d'accès à un fichier JSON local contenant l'entrée du --endpoint-request paramètre.

Exemple Fichier de demande de points de terminaison

L'exemple de commande update-endpoint utilise un fichier JSON comme argument pour le paramètre --endpoint-request. Ce fichier contient une définition d'utilisateur comme suit :

{ "User":{ "UserId":"example_user", "UserAttributes":{ "FirstName":["Wang"], "LastName":["Xiulan"], "Gender":["Female"], "Age":["39"] } } }

Pour connaître les attributs que vous pouvez utiliser pour définir un utilisateur, consultez l'Userobjet dans le EndpointRequestschéma du manuel Amazon Pinpoint API Reference.

AWS SDK pour Java

Vous pouvez utiliser l'API Amazon Pinpoint dans vos applications Java en utilisant le client fourni par AWS SDK pour Java.

Exemple Code

Pour ajouter un utilisateur à un point de terminaison, initialisez un EndpointRequest objet et transmettez-le à la updateEndpoint méthode du AmazonPinpoint client. Vous pouvez utiliser cet objet pour définir un nouveau point de terminaison, qui peut inclure un utilisateur. Sinon, pour mettre à jour un point de terminaison existant, vous pouvez mettre à jour uniquement les propriétés que vous voulez modifier. L'exemple suivant ajoute un utilisateur à un point de terminaison existant en y ajoutant un EndpointUser EndpointRequest objet :

import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.pinpoint.PinpointClient; import software.amazon.awssdk.services.pinpoint.model.EndpointRequest; import software.amazon.awssdk.services.pinpoint.model.EndpointUser; import software.amazon.awssdk.services.pinpoint.model.ChannelType; import software.amazon.awssdk.services.pinpoint.model.UpdateEndpointRequest; import software.amazon.awssdk.services.pinpoint.model.UpdateEndpointResponse; import software.amazon.awssdk.services.pinpoint.model.PinpointException; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map;
public static void updatePinpointEndpoint(PinpointClient pinpoint, String applicationId, String endPointId) { try { List<String> wangXiList = new ArrayList<>(); wangXiList.add("cooking"); wangXiList.add("running"); wangXiList.add("swimming"); Map myMapWang = new HashMap<>(); myMapWang.put("interests", wangXiList); List<String> myNameWang = new ArrayList<>(); myNameWang.add("Wang "); myNameWang.add("Xiulan"); Map wangName = new HashMap<>(); wangName.put("name", myNameWang); EndpointUser wangMajor = EndpointUser.builder() .userId("example_user_10") .userAttributes(wangName) .build(); // Create an EndpointBatchItem object for Mary Major. EndpointRequest wangXiulanEndpoint = EndpointRequest.builder() .channelType(ChannelType.EMAIL) .address("wang_xiulan@example.com") .attributes(myMapWang) .user(wangMajor) .build(); // Adds multiple endpoint definitions to a single request object. UpdateEndpointRequest endpointList = UpdateEndpointRequest.builder() .applicationId(applicationId) .endpointRequest(wangXiulanEndpoint) .endpointId(endPointId) .build(); UpdateEndpointResponse result = pinpoint.updateEndpoint(endpointList); System.out.format("Update endpoint result: %s\n", result.messageBody().message()); } catch (PinpointException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } }

Pour l'exemple complet du SDK, consultez AddExampleUser.java on. GitHub

HTTP

Vous pouvez utiliser Amazon Pinpoint en effectuant des demandes HTTP directement à l'API REST.

Exemple Demande de point de terminaison PUT avec une définition d'utilisateur

Pour ajouter un utilisateur à un point de terminaison, envoyez une demande PUT à la ressource Point de terminaison à l'URI suivante :

/v1/apps/application-id/endpoints/endpoint-id

Où :

  • application-idest l'ID du projet Amazon Pinpoint dans lequel vous ajoutez ou mettez à jour un point de terminaison.

  • endpoint-idest l'ID que vous attribuez à un nouveau point de terminaison ou l'ID d'un point de terminaison existant que vous mettez à jour.

Dans votre demande, incluez les en-têtes requis et fournissez le EndpointRequestJSON comme corps. Le corps de la demande peut définir un nouveau point de terminaison, qui peut inclure un utilisateur. Sinon, pour mettre à jour un point de terminaison existant, vous pouvez fournir uniquement les attributs que vous voulez modifier. L'exemple suivant ajoute un utilisateur à un point de terminaison existant en fournissant uniquement les attributs utilisateur :

PUT /v1/apps/application_id/endpoints/example_endpoint HTTP/1.1 Host: pinpoint.us-east-1.amazonaws.com X-Amz-Date: 20180415T182538Z Content-Type: application/json Accept: application/json Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20180501/us-east-1/mobiletargeting/aws4_request, SignedHeaders=accept;content-length;content-type;host;x-amz-date, Signature=c25cbd6bf61bd3b3667c571ae764b9bf2d8af61b875cacced95d1e68d91b4170 Cache-Control: no-cache { "User":{ "UserId":"example_user", "UserAttributes":{ "FirstName":"Wang", "LastName":"Xiulan", "Gender":"Female", "Age":"39" } } }

Si la demande aboutit, vous recevez une réponse similaire à ce qui suit :

{ "RequestID": "67e572ed-41d5-11e8-9dc5-db288f3cbb72", "Message": "Accepted" }

Pour plus d'informations sur la ressource Point de terminaison dans l'API Amazon Pinpoint, notamment les méthodes HTTP prises en charge et les paramètres de demande, consultez la section Point de terminaison dans la Référence de l'API Amazon Pinpoint.

Pour plus d'informations sur la personnalisation des messages avec des variables, consultez Variables de message dans le Guide de l'utilisateur Amazon Pinpoint.

Pour savoir comment définir un segment en important une liste d'utilisateurs IDs, consultez la section Importation de segments dans le guide de l'utilisateur Amazon Pinpoint.

Pour plus d'informations sur l'envoi d'un message direct à un maximum de 100 utilisateurs IDs, consultez la section Messages des utilisateurs dans le manuel Amazon Pinpoint API Reference.

Pour plus d'informations sur les quotas qui s'appliquent aux points de terminaison, y compris le nombre d'attributs utilisateur que vous pouvez attribuer, consultez Quotas de points de terminaison.