Extremo de entidades (acceso a Perfil)

Adobe Experience Platform le permite acceder a Real-time Customer Profile los datos mediante las API de RESTful o la interfaz de usuario. Esta guía describe cómo acceder a las entidades, más comúnmente conocidas como "perfiles", mediante la API. Para obtener más información sobre el acceso a perfiles mediante la Platform interfaz de usuario, consulte la guía del usuario dePerfil.

Primeros pasos

El punto final 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 ver los vínculos a la documentación relacionada, una guía para leer las llamadas de la API de muestra en este documento e información importante sobre los encabezados necesarios para realizar llamadas con éxito a cualquier Experience Platform API.

Acceso a datos de perfil por identidad

Para acceder a una Profile entidad, realice una solicitud de GET al /access/entities extremo y proporcione la identidad de la entidad como una serie de parámetros de consulta. Esta identidad consiste en un valor de ID (entityId) y la Área de nombres de identidad (entityIdNS).

Los parámetros de consulta proporcionados en la ruta de la solicitud especifican a qué datos acceder. Puede incluir varios parámetros, separados por signos ampersands (&). En la sección de parámetros de consulta del apéndice se proporciona una lista completa de los parámetros válidos.

Formato API

GET /access/entities?{QUERY_PARAMETERS}

Solicitud

La siguiente solicitud recupera el correo electrónico y el nombre de un cliente mediante una identidad:

curl -X GET \
  'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.profile&entityId=janedoe@example.com&entityIdNS=email&fields=identities,person.name,workEmail' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

{
    "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA": {
        "entityId": "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA",
        "sources": [
            "1000000000"
        ],
        "entity": {
            "identities": [
                {
                    "id": "89149270342662559642753730269986316601",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "janedoe@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "janesmith@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316604",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "58832431024964181144308914570411162539",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316602",
                    "namespace": {
                        "code": "ecid"
                    },
                    "primary": true
                }
            ],
            "person": {
                "name": {
                    "firstName": "Jane",
                    "middleName": "F",
                    "lastName": "Doe"
                }
            },
            "workEmail": {
                "primary": true,
                "address": "janedoe@example.com",
                "label": "Jane Doe",
                "type": "work",
                "status": "active"
            }
        },
        "lastModifiedAt": "2018-08-28T20:57:24Z"
    }
}
Nota

Si un gráfico relacionado vincula más de 50 identidades, este servicio devolverá el estado HTTP 422 y el mensaje "Demasiadas identidades relacionadas". Si recibe este error, considere la posibilidad de agregar más parámetros de consulta para limitar la búsqueda.

Acceso a los datos de perfil por lista de identidades

Puede acceder a varias entidades de perfil mediante sus identidades, realizando una solicitud de POST al extremo y proporcionando las identidades en la carga útil. /access/entities Estas identidades consisten en un valor de ID (entityId) y una Área de nombres de identidad (entityIdNS).

Formato API

POST /access/entities

Solicitud

La siguiente solicitud recupera los nombres y las direcciones de correo electrónico de varios clientes mediante una lista de identidades:

curl -X POST \
  https://platform.adobe.io/data/core/ups/access/entities \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "schema":{
            "name":"_xdm.context.profile"
        },
        "fields":[
            "identities",
            "person.name",
            "workEmail"
        ],
        "identities":[
            {
                "entityId":"89149270342662559642753730269986316601",
                "entityIdNS":{
                    "code":"ECID"
                }
            },
            {
                "entityId":"89149270342662559642753730269986316900",
                "entityIdNS":{
                    "code":"ECID"
                }
            },
            {
                "entityId":"89149270342662559642753730269986316602",
                "entityIdNS":{
                    "code":"ECID"
                }
            }
        ],
        "timeFilter": {
            "startTime": 1539838505,
            "endTime": 1539838510
        },
        "limit": 10,
        "orderby": "-timestamp",
        "withCA": true
      }'
