Ejemplos de operaciones de API de generación de perfiles

IMPORTANTE

Punto de conexión de API: https://platform.adobe.io/data/core/activation/authoring/sample-profiles

En esta página se enumeran y describen todas las operaciones de API que puede realizar mediante la /authoring/sample-profiles extremo de API.

Generar diferentes tipos de perfiles para diferentes API

IMPORTANTE

Utilice este extremo de API para generar perfiles de muestra para dos casos de uso independientes. Puede:

Puede generar perfiles de muestra basados en el esquema de origen XDM de Adobe (para utilizarlo al probar el destino) o en el esquema de destino admitido por el destino (para utilizarlo al crear la plantilla). Para comprender la diferencia entre el esquema de origen XDM de Adobe y el esquema de destino, lea la sección de información general de la sección Formato del mensaje artículo.

Tenga en cuenta que los fines para los que se pueden utilizar los perfiles de muestra no son intercambiables. Los perfiles generados en función de la variable ID de destino solo se puede usar para crear plantillas de transformación de mensajes y perfiles generados en función de la variable ID de instancia de destino solo se puede usar para probar el punto final de destino.

Introducción a las operaciones de API de generación de perfiles de ejemplo

Antes de continuar, revise la guía de introducción para obtener información importante que debe conocer para realizar llamadas correctamente a la API de , incluido cómo obtener el permiso de creación de destino requerido y los encabezados necesarios.

Genere perfiles de muestra basados en el esquema de origen para utilizarlos al probar el destino

IMPORTANTE

Añadir los perfiles de muestra generados aquí a las llamadas HTTP cuando prueba del destino.

Puede generar perfiles de muestra basados en el esquema de origen realizando una solicitud de GET al authoring/sample-profiles/ y proporcionando el ID de una instancia de destino que ha creado en función de la configuración de destino que desea probar.

Para obtener el ID de una instancia de destino, primero debe crear una conexión en la interfaz de usuario del Experience Platform con el destino antes de intentar probar el destino. Lea el activar tutorial de destino y consulte la siguiente sugerencia para obtener el ID de instancia de destinos que se utiliza para esta API.

SUGERENCIA
  • Obtenga el ID de instancia de destino que debe usar aquí desde la dirección URL al examinar una conexión con su destino.
    Imagen de la interfaz de usuario de cómo obtener el ID de instancia de destino

Formato de API

GET authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={COUNT}
Parámetro de consulta Descripción
{DESTINATION_INSTANCE_ID} El ID de la instancia de destino en función de la cual está generando perfiles de muestra.
{COUNT} Opcional. Número de perfiles de muestra que está generando. El parámetro puede tomar valores entre 1 - 1000.
Si no se especifica el parámetro de recuento, el número predeterminado de perfiles generados se determina mediante la variable maxUsersPerRequest en la variable configuración del servidor de destino. Si no se define esta propiedad, el Adobe generará un perfil de muestra.

Solicitud

La siguiente solicitud genera perfiles de muestra, configurados por el {DESTINATION_INSTANCE_ID} y {COUNT} parámetros de consulta.

curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Respuesta

Una respuesta correcta devuelve el estado HTTP 200 con el número especificado de perfiles de muestra, con pertenencia a segmentos, identidades y atributos de perfil que corresponden al esquema XDM de origen.

SUGERENCIA

La respuesta solo devuelve la pertenencia a segmentos, las identidades y los atributos de perfil que se utilizan en la instancia de destino. Incluso si el esquema de origen tiene otros campos, estos se ignoran.

[
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-7VEsJ"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-Y55JJ"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-Nd9GK"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    }
]
Propiedad Descripción
segmentMembership Un objeto map que describe las suscripciones a segmentos del individuo. Para obtener más información, consulte segmentMembership, leer Detalles de pertenencia a segmentos.
lastQualificationTime Marca de fecha y hora de la última vez que este perfil cumplía los requisitos para el segmento.
xdm:status Indica si la pertenencia al segmento se ha realizado como parte de la solicitud actual. Se aceptan los siguientes valores:
  • existing: El perfil ya formaba parte del segmento antes de la solicitud y continúa manteniendo su pertenencia.
  • realized: El perfil está introduciendo el segmento como parte de la solicitud actual.
  • exited: El perfil sale del segmento como parte de la solicitud actual.
identityMap Campo de tipo asignación que describe los distintos valores de identidad de un individuo, junto con sus áreas de nombres asociadas. Para obtener más información, consulte identityMap, leer Base de la composición del esquema.

Generar perfiles de muestra basados en el esquema de destino que se utilizarán al crear una plantilla de transformación de mensaje

IMPORTANTE

Utilice los perfiles de ejemplo generados aquí al crear la plantilla, en la variable paso de plantilla de renderizado.

Puede generar perfiles de ejemplo basados en el esquema de destino que realiza una solicitud de GET al authoring/sample-profiles/ y proporcionando el ID de destino de la configuración de destino en función de la cual esté creando la plantilla.

SUGERENCIA

Formato de API

GET authoring/sample-profiles?destinationId={DESTINATION_ID}&count={COUNT}
Parámetro de consulta Descripción
{DESTINATION_ID} El ID de la configuración de destino en función del cual está generando perfiles de muestra.
{COUNT} Opcional. Número de perfiles de muestra que está generando. El parámetro puede tomar valores entre 1 - 1000.
Si no se especifica el parámetro de recuento, el número predeterminado de perfiles generados se determina mediante la variable maxUsersPerRequest en la variable configuración del servidor de destino. Si no se define esta propiedad, el Adobe generará un perfil de muestra.

Solicitud

La siguiente solicitud genera perfiles de muestra, configurados por el {DESTINATION_ID} y {COUNT} parámetros de consulta.

curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Respuesta

Una respuesta correcta devuelve el estado HTTP 200 con el número especificado de perfiles de muestra, con pertenencia a segmentos, identidades y atributos de perfil que corresponden al esquema XDM de destino.

[
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609326Z",
                    "status": "existing"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609328Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609328Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-vizii"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-adKYs"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-t4sKv"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-C3enB"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-bfnbs"
                }
            ]
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609626Z",
                    "status": "existing"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609627Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609627Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-6YjGc"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-SfJ21"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-eQMWS"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-d3WzP"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-eWfFn"
                }
            ]
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609823Z",
                    "status": "existing"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609824Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609824Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-2PMjZ"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-3aLez"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-D2H1J"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-i6PsF"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-VPUtZ"
                }
            ]
        }
    }
]

Gestión de errores de API

Los extremos de la API del Destination SDK siguen los principios generales del mensaje de error de la API del Experience Platform. Consulte Códigos de estado de API y errores en el encabezado de la solicitud en la guía de solución de problemas de Platform.

Pasos siguientes

Después de leer este documento, ahora sabe cómo generar perfiles de muestra para utilizarlos al prueba de una plantilla de transformación de mensaje o cuando prueba si el destino está configurado correctamente.

En esta página