Configuraciones de proyección de Edge y extremos de destinos

Para impulsar experiencias coordinadas, coherentes y personalizadas para sus clientes en varios canales en tiempo real, los datos adecuados deben estar disponibles y actualizarse continuamente a medida que se produzcan cambios. Adobe Experience Platform permite este acceso en tiempo real a los datos mediante el uso de lo que se conoce como perímetros. Un perímetro es un servidor ubicado geográficamente que almacena datos y hace que sea fácilmente accesible para las aplicaciones. Por ejemplo, las aplicaciones de Adobe como Adobe Target y Adobe Campaign utilizan Edge de para ofrecer experiencias del cliente personalizadas en tiempo real. Los datos se enrutan a un borde mediante una proyección, con un destino de proyección que define el borde al que se enviarán los datos y una configuración de proyección que define la información específica que estará disponible en el borde. Esta guía proporciona instrucciones detalladas para utilizar el Real-Time Customer Profile API para trabajar con proyecciones de Edge, incluidos destinos y configuraciones.

Primeros pasos

El extremo de API utilizado en esta guía forma parte del Real-Time Customer Profile API. Antes de continuar, consulte la guía de introducción para obtener vínculos a documentación relacionada, una guía para leer las llamadas de API de ejemplo en este documento e información importante sobre los encabezados necesarios para realizar correctamente llamadas a cualquier Experience Platform API.

Destinos de proyección

Una proyección se puede enrutar a uno o más bordes especificando las ubicaciones a las que se enviarán los datos. Cada destino de proyección que se crea tiene un ID único que se utiliza para crear la configuración de proyección.

Enumerar todos los destinos

Puede enumerar los destinos de Edge que ya se han creado para su organización realizando una solicitud de GET a /config/destinations punto final.

Formato de API

GET /config/destinations

Solicitud

curl -X GET \
  https://platform.adobe.io/data/core/ups/config/destinations \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

La respuesta incluye una projectionDestinations matriz con los detalles de cada destino mostrado como un objeto individual dentro de la matriz. Si no se han configurado proyecciones, la variable projectionDestinations la matriz devuelve empty.

{
    "_links": {
        "self": {
            "href": "/data/core/ups/config/destinations",
            "templated": false
        }
    },
    "_embedded": {
        "projectionDestinations": [
            {
                "_links": {
                    "self": {
                        "href": "/data/core/ups/config/destinations/cef0e2ef-5249-4e25-be90-94f5797a2841",
                        "templated": false
                    }
                },
                "id": "cef0e2ef-5249-4e25-be90-94f5797a2841",
                "type": "EDGE",
                "ttl": 3600,
                "dataCenters": [
                    "VA5"
                ],
                "version": 1
            },
            {
                "_links": {
                    "self": {
                        "href": "/data/core/ups/config/destinations/7d26263f-a5df-43ce-b088-7f70e187f549",
                        "templated": false
                    }
                },
                "id": "7d26263f-a5df-43ce-b088-7f70e187f549",
                "type": "EDGE",
                "ttl": 3600,
                "dataCenters": [
                    "OR1"
                ],
                "version": 1
            }
        ]
    }
}

Para obtener más información sobre los atributos de un destino individual, consulte la sección sobre creación de un destino que sigue.

Crear un destino

Si el destino que necesita no existe todavía, puede crear un nuevo destino de proyección realizando una solicitud de POST al /config/destinations punto final.

Formato de API

POST /config/destinations

Solicitud

La siguiente solicitud crea un nuevo destino de Edge.

curl -X POST \
  https://platform.adobe.io/data/core/ups/config/destinations \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/vnd.adobe.platform.projectionDestination+json; version=1' \
  -d '{
        "type": "EDGE",
        "dataCenters": [
          "OR1"
        ],
        "ttl": 3600,
        "replicationPolicy": REACTIVE
      }'

Respuesta

Una respuesta correcta devuelve los detalles del destino perimetral recién creado, incluido el ID único de solo lectura generado por el sistema (id).