Propiedad Descripción
schema.name (Requerido) El nombre del esquema XDM al que pertenece la entidad.
fields Los campos XDM que se van a devolver, como una matriz de cadenas. De forma predeterminada, se devolverán todos los campos.
identities (Requerido) Matriz que contiene una lista de identidades para las entidades a las que desea acceder.
identities.entityId ID de una entidad a la que desee acceder.
identities.entityIdNS.code Área de nombres de un identificador de entidad a la que desea acceder.
timeFilter.startTime Tiempo de inicio del filtro de intervalo de tiempo, incluido. Debe tener una granularidad de milisegundos. Si no se especifica, el valor predeterminado es el comienzo del tiempo disponible.
timeFilter.endTime Filtro de intervalo de tiempo de finalización, excluido. Debe tener una granularidad de milisegundos. Si no se especifica, el valor predeterminado es el final del tiempo disponible.
limit Número de registros que devolver. Solo se aplica al número de eventos de experiencia devueltos. Predeterminado: 1000.
orderby Orden de los eventos de experiencia recuperados por marca de tiempo, escrito (+/-)timestamp con el valor predeterminado +timestamp.
withCA Indicador de característica para activar atributos calculados para la búsqueda. Predeterminado: false.

Respuesta Una respuesta correcta devuelve los campos solicitados de las entidades especificadas en el cuerpo de la solicitud.

{
    "A29cgveD5y64ezlhxjUXNzcm": {
        "entityId": "A29cgveD5y64ezlhxjUXNzcm",
        "sources": [
            "1000000000"
        ],
        "entity": {
            "identities": [
                {
                    "id": "89149270342662559642753730269986316601",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "janedoe@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "05DD23564EC4607F0A490D44",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316603",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "janesmith@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316604",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316700",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316701",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "58832431024964181144308914570411162539",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316602",
                    "namespace": {
                        "code": "ecid"
                    },
                    "primary": true
                }
            ],
            "person": {
                "name": {
                    "firstName": "Jane",
                    "middleName": "F",
                    "lastName": "Doe"
                }
            },
            "workEmail": {
                "primary": true,
                "address": "janedoe@example.com",
                "label": "Jane Doe",
                "type": "work",
                "status": "active"
            }
        },
        "lastModifiedAt": "2018-08-28T20:57:24Z"
    },
    "A29cgveD5y64e2RixjUXNzcm": {
        "entityId": "A29cgveD5y64e2RixjUXNzcm",
        "sources": [
            ""
        ],
        "entity": {},
        "lastModifiedAt": "1970-01-01T00:00:00Z"
    },
    "A29cgveD5y64ezphxjUXNzcm": {
        "entityId": "A29cgveD5y64ezphxjUXNzcm",
        "sources": [
            "1000000000"
        ],
        "entity": {
            "identities": [
                {
                    "id": "89149270342662559642753730269986316602",
                    "namespace": {
                        "code": "ecid"
                    },
                    "primary": true
                },
                {
                    "id": "janedoe@example.com",
                    "namespace": {
                        "code": "email"
                    }
                }
            ],
            "person": {
                "name": {
                    "firstName": "Jane",
                    "middleName": "F",
                    "lastName": "Doe"
                }
            },
            "workEmail": {
                "primary": true,
                "address": "janedoe@example.com",
                "label": "Jane Doe",
                "type": "work",
                "status": "active"
            }
        },
        "lastModifiedAt": "2018-08-27T23:25:52Z"
    }
}

Acceso a eventos de series temporales para un perfil por identidad

Puede acceder a los eventos de series temporales según la identidad de la entidad de perfil asociada realizando una solicitud de GET al /access/entities extremo. Esta identidad consiste en un valor de ID (entityId) y una Área de nombres de identidad (entityIdNS).

Los parámetros de consulta proporcionados en la ruta de la solicitud especifican a qué datos acceder. Puede incluir varios parámetros, separados por signos ampersands (&). En la sección de parámetros de consulta del apéndice se proporciona una lista completa de los parámetros válidos.

Formato API

GET /access/entities?{QUERY_PARAMETERS}

Solicitud

La siguiente solicitud busca una entidad perfil por ID y recupera los valores de las propiedades endUserIDs, weby channel para todos los eventos de serie temporal asociados a la entidad.

curl -X GET \
  'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.experienceevent&relatedSchema.name=_xdm.context.profile&relatedEntityId=89149270342662559642753730269986316900&relatedEntityIdNS=ECID&fields=endUserIDs,web,channel&startTime=1531260476000&endTime=1531260480000&limit=1' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

