Récupérez les messages intégrés à l'application pour un point de terminaison par programmation à l'aide d'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 analytique). Pour plus d’informations, consultez Fin de la prise en charge 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.

Récupérez les messages intégrés à l'application pour un point de terminaison par programmation à l'aide d'Amazon Pinpoint

Vos applications peuvent appeler l'GetInAppMessagesAPI pour récupérer tous les messages intégrés auxquels un point de terminaison donné a droit. Lorsque vous appelez l'API GetInAppMessages, vous fournissez les paramètres suivants :

  • ApplicationId : ID du projet Amazon Pinpoint unique à laquelle la campagne dans l'application est associée.

  • EndpointId : ID unique du point de terminaison pour lequel vous récupérez des messages.

Lorsque vous appelez l'API avec ces valeurs, elle renvoie une liste de messages. Pour plus d'informations sur la réponse produite par cette opération, consultez GetInAppMessagesExemple JSON de réponse à l'API Amazon Pinpoint.

Vous pouvez utiliser le AWS SDKs pour appeler l'GetInAppMessagesopération. Les exemples de code suivants incluent des fonctions permettant de récupérer des messages intégrés à l'application.

JavaScript

Créez le client dans un module séparé et exportez-le :

import { PinpointClient } from "@aws-sdk/client-pinpoint";
const REGION = "us-east-1";
const pinClient = new PinpointClient({ region: REGION });
export { pinClient };

Récupérez les messages dans l'application pour un point de terminaison :


// Import required AWS SDK clients and commands for Node.js
import { PinpointClient, GetInAppMessagesCommand } from "@aws-sdk/client-pinpoint";
import { pinClient } from "./lib/pinClient.js";

("use strict");

//The Amazon Pinpoint application ID.
const projectId = "4c545b28d21a490cb51b0b364example";

//The ID of the endpoint to retrieve messages for.
const endpointId = "c5ac671ef67ee3ad164cf7706example";

const params = {
  ApplicationId: projectId,
  EndpointId: endpointId
};

const run = async () => {
  try {
    const data = await pinClient.send(new GetInAppMessagesCommand(params));
    console.log(JSON.stringify(data, null, 4));
    return data; 
  } catch (err) {
    console.log("Error", err);
  }
};
run();
Python
import logging
import boto3
from botocore.exceptions import ClientError

logger = logging.getLogger(__name__)

def retrieve_inapp_messages(
            pinpoint_client, project_id, endpoint_id):
    """
    Retrieves the in-app messages that a given endpoint is entitled to.

    :param pinpoint_client: A Boto3 Pinpoint client.
    :param project_id: An Amazon Pinpoint project ID.
    :param endpoint_id: The ID of the endpoint to retrieve messages for.
    :return: A JSON object that contains information about the in-app message.
    """

    try:
        response = pinpoint_client.get_in_app_messages(
            ApplicationId=project_id,
            EndpointId=endpoint_id)
    except ClientError:
        logger.exception("Couldn't retrieve messages.")
        raise
    else:
        return response

def main():
    project_id = "4c545b28d21a490cb51b0b364example"
    endpoint_id = "c5ac671ef67ee3ad164cf7706example"
    inapp_response = retrieve_inapp_messages(
        boto3.client('pinpoint'), project_id, endpoint_id)
    print(inapp_response)

if __name__ == '__main__':
    main()