{
    "self": {
        "href": "/data/core/ups/config/destinations/cc5a3bd1-f2b9-4965-b9bd-4e7416a02cd4",
        "templated": false
    },
    "id": "cc5a3bd1-f2b9-4965-b9bd-4e7416a02cd4",
    "type": "EDGE",
    "dataCenters": [
       "OR1"
    ],
    "ttl": 3600,
    "version": 1
}

Ver un destino

Si conoce el ID único de un destino de proyección, puede realizar una solicitud de consulta para ver sus detalles. Esto se hace realizando una solicitud de GET a la /config/destinations e incluir el ID del destino en la ruta de solicitud.

Formato de API

GET /config/destinations/{DESTINATION_ID}

Solicitud

La siguiente solicitud realiza una búsqueda (GET) para ver el destino del ID proporcionado en la ruta de solicitud.

curl -X GET \
  https://platform.adobe.io/data/core/ups/config/destinations/9d66c06e-c745-480c-b64c-1d5234d25f4b \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

El objeto response muestra los detalles del destino de la proyección. El id debe coincidir con el ID del destino de proyección proporcionado en la solicitud.

{
    "self": {
        "href": "/data/core/ups/config/destinations/cef0e2ef-5249-4e25-be90-94f5797a2841",
        "templated": false
    },
    "id": "cef0e2ef-5249-4e25-be90-94f5797a2841",
    "type": "EDGE",
    "ttl": 3600,
    "dataCenters": [
        "OR1"
    ],
    "version": 1
}

Actualización de un destino

Se puede actualizar un destino existente realizando una solicitud de PUT a /config/destinations punto final e incluye el ID del destino que se va a actualizar en la ruta de solicitud. Esta operación esencialmente reescribe el destino, por lo tanto, se deben proporcionar los mismos atributos en el cuerpo de la solicitud que se proporcionan al crear un nuevo destino.

Formato de API

PUT /config/destinations/{DESTINATION_ID}

Solicitud

La siguiente solicitud actualiza el destino existente para incluir una segunda ubicación (dataCenters).

curl -X PUT \
  https://platform.adobe.io/data/core/ups/config/destinations/8b90ce19-e7dd-403a-ae24-69683a6674e7 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/vnd.adobe.platform.projectionDestination+json' \
  -d '{
        "type": "EDGE",
        "dataCenters": [
          "OR1",
          "VA5"
        ],
        "replicationPolicy": REACTIVE,
        "currentVersion": 1
      }'

Respuesta

La respuesta incluye los detalles actualizados del destino, incluido su ID y el nuevo version del destino.

{
    "self": {
        "href": "/data/core/ups/config/destinations/8b90ce19-e7dd-403a-ae24-69683a6674e7",
        "templated": false
    },
    "id": "8b90ce19-e7dd-403a-ae24-69683a6674e7",
    "type": "EDGE",
    "ttl": 8000,
    "dataCenters": [
        "OR1",
        "VA5"
    ],
    "version": 2
}

Eliminar un destino

Si su organización ya no requiere un destino de proyección, se puede eliminar realizando una solicitud de DELETE a /config/destinations e incluir el ID del destino que desea eliminar en la ruta de solicitud.

Formato de API

DELETE /config/destinations/{DESTINATION_ID}

Solicitud

curl -X DELETE \
  https://platform.adobe.io/data/core/ups/config/destinations/8b90ce19-e7dd-403a-ae24-69683a6674e7 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

La solicitud de eliminación devuelve el estado HTTP 204 (sin contenido) y un cuerpo de respuesta vacío. Puede confirmar que la eliminación se ha realizado correctamente realizando una solicitud de búsqueda para el destino por su ID. La búsqueda debe devolver el estado HTTP 404 (no encontrado).

Configuraciones de proyección

Las configuraciones de proyección proporcionan información sobre qué datos deben estar disponibles en cada perímetro. En lugar de proyectar una Experience Data Model (XDM) al perímetro, una proyección solo proporciona datos específicos, o campos, del esquema. Su organización puede definir varias configuraciones de proyección para cada esquema XDM.

Enumerar todas las configuraciones de proyección