Una respuesta correcta devuelve una lista paginada de eventos de series temporales y campos asociados especificados en los parámetros de consulta de la solicitud.

Nota

En la solicitud se especificó un límite de uno (limit=1), por lo que count en la respuesta siguiente se indica 1 y sólo se devuelve una entidad.

{
    "_page": {
        "orderby": "timestamp",
        "start": "c8d11988-6b56-4571-a123-b6ce74236036",
        "count": 1,
        "next": "c8d11988-6b56-4571-a123-b6ce74236037"
    },
    "children": [
        {
            "relatedEntityId": "A29cgveD5y64e2RixjUXNzcm",
            "entityId": "c8d11988-6b56-4571-a123-b6ce74236036",
            "timestamp": 1531260476000,
            "entity": {
                "endUserIDs": {
                    "_experience": {
                        "ecid": {
                            "id": "89149270342662559642753730269986316900",
                            "namespace": {
                                "code": "ecid"
                            }
                        }
                    }
                },
                "channel": {
                    "_type": "web"
                },
                "web": {
                    "webPageDetails": {
                        "name": "Fernie Snow",
                        "pageViews": {
                            "value": 1
                        }
                    }
                }
            },
            "lastModifiedAt": "2018-08-21T06:49:02Z"
        }
    ],
    "_links": {
        "next": {
            "href": "/entities?start=c8d11988-6b56-4571-a123-b6ce74236037&orderby=timestamp&schema.name=_xdm.context.experienceevent&relatedSchema.name=_xdm.context.profile&relatedEntityId=89149270342662559642753730269986316900&relatedEntityIdNS=ECID&fields=endUserIDs,web,channel&startTime=1531260476000&endTime=1531260480000&limit=1"
        }
    }
}

Acceder a una página de resultados subsiguiente

Los resultados se paginan al recuperar eventos de series temporales. Si hay páginas de resultados posteriores, la _page.next propiedad contendrá un ID. Además, la propiedad _links.next.href proporciona un URI de solicitud para recuperar la página siguiente. Para recuperar los resultados, realice otra solicitud de GET al /access/entities extremo; sin embargo, debe asegurarse de reemplazar /entities por el valor del URI proporcionado.

Nota

Asegúrese de que no se repita accidentalmente /entities/ en la ruta de solicitud. Sólo debería aparecer una vez como, /access/entities?start=...

Formato API

GET /access/{NEXT_URI}
Parámetro Descripción
{NEXT_URI} El valor URI tomado de _links.next.href.

Solicitud

La siguiente solicitud recupera la siguiente página de resultados utilizando el _links.next.href URI como ruta de solicitud.

curl -X GET \
  'https://platform.adobe.io/data/core/ups/access/entities?start=c8d11988-6b56-4571-a123-b6ce74236037&orderby=timestamp&schema.name=_xdm.context.experienceevent&relatedSchema.name=_xdm.context.profile&relatedEntityId=89149270342662559642753730269986316900&relatedEntityIdNS=ECID&fields=endUserIDs,web,channel&startTime=1531260476000&endTime=1531260480000&limit=1' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

Una respuesta correcta devuelve la siguiente página de resultados. Esta respuesta no tiene páginas de resultados posteriores, como indican los valores de cadena vacíos de _page.next y _links.next.href.

{
    "_page": {
        "orderby": "timestamp",
        "start": "c8d11988-6b56-4571-a123-b6ce74236037",
        "count": 1,
        "next": ""
    },
    "children": [
        {
            "relatedEntityId": "A29cgveD5y64e2RixjUXNzcm",
            "entityId": "c8d11988-6b56-4571-a123-b6ce74236037",
            "timestamp": 1531260477000,
            "entity": {
                "endUserIDs": {
                    "_experience": {
                        "ecid": {
                            "id": "89149270342662559642753730269986316900",
                            "namespace": {
                                "code": "ecid"
                            }
                        }
                    }
                },
                "channel": {
                    "_type": "web"
                },
                "web": {
                    "webPageDetails": {
                        "name": "Fernie Snow",
                        "pageViews": {
                            "value": 1
                        }
                    }
                }
            },
            "lastModifiedAt": "2018-08-21T06:50:01Z"
        }
    ],
    "_links": {
        "next": {
            "href": ""
        }
    }
}

