Generar perfiles de muestra basados en un esquema de origen sample-profile-api-operations

IMPORTANT
extremo de API: https://platform.adobe.io/data/core/activation/authoring/sample-profiles

Esta página enumera y describe todas las operaciones de API que puede realizar mediante el extremo de API /authoring/sample-profiles.

Generar diferentes tipos de perfiles para diferentes API different-profiles-different-apis

IMPORTANT
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 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 del artículo Formato del mensaje.

Tenga en cuenta que los propósitos para los que se pueden utilizar los perfiles de muestra no son intercambiables. Los perfiles generados a partir del ID de destino solo se pueden usar para crear las plantillas de transformación de mensajes y los perfiles generados a partir del ID de instancia de destino solo se pueden usar para probar el extremo de destino.

Introducción a las operaciones de API de generación de perfiles de muestra get-started

Antes de continuar, revisa la guía de introducción para obtener información importante que necesitas conocer para poder realizar llamadas a la API correctamente, incluyendo cómo obtener el permiso de creación de destino requerido y los encabezados requeridos.

Generar perfiles de muestra basados en el esquema de origen para utilizarlos al probar el destino generate-sample-profiles-source-schema

IMPORTANT
Agregue los perfiles de muestra generados aquí a las llamadas HTTP al probar su destino.

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

Para obtener el ID de una instancia de destino, primero debe crear una conexión en la interfaz de usuario de Experience Platform a su destino antes de intentar probar el destino. Lea el tutorial activar destino y vea la sugerencia a continuación sobre cómo obtener el ID de instancia de destinos que se utilizará para esta API.

IMPORTANT

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. El 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 count, el número predeterminado de perfiles generados se determina mediante el valor maxUsersPerRequest en la 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 ejemplo, configurados por los parámetros de consulta {DESTINATION_INSTANCE_ID} y {COUNT}.

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 audiencia, identidades y atributos de perfil que corresponden al esquema XDM de origen.

TIP
La respuesta solo devuelve la pertenencia a audiencias, identidades y atributos de perfil que se utilizan en la instancia de destino. Aunque el esquema de origen tenga 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 pertenencias de audiencia del individuo. Para obtener más información sobre segmentMembership, lea Detalles de pertenencia a audiencias.
lastQualificationTime
Una marca de tiempo de la última vez que este perfil se clasificó para el segmento.
xdm:status

Campo de cadena que indica si el abono a audiencia se ha realizado como parte de la solicitud actual. Se aceptan los siguientes valores:

  • realized: el perfil forma parte del segmento.
  • exited: el perfil está saliendo de la audiencia como parte de la solicitud actual.
identityMap
Campo de tipo mapa que describe los distintos valores de identidad de un individuo, junto con sus áreas de nombres asociadas. Para obtener más información sobre identityMap, lea Base de la composición del esquema.

Generar perfiles de muestra basados en el esquema de destinatario para utilizarlos al crear una plantilla de transformación de mensajes generate-sample-profiles-target-schema

IMPORTANT
Use los perfiles de muestra generados aquí al crear la plantilla, en el paso de plantilla de procesamiento.

Puede generar perfiles de muestra basados en el esquema de destino realizando una solicitud al extremo authoring/sample-profiles/ y proporcionando el ID de destino de la configuración de destino basada en la que está creando la GET.

TIP
  • El id. de destino que debe usar aquí es el instanceId que corresponde a una configuración de destino creada con el extremo /destinations. Consulte recuperar una configuración de destino para obtener más información.

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 de la cual está generando perfiles de muestra.
{COUNT}
Opcional. El 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 count, el número predeterminado de perfiles generados se determina mediante el valor maxUsersPerRequest en la 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 ejemplo, configurados por los parámetros de consulta {DESTINATION_ID} y {COUNT}.

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 audiencia, identidades y atributos de perfil que corresponden al esquema XDM de destino.

[
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609326Z",
                    "status": "realized"
                },
                "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": "realized"
                },
                "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": "realized"
                },
                "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"
                }
            ]
        }
    }
]

Administración de errores de API api-error-handling

Los extremos de la API de Destination SDK siguen los principios generales del mensaje de error de la API de Experience Platform. Consulte Códigos de estado de API y errores de encabezado de 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 usarlos al probar una plantilla de transformación de mensajes o al probar si el destino está configurado correctamente.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6