Puede enumerar todas las configuraciones de proyección que se han creado para su organización realizando una solicitud de GET a /config/projections punto final. También se pueden añadir parámetros opcionales a la ruta de solicitud para acceder a las configuraciones de proyección de un esquema determinado o buscar una proyección individual por su nombre.

Formato de API

GET /config/projections
GET /config/projections?schemaName={SCHEMA_NAME}
GET /config/projections?schemaName={SCHEMA_NAME}&name={PROJECTION_NAME}

Solicitud

La siguiente solicitud enumera todas las configuraciones de proyección asociadas con la variable Experience Data Model clase de esquema, XDM Individual Profile. Para obtener más información sobre XDM y su función dentro de Platform, empiece por leer el Información general del sistema XDM.

curl -X GET \
  https://platform.adobe.io/data/core/ups/config/projections?schemaName=_xdm.context.profile \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

Una respuesta correcta devuelve una lista de configuraciones de proyección dentro de la raíz _embedded atributo, contenido en projectionConfigs matriz. Si no se han realizado configuraciones de proyección para su organización, la variable projectionConfigs la matriz estará vacía.

{
    "_links": {
        "self": {
            "href": "/data/core/ups/config/projections",
            "templated": false
        }
    },
    "_embedded": {
        "projectionConfigs": [
            {
                "_links": {
                    "destination": {
                        "href": "/data/core/ups/config/destinations/a689248a-5d2b-44af-bb70-c8f17f97011b",
                        "templated": false
                    },
                    "self": {
                        "href": "/data/core/ups/config/projections/99aed0bc-c183-4997-ada7-7843642e08f6",
                        "templated": false
                    }
                },
                "_embedded": {
                    "destination": {
                        "self": {
                            "href": "/data/core/ups/config/destinations/a689248a-5d2b-44af-bb70-c8f17f97011b",
                            "templated": false
                        },
                        "id": "a689248a-5d2b-44af-bb70-c8f17f97011b",
                        "type": "EDGE",
                        "ttl": 1000,
                        "dataCenters": [
                            "OR1"
                        ],
                        "version": 1
                    }
                },
                "selector": "strategy",
                "version": 2,
                "id": "99aed0bc-c183-4997-ada7-7843642e08f6",
                "schemaName": "_xdm.context.profile",
                "name": "adcloud_rlsa",
                "destinationId": "a689248a-5d2b-44af-bb70-c8f17f97011b"
            },
        ]
    }
}

Creación de una configuración de proyección

Puede crear (POST) una nueva configuración de proyección que dictará qué campos XDM están disponibles en los bordes.

Formato de API

POST /config/projections?schemaName={SCHEMA_NAME}

Solicitud

curl -X POST \
  https://platform.adobe.io/data/core/ups/config/projections?schemaName=_xdm.context.profile \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/vnd.adobe.platform.projectionConfig+json; version=1' \
  -d '{
        "selector": "emails,person(firstName)",
        "name": "my_test_projection",
        "destinationId": "cc5a3bd1-f2b9-4965-b9bd-4e7416a02cd4"
      }'

Respuesta

Una respuesta correcta devuelve los detalles de la configuración de proyección recién creada.

{
    "_links": {
        "destination": {
            "href": "/data/core/ups/config/destinations/cc5a3bd1-f2b9-4965-b9bd-4e7416a02cd4",
            "templated": false
        },
        "self": {
            "href": "/data/core/ups/config/projections/87fcd0bc-c183-4997-daf9-7843642g95a1",
            "templated": false
        }
    },
    "_embedded": {
        "destination": {
            "self": {
                "href": "/data/core/ups/config/destinations/cc5a3bd1-f2b9-4965-b9bd-4e7416a02cd4",
                "templated": false
            },
            "id": "cc5a3bd1-f2b9-4965-b9bd-4e7416a02cd4",
            "type": "EDGE",
            "ttl": 1000,
            "dataCenters": [
                "OR1"
            ],
            "version": 1
        }
    },
    "selector": "emails,person(firstName)",
    "version": 2,
    "id": "87fcd0bc-c183-4997-daf9-7843642g95a1",
    "schemaName": "_xdm.context.profile",
    "name": "my_test_projection",
    "destinationId": "cc5a3bd1-f2b9-4965-b9bd-4e7416a02cd4"
}