Acceso a eventos de series temporales para varios perfiles por identidades

Puede acceder a eventos de series temporales de varios perfiles asociados realizando una solicitud de POST al extremo y proporcionando las identidades de perfil en la carga útil. /access/entities Cada una de estas identidades consta de un valor de ID (entityId) y una Área de nombres de identidad (entityIdNS).

Formato API

POST /access/entities

Solicitud

La siguiente solicitud recupera los ID de usuario, las horas locales y los códigos de país para los eventos de serie temporal asociados con una lista de identidades de perfil:

curl -X POST \
  https://platform.adobe.io/data/core/ups/access/entities \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "schema": {
        "name": "_xdm.context.experienceevent"
    },
    "relatedSchema": {
        "name": "_xdm.context.profile"
    },
    "identities": [
        {
            "relatedEntityId": "GkouAW-yD9aoRCPhRYROJ-TetAFW"
        }
        {
            "relatedEntityId": "GkouAW-2u-7iWt5vQ9u2wm40JOZY"
        }
    ],
    "fields": [
        "endUserIDs",
        "placeContext.localTime",
        "placeContext.geo.countryCode"
    ],
    
    "timeFilter": {
        "startTime": 11539838505
        "endTime": 1539838510
    },
    "limit": 10
}'
Propiedad Descripción
schema.name (OBLIGATORIO) El esquema XDM de la entidad que se va a recuperar
relatedSchema.name Si schema.name es _xdm.context.experienceevent este valor, debe especificar el esquema de la entidad perfil a la que están relacionados los eventos de series temporales.
identities (OBLIGATORIO) Una lista de matriz de perfiles desde los que recuperar eventos de series temporales asociadas. Cada entrada de la matriz se establece de una de las dos maneras siguientes: 1) utilizando una identidad completa consistente en un valor de ID y una Área de nombres o 2) proporcionando un XID.
fields Aísla los datos devueltos a un conjunto especificado de campos. Utilícelo para filtrar qué campos de esquema se incluyen en los datos recuperados. Ejemplo: personalEmail,persona.nombre,persona.género
mergePolicyId Identifica la directiva de combinación por la que se rigen los datos devueltos. Si no se especifica ninguno en la llamada de servicio, se utilizará el valor predeterminado de su organización para ese esquema. Si no se ha configurado ninguna directiva de combinación predeterminada, la opción predeterminada es no combinar perfiles ni establecer vínculos de identidad.
orderby Orden de los eventos de experiencia recuperados por marca de tiempo, escrito (+/-)timestamp con el valor predeterminado +timestamp.
timeFilter.startTime Especifique el tiempo de inicio para filtrar objetos de serie temporal (en milisegundos).
timeFilter.endTime Especifique la hora de finalización para filtrar objetos de serie temporal (en milisegundos).
limit Valor numérico que especifica el número máximo de objetos que se van a devolver. Predeterminado: 1000
withCA Indicador de característica para activar atributos calculados para la búsqueda. Predeterminado: false

Respuesta

Una respuesta correcta devuelve una lista paginada de eventos de serie temporal asociados con los múltiples perfiles especificados en la solicitud.