Selectores

Un selector es una lista de nombres de campo XDM separados por comas. En una configuración de proyección, el selector designa las propiedades que se deben incluir en las proyecciones. El formato del selector El valor del parámetro se basa de forma flexible en la sintaxis XPath. A continuación se resume la sintaxis admitida, con ejemplos adicionales que se proporcionan como referencia.

Sintaxis admitida

• Utilice comas para seleccionar varios campos. No utilice espacios.
• Utilice la notación de puntos para seleccionar campos anidados.
  • Por ejemplo, para seleccionar un campo denominado field que se anida dentro de un campo denominado foo, utilice el selector foo.field.
• Al incluir un campo que contiene subcampos, todos los subcampos también se proyectan de forma predeterminada. Sin embargo, puede filtrar los subcampos devueltos mediante paréntesis "( )".
  • Por ejemplo, addresses(type,city.country) devuelve únicamente el tipo de dirección y el país en el que se encuentra la ciudad de la dirección para cada uno addresses elemento de matriz.
  • El ejemplo anterior es equivalente a addresses.type,addresses.city.country.

• Cada campo del selector se especifica en relación con la raíz de la respuesta.
  • Si los datos son una colección de recursos, la proyección incluirá una matriz de recursos.
  • Si los datos son un solo recurso, la proyección incluirá campos relativos a ese recurso.
  • Si el campo seleccionado es (o forma parte) de una matriz, la proyección incluirá la parte seleccionada de todos los elementos de la matriz.

Ejemplos del parámetro selector

Los siguientes ejemplos muestran un ejemplo selector parámetros, seguidos de los valores estructurados que representan.

person.lastName

Devuelve el lastName subcampo de la variable person en el recurso solicitado.

{
  "person": {
    "lastName": "Smith"
  }
}

direcciones

Devuelve todos los elementos del addresses matriz, incluidos todos los campos de cada elemento, pero ningún otro campo.

{
  "addresses": [
    {
      "type": "home",
      "street1": "100 Great Mall Parkway",
      "city": {
        "name": "San Jose",
        "country": "United States"
      }
    },
    {
      "type": "work",
      "street1": "1 Main Street",
      "city": {
        "name": "San Jose",
        "country": "United States"
      }
    }
  ]
}

person.lastName,addresses

Devuelve el person.lastName y todos los elementos del campo addresses matriz.

{
  "person": {
    "lastName": "Smith"
  },
  "addresses": [
    {
      "type": "home",
      "street1": "100 Great Mall Parkway",
      "city": {
        "name": "San Jose",
        "country": "United States"
      }
    },
    {
      "type": "work",
      "street1": "1 Main Street",
      "city": {
        "name": "San Jose",
        "country": "United States"
      }
    }
  ]
}

addresses.city

Devuelve únicamente el campo de ciudad de todos los elementos de la matriz de direcciones.

{
  "addresses": [
    {
      "city": {
        "name": "San Jose",
        "country": "United States"
      }
    },
    {
      "city": {
        "name": "San Jose",
        "country": "United States"
      }
    }
  ]
}

direcciones(tipo,ciudad)

Devuelve solo los valores de type y city campos para cada elemento de la addresses matriz. Todos los demás subcampos incluidos en cada addresses Los elementos de se filtran.

{
  "addresses": [
    {
      "type": "home",
      "city": {
        "name": "San Jose",
        "country": "United States"
      }
    },
    {
      "type": "work",
      "city": {
        "name": "San Jose",
        "country": "United States"
      }
    }
  ]
}

Pasos siguientes

Esta guía muestra los pasos necesarios para configurar las proyecciones y los destinos, incluido cómo dar formato correctamente a la variable selector parámetro. Ahora puede crear nuevos destinos de proyección y configuraciones específicas para las necesidades de su organización.

Recursos de Business.Adobe.com

Omnichannel Personalization Subscription Revenue Customer Communications Ad Hoc Analysis Attribution Efficiency Tools