{
    "GkouAW-yD9aoRCPhRYROJ-TetAFW": {
        "_page": {
            "orderby": "timestamp",
            "start": "ee0fa8eb-f09c-4d72-a432-fea7f189cfcd",
            "count": 10,
            "next": "40cb2fb3-78cd-49d3-806f-9bdb22748226"
        },
        "children": [
            {
                "relatedEntityId": "GkouAW-yD9aoRCPhRYROJ-TetAFW",
                "entityId": "ee0fa8eb-f09c-4d72-a432-fea7f189cfcd",
                "timestamp": 1537275882000,
                "entity": {
                    "endUserIDs": {
                        "_experience": {
                            "mcid": {
                                "id": "67971860962043911970658021809222795905",
                                "namespace": {
                                    "code": "ECID"
                                }
                            },
                            "aacustomid": {
                                "id": "50353446361742744826197433431642033796",
                                "namespace": {
                                    "code": "CRMID"
                                },
                                "primary": true
                            },
                            "acid": {
                                "id": "2de32e9a00003314-2fd9c00000000026",
                                "namespace": {
                                    "code": "AVID"
                                }
                            }
                        }
                    },
                    "placeContext": {
                        "localTime": "2018-09-18T13:04:42Z",
                        "geo": {
                            "countryCode": "MX"
                        }
                    }
                },
                "lastModifiedAt": "2018-10-24T17:35:01Z"
            },
            {
                "relatedEntityId": "GkouAW-yD9aoRCPhRYROJ-TetAFW",
                "entityId": "a9e137b4-1348-4878-8167-e308af523d8b",
                "timestamp": 1537275889000,
                "entity": {
                    "endUserIDs": {
                        "_experience": {
                            "mcid": {
                                "id": "67971860962043911970658021809222795905",
                                "namespace": {
                                    "code": "ECID"
                                }
                            },
                            "aacustomid": {
                                "id": "50353446361742744826197433431642033796",
                                "namespace": {
                                    "code": "CRMID"
                                },
                                "primary": true
                            },
                            "acid": {
                                "id": "2de32e9a00003314-2fd9c00000000026",
                                "namespace": {
                                    "code": "AVID"
                                }
                            }
                        }
                    },
                    "placeContext": {
                        "localTime": "2018-09-18T13:04:49Z",
                        "geo": {
                            "countryCode": "MX"
                        }
                    }
                },
                "lastModifiedAt": "2018-10-24T17:35:01Z"
            }
        ],
        "_links": {
            "next": {
                "href": "/entities",
                "payload": {
                    "schema": {
                        "name": "_xdm.context.experienceevent"
                    },
                    "relatedSchema": {
                        "name": "_xdm.context.profile"
                    },
                    "timeFilter": {
                        "startTime": 1537275882000
                    },
                    "fields": [
                        "endUserIDs",
                        "placeContext.localTime",
                        "placeContext.geo.countryCode"
                    ],
                    "identities": [
                        {
                            "relatedEntityId": "GkouAW-yD9aoRCPhRYROJ-TetAFW",
                            "start": "40cb2fb3-78cd-49d3-806f-9bdb22748226"
                        }
                    ],
                    "limit": 10
                }
            }
        }
    },
    "GkouAW-2u-7iWt5vQ9u2wm40JOZY": {
        "_page": {
            "orderby": "timestamp",
            "start": "2746d0db-fa64-4e29-b67e-324bec638816",
            "count": 9,
            "next": ""
        },
        "children": [
            {
                "relatedEntityId": "GkouAW-2u-7iWt5vQ9u2wm40JOZY",
                "entityId": "2746d0db-fa64-4e29-b67e-324bec638816",
                "timestamp": 1537559483000,
                "entity": {
                    "endUserIDs": {
                        "_experience": {
                            "mcid": {
                                "id": "76436745599328540420034822220063618863",
                                "namespace": {
                                    "code": "ECID"
                                }
                            },
                            "aacustomid": {
                                "id": "48593470048917738786405847327596263131",
                                "namespace": {
                                    "code": "CRMID"
                                },
                                "primary": true
                            },
                            "acid": {
                                "id": "2de32e9a80007451-03da600000000028",
                                "namespace": {
                                    "code": "AVID"
                                }
                            }
                        }
                    },
                    "placeContext": {
                        "localTime": "2018-09-21T19:51:23Z",
                        "geo": {
                            "countryCode": "US"
                        }
                    }
                },
                "lastModifiedAt": "2018-10-24T17:34:58Z"
            },
            {
                "relatedEntityId": "GkouAW-2u-7iWt5vQ9u2wm40JOZY",
                "entityId": "9bf337a1-3256-431e-a38c-5c0d42d121d1",
                "timestamp": 1537559486000,
                "entity": {
                    "endUserIDs": {
                        "_experience": {
                            "mcid": {
                                "id": "76436745599328540420034822220063618863",
                                "namespace": {
                                    "code": "ECID"
                                }
                            },
                            "aacustomid": {
                                "id": "48593470048917738786405847327596263131",
                                "namespace": {
                                    "code": "CRMID"
                                },
                                "primary": true
                            },
                            "acid": {
                                "id": "2de32e9a80007451-03da600000000028",
                                "namespace": {
                                    "code": "AVID"
                                }
                            }
                        }
                    },
                    "placeContext": {
                        "localTime": "2018-09-21T19:51:26Z",
                        "geo": {
                            "countryCode": "US"
                        }
                    }
                },
                "lastModifiedAt": "2018-10-24T17:34:58Z"
            }
        ],
        "_links": {
            "next": {
                "href": ""
            }
        }
    }
}`

En esta respuesta de ejemplo, el primer perfil de la lista ("GkouAW-yD9aoRCPhRYROJ-TetAFW") proporciona un valor para _links.next.payload, lo que significa que hay páginas adicionales de resultados para este perfil. Consulte la siguiente sección sobre el acceso a resultados adicionales para obtener más información sobre cómo acceder a esos resultados adicionales.

Acceso a resultados adicionales

Al recuperar eventos de series temporales, es posible que se devuelvan muchos resultados, por lo que los resultados se paginan con frecuencia. Si hay páginas de resultados subsiguientes para un perfil en particular, el _links.next.payload valor de ese perfil contendrá un objeto de carga útil.

Con esta carga útil en el cuerpo de la solicitud, puede realizar una solicitud de POST adicional al extremo para recuperar la página siguiente de los datos de la serie temporal para ese perfil. access/entities

Acceso a eventos de series temporales en varias entidades de esquema

Puede acceder a varias entidades conectadas mediante un descriptor de relación. La siguiente llamada de API de ejemplo supone que ya se ha definido una relación entre dos esquemas. Para obtener más información sobre los descriptores de relación, lea la guía de extremo de Schema Registry la guía de descriptores de programadores de API.

Puede incluir parámetros de consulta en la ruta de la solicitud para especificar a qué datos acceder. Puede incluir varios parámetros, separados por signos ampersands (&). En la sección de parámetros de consulta del apéndice se proporciona una lista completa de los parámetros válidos.

Formato API

GET /access/entities?{QUERY_PARAMETERS}

Solicitud

La siguiente solicitud recupera una entidad que contiene un descriptor de relación previamente establecido para acceder a la información en diferentes esquemas.

curl -X GET \
  https://platform.adobe.io/data/core/ups/access/entities?relatedSchema.name=_xdm.context.profile&schema.name=_xdm.context.experienceevent&relatedEntityId=GkouAW-2Xkftzer3bBtHiW8GkaFL \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \

Respuesta

Una respuesta correcta devuelve una lista paginada de eventos de series temporales asociados a las múltiples entidades.

{
    "_page": {
        "orderby": "timestamp",
        "start": "cb10369f-a47b-4e65-afb4-06e1ad78a648",
        "count": 1,
        "next": ""
    },
    "children": [
        {
            "relatedEntityId": "GkouAW-2Xkftzer3bBtHiW8GkaFL",
            "entityId": "cb10369f-a47b-4e65-afb4-06e1ad78a648",
            "timestamp": 1564614939000,
            "entity": {
                "environment": {
                    "browserDetails": {}
                },
                "identityMap": {
                    "CRMId": [
                        {
                            "id": "78520026455138218785449796480922109723",
                            "primary": true
                        }
                    ]
                },

                "commerce": {
                    "productViews": {
                        "value": 1
                    }
                },
                "productListItems": [
                    {
                        "name": "Red shoe",
                        "quantity": 85,
                        "storesAvailableIn": [
                            "da6dced5-9574-4dda-89b5-9dc106903f80",
                            "981bb433-2ee5-4db0-a19a-449ec9dbf39f"
                        ],
                        "SKU": "8f998279-797b-4da2-9e60-88bf73a9f15a",
                        "priceTotal": 934.8
                    }
                ],
                "_id": "cb10369f-a47b-4e65-afb4-06e1ad78a648",
                "commerce": {
                    "order": {}
                },
                "placeContext": {
                    "geo": {
                        "_schema": {}
                    }
                },
                "device": {},
                "timestamp": "2019-07-31T23:15:39Z",
                "_experience": {
                    "profile": {
                        "identityNamespaces": {
                            "/productListItems[*]/SKU": {
                                "namespace": {
                                    "code": "ECID"
                                }
                            }
                        }
                    }
                }
            },
            "lastModifiedAt": "2019-10-10T00:14:19Z"
        }
    ],
    "_links": {
        "next": {
            "href": ""
        }
    }
}

Acceder a una página de resultados subsiguiente

Los resultados se paginan al recuperar eventos de series temporales. Si hay páginas de resultados posteriores, la _page.next propiedad contendrá un ID. Además, la propiedad _links.next.href proporciona un URI de solicitud para recuperar la página siguiente realizando solicitudes de GET adicionales al access/entities punto final.

Pasos siguientes

Al seguir esta guía, se ha accedido correctamente a los campos Real-time Customer Profile de datos, perfiles y datos de series temporales. Para obtener más información sobre cómo acceder a otros recursos de datos almacenados en Platform, consulte la información general sobre el acceso adatos.

Apéndice

La siguiente sección proporciona información adicional sobre el acceso a Profile los datos mediante la API.

Parámetros de consulta

Los siguientes parámetros se utilizan en la ruta de las solicitudes de GET al /access/entities extremo. Sirven para identificar la entidad de perfil a la que desea acceder y filtrar los datos devueltos en la respuesta. Los parámetros requeridos están etiquetados, mientras que el resto son opcionales.

Parámetro Descripción Ejemplo
schema.name (OBLIGATORIO) El esquema XDM de la entidad que se va a recuperar schema.name=_xdm.context.experienceevent
relatedSchema.name Si schema.name es "_xdm.context.experience", este valor debe especificar el esquema de la entidad de perfil a la que están relacionados los eventos de series temporales. relatedSchema.name=_xdm.context.profile
entityId (OBLIGATORIO) El ID de la entidad. Si el valor de este parámetro no es un XID, también se debe proporcionar un parámetro de Área de nombres de identidad (véase entityIdNS a continuación). entityId=janedoe@example.com
entityIdNS Si no entityId se proporciona como XID, este campo debe especificar la Área de nombres de identidad. entityIdNE=email
relatedEntityId Si schema.name es "_xdm.context.experience", este valor debe especificar la Área de nombres de identidad de la entidad de perfil relacionada. Este valor sigue las mismas reglas que entityId. relatedEntityId=69935279872410346619186588147492736556
relatedEntityIdNS Si schema.name es "_xdm.context.experience", este valor debe especificar la Área de nombres de identidad de la entidad especificada en relatedEntityId. relatedEntityIdNS=CRMID
fields Filtros los datos devueltos en la respuesta. Utilice esto para especificar qué valores de campo de esquema incluir en los datos recuperados. Para varios campos, separe los valores por una coma sin espacios entre fields=personalEmail,person.name,person.gender
mergePolicyId Identifica la directiva de combinación por la que se rigen los datos devueltos. Si no se especifica ninguno en la llamada, se utilizará el valor predeterminado de su organización para ese esquema. Si no se ha configurado ninguna directiva de combinación predeterminada, la opción predeterminada es no combinar perfiles ni establecer vínculos de identidad. mergePoilcyId=5aa6885fcf70a301dabdfa4a
orderBy Orden de los eventos de experiencia recuperados por marca de tiempo, escrito (+/-)timestamp con el valor predeterminado +timestamp. orderby=-timestamp
startTime Especifique el tiempo de inicio para filtrar objetos de serie temporal (en milisegundos). startTime=1539838505
endTime Especifique la hora de finalización para filtrar objetos de serie temporal (en milisegundos). endTime=1539838510
limit Valor numérico que especifica el número máximo de objetos que se van a devolver. Predeterminado: 1000 limit=100
property Filtros por el valor de propiedad. Admite los siguientes evaluadores: =, !=, <, <=, >, >=. Solo se puede usar con eventos de experiencia, con un máximo de tres propiedades admitidas. property=webPageDetails.isHomepage=true&property=localTime<="2020-07-20"
withCA Indicador de característica para activar atributos calculados para la búsqueda. Predeterminado: false withCA=true

En esta página