Versión 3.1.0 15 de enero de 2013 IBM Digital Analytics Digital Data Exchange Guía de API
Nota Antes de utilizar esta información y el producto al que hace referencia, lea la información en Avisos en la página 25. IBM Digital Marketing y Analytics es una nueva generación de productos de IBM Coremetrics. C onsulte esta tabla para obtener más detalles sobre la nueva denominación de productos. Nombre anterior del producto IBM Coremetrics AdTarget IBM Coremetrics Benchmark IBM Coremetrics Enterprise Analytics IBM Coremetrics Explore IBM Coremetrics Import IBM Coremetrics Export IBM Coremetrics Intelligent Offer IBM Coremetrics Lifecycle IBM Coremetrics LIVEmail IBM Coremetrics Monitor IBM Coremetrics Search Marketing IBM Coremetrics Social Analytics IBM Coremetrics Tag Manager IBM Coremetrics Web Analytics Nombre nuevo del producto IBM AdTarget IBM Digital Analytics Benchmark IBM Digital Analytics Multisite IBM Digital Analytics Explore IBM Digital Analytics Import IBM Digital Analytics Export IBM Digital Recommendations IBM Digital Analytics Lifecycle IBM LIVEmail IBM Digital Analytics Monitor IBM Search Marketing IBM Digital Analytics for Social Media IBM Digital Data Exchange IBM Digital Analytics La documentación distribuida con los productos de IBM Digital Analytics es confidencial y propiedad de IBM y, como tal, está sujeta a las disposiciones de todos los acuerdos comerciales entre las partes. Independientemente de las disposiciones específicas de dichos acuerdos comerciales, las partes indican su disposición a tratar la documentación a la que se hace referencia como información confidencial de IBM yanodistribuir dicha documentación a ninguna otra parte ni copiar dicha documentación excepto a lo expresamente permitido en los acuerdos de licencia entre las partes relacionadas con dichos productos. Materiales bajo licencia - Propiedad de IBM Copyright IBM Corporation 2013.
Contenido Capítulo 1. Acerca de Digital Data Exchange.............. 1 Requisitos del sistema........... 1 Acceso a Digital Data Exchange........ 1 Acerca de la administración de usuarios en Digital Data Exchange.............. 2 Roles y permisos en Digital Data Exchange.... 2 Navegación en Digital Data Exchange...... 4 Capítulo 2. La API de Digital Data Exchange.............. 7 Recopilación de datos e ID de carga...... 7 Configuración una solicitud de API....... 8 Filtrado de salida de API.......... 8 Filtrado con los ID de carga......... 9 Obtención del ID de carga más reciente..... 10 Obtención de ID de carga que siguen a un ID de carga dado.............. 10 Formatos de los informes de la API...... 11 Formato de URLs generados......... 11 Visualización de uso de la API........ 11 Resolución de problemas con solicitudes de API.. 12 Capítulo 3. Referencia de campos de datos de la API de Digital Data Exchange............. 13 Apéndice A. Información adicional de contacto.............. 21 Apéndice B. Soporte......... 23 Avisos............... 25 Marcas comerciales............ 27 Consideraciones de la política de privacidad... 27 Copyright IBM Corp. 2013 iii
iv IBM Digital AnalyticsDigital Data Exchange Guía de API
Capítulo 1. Acerca de Digital Data Exchange Requisitos del sistema La aplicación Digital Data Exchange forma parte del paquete IBM Digital Analytics. Proporciona una interfaz única que perfecciona la configuración y el despliegue de etiquetas de página, que le ayudará a reducir la carga de gestión de etiquetas en equipos de desarrollo web o TI y habilitar grupos de marketing y de empresa generales. En Digital Data Exchange, dependiendo de sus permisos, estas son algunas de las tareas que se pueden realizar: v v v v v v v v v v Gestionar IBM Digital Analytics y etiquetas de colaborador certificado, así como crear versiones de etiquetas estándar que funcionan con sus páginas actuales de los sitios web; Opcionalmente, configure las reglas de grupo de páginas para desencadenar JavaScript de terceros y fragmentos de código; Agrupe páginas similares de los sitios web en grupos de páginas y especifique qué etiquetas se ejecutan para cada grupo de páginas; Configure las reglas para determinar cuándo se ejecutan las etiquetas en grupos de páginas; Despliegue los grupos de páginas para entornos de pruebas o de producción; Realice despliegues de prueba de grupos de páginas y opcionalmente, envíe datos de etiqueta a IBM Digital Analytics con fines de prueba; Utilice los resultados de las pruebas para solucionar problemas o adaptar de forma adecuada el comportamiento de etiquetas en las páginas antes de desplegarlos en producción; Inhabilite o vuelva a habilitar etiquetas para un determinado colaborador; Utilice el historial de versiones para comparar versiones o retrotraer a una versión desplegada con anterioridad de su código de grupo de páginas; Extraiga los datos seleccionados en la API de Digital Data Exchange. Los requisitos del sistema para todos los usuarios IBM Digital Data Exchange son los siguientes: v RAM: 1G+ v Flash v10 -- http://get.adobe.com/flashplayer/ v Navegador: Internet Explorer de v7 a v9, Firefox de v6 a v7 o Chrome v14. Acceso a Digital Data Exchange Nota: El navegador debe estar configurado conforme a HTML5 para que pueda utilizar la característica de prueba de página en Digital Data Exchange. Las versiones de navegador enumeradas tienen soporte, pero no todas las versiones cumplen con el requisito HTML5. Si su cuenta está habilitada para IBM Digital Data Exchange, es posible acceder a dicho informe de dos formas: Copyright IBM Corp. 2013 1
v v Si ya ha iniciado la sesión en una aplicación IBM Digital Analytics, pulse Digital Data Exchange en el menú de navegación de la cabecera. La aplicación se inicia y usted queda autenticado de forma automática. Navegue directamente a: http://tagmanager.coremetrics.com. En la página Iniciar sesión, escriba su ID de cliente, nombre de usuario y contraseña y, a continuación, pulse Iniciar sesión. Acerca de la administración de usuarios en Digital Data Exchange Los usuarios con privilegios de administración pueden gestionar usuarios y grupos de usuarios del menú Admin en IBM Digital Analytics. Para procedimientos básicos sobre cómo añadir nuevos usuarios, crear grupos y añadir usuarios a grupos, consulte la IBM Digital Analytics Guía del usuario. Para configurar a los usuarios con distintos conjuntos de permisos en Digital Data Exchange, cree un grupo de usuarios con cada tipo de permiso, a continuación, añada los usuarios al grupo apropiado. Siga estos pasos: 1. En IBM Digital Analytics, pulse Admin en el encabezado de la aplicación. 2. Pulse Gestionar grupos en el panel de navegación lateral. 3. Cree nuevos grupos de usuarios según sea necesario, especificando el nombre de grupo, ID de clientes aplicable y el nivel de Digital Data Exchange permisos que desea otorgar a este grupo. 4. Guarde los nuevos grupos. 5. Pulse Gestionar usuarios. 6. Cree nuevos usuarios o edite los usuarios existentes, añada los grupos de usuarios con los permisos apropiados para cada usuario. 7. Guarde los perfiles de usuario. Roles y permisos en Digital Data Exchange Las tareas que puede realizar en Digital Data Exchange dependen de su rol de usuario y los permisos que se han otorgado a dicho rol. La tabla siguiente muestra los grupos de permisos disponibles en Digital Data Exchange. En general, si no tiene de forma explícita permisos de un área, sólo podrá ver los artículos; no se pueden realizar cambios en los artículos. Tabla 1. Roles y permisos en Digital Data Exchange Digital Data Exchange Opciones de permiso Etiquetas Descripción de los permisos Los usuarios con permisos de "Etiquetas" pueden ver todos los detalles de las etiquetas y realizar todas las acciones disponibles en la sección Etiquetas de la aplicación, incluida la creación de substituciones. 2 IBM Digital AnalyticsDigital Data Exchange Guía de API
Tabla 1. Roles y permisos en Digital Data Exchange (continuación) Digital Data Exchange Opciones de permiso Descripción de los permisos Grupos de páginas Los usuarios con permiso de "Página anuncios" pueden ver todos los detalles del grupo de páginas y realizar todas las acciones de la sección Grupos de páginas de la aplicación EXCEPTUANDO: Desplegar Gestionar Características avanzadas Funcionalidad asociada al permiso de "Características avanzadas". Los usuarios con permiso "Grupos de páginas" pero sin permiso "Características avanzadas" pueden ver expresiones regulares y las características de JavaScript de colaborador, pero no pueden editarlas, guardarlas ni modificarlas. Estos usuarios no pueden editar ni suprimir configuraciones de Características avanzadas que otros usuarios hayan guardado para otro grupo de páginas, ni tampoco pueden añadir fragmentos de código a un grupo de páginas ni cambiarlos. Los usuarios con permiso "Desplegar" pueden desplegar grupos de páginas a entornos tanto de prueba como de producción. El permiso "Desplegar" también lo necesitan los usuarios que deseen habilitar o inhabilitar las etiquetas de colaborador en producción o que deseen revertir versiones de producción. Los usuarios con permiso "Gestionar" pueden realizar todas las acciones disponibles en la sección Gestionar de la aplicación, con la excepción de las funciones de la API. Las funciones de la API precisan de un permiso explícito de "API de Digital Data Exchange". Los usuarios con el permiso "Características avanzadas" tienen funciones completas de edición, guardado y supresión para expresiones regulares, fragmentos de códigos y características de JavaScript de colaborador. El permiso de "Características avanzadas" funciona junto con el permiso básico para cada área de aplicación. Por ejemplo, para tener permiso de Característica avanzada para las etiquetas, también debe tener permiso básico para las etiquetas. Capítulo 1. Acerca de Digital Data Exchange 3
Tabla 1. Roles y permisos en Digital Data Exchange (continuación) Digital Data Exchange Opciones de permiso Descripción de los permisos API de Digital Data Exchange Los usuarios con permiso "API de Digital Data Exchange" tiene permisos para la configuración de páginas de la API en la sección Gestionar > API de la aplicación. En algunos casos, es posible que los usuarios tengan permisos únicamente para las páginas de configuración de API, pero no para ninguna otra área en Digital Data Exchange. Los subgrupos en el permiso de "API Digital Data Exchange" pueden seleccionarse o deseleccionarse para definir permisos más granulares. Por ejemplo, algunos usuarios pueden tener permisos para todos los datos de la API, mientras que otros tienen permisos para sólo los tipos específicos de datos de la API, como "Eventos de cesta" o "Eventos de conversión". Navegación en Digital Data Exchange En esta sección se describen las principales áreas de la interfaz de usuario de Digital Data Exchange. Panel de navegación lateral En Digital Data Exchange, utilice el panel de navegación lateral para acceder al área donde desee trabajar. Pulse cualquier cabecera de sección para expandir su contenido y pulse un elemento bajo la cabecera para abrirlo en el espacio de trabajo principal. Etiquetas La sección Etiquetas proporciona acceso a las etiquetas disponibles, agrupadas según el colaborador. Pulse en una sección de colaborador para acceder a la página de configuración de etiqueta del colaborador. Seleccione un tipo de etiqueta para editarlo y guarda las etiquetas de dicho tipo. Activos La sección Activos proporciona acceso a los distintos objetos que dan soporte al etiquetado de páginas del sitio web como, por ejemplo, los grupos de páginas y los fragmentos de código. Despliegue La sección Despliegue proporciona acceso a las funciones relacionadas con el despliegue como, por ejemplo, las de historial de despliegue, las de retroacción y comparación de versiones de despliegue y las de pruebas de páginas. Gestionar La sección Gestionar proporciona acceso a las funciones administrativas como, por ejemplo, las de correlaciones de proveedor, las de configuración de colaborador y globales y las de configuración de API y de informes de utilización. 4 IBM Digital AnalyticsDigital Data Exchange Guía de API
Encabezado de la aplicación El menú situado en la parte superior de la interfaz de la aplicación proporciona enlaces a opciones estándar en aplicaciones IBM Digital Analytics. Conmutador de la aplicación Este menú desplegable proporciona acceso a otras aplicaciones de IBM Digital Analytics y de marketing. Pulse el nombre de la aplicación para cambiar a esa aplicación en la ventana actual, o bien pulse en Abrir para iniciar la aplicación en un nuevo separador de ventana o navegador. Algunas opciones sólo son visibles si tiene acceso a las aplicaciones de IBM Digital Analytics. Admin Este enlace sólo es visible para usuarios con permisos administrativos. Pulse este enlace para iniciar la consola de administración y gestionar usuarios y grupos de usuarios, y sus permisos. Para obtener información, consulte la sección "Administración" en la "Guía del Usuario de IBM Digital Analytics." Ayuda Pulse Ayuda para esta página para abrir el tema de la Ayuda para la página actual. Desde cualquier tema de la ayuda puede abrir el índice del sistema de ayuda y realizar búsquedas e ir a todos los temas. Pulse Documentación del producto para abrir una página desde la que puede acceder a toda la documentación para esta aplicación. Es posible que esta opción no esté disponible para todos los usuarios, en función de sus roles. Comentarios Utilice este enlace para enviar comentarios por correo electrónico a Soporte técnico oagestión de productos. Soporte Pulse en este enlace para acceder al centro de soporte. Si no tiene una cuenta de Centro de soporte técnico, se le guiará por los pasos para crear un perfil. Cerrar sesión Pulse Cerrar sesión para cerrar sesión en la aplicación. Capítulo 1. Acerca de Digital Data Exchange 5
6 IBM Digital AnalyticsDigital Data Exchange Guía de API
Capítulo 2. La API de Digital Data Exchange La API de Digital Data Exchange es una aplicación de IBM Digital Data Exchange con la que puede solicitar una llamada de API mediante un URL generado para los datos solicitados. Las solicitudes de API se configuran en base a un conjunto de tipos de eventos de datos estándar (por ejemplo, eventos de conversión, eventos de página vista, eventos de cesta de compra o eventos de compra). De forma opcional existe la posibilidad de filtrar sus solicitudes para que la API solo devuelva los datos que desea. Nota: Puede acceder a la API solo si pertenece a un rol de usuario al que se le ha otorgado permisos la API de Digital Data Exchange. Además, su acceso puede verse limitado a tipos de evento específicos. Si necesita obtener ayuda relacionada con los permisos de usuario, póngase en contacto con el administrador del sistema. Recopilación de datos e ID de carga Recopilación de datos Algunos tipos de eventos de datos no devolverán datos completos hasta que se haya completado la sesión asociada. Por ejemplo, es posible recopilar los datos de un evento de página vista tan pronto como ocurre el evento y, por lo tanto, antes que finalice la sesión actual del visitante. Sin embargo, es necesario calcular los datos de los eventos de compra o de los eventos de abandono de la cesta a partir de los datos de una sesión completada y, por lo tanto, no se envían hasta haber completado la sesión. Cuando realice una solicitud a la API, sólo los eventos completados se incluyen en los datos devueltos. Existe la posibilidad de configurar las solicitudes de API para que devuelvan los datos asociados con los ID de carga de un rango de los 8 días anteriores al ID de carga actual. No se da soporte a la obtención de ID de carga que se hubiesen generados con anterioridad al ID de carga actual. Sin embargo, si ha obtenido con anterioridad los ID de carga que se generaron dentro de los 8 días, podrá utilizarlos para obtener los datos asociados. ID de carga Los datos recopilados se cargan en la base de datos cada 5 minutos. Cada nuevo lote de datos se identifica con un ID de carga exclusivo, un número que asigna el sistema que procesa el lote de datos y que se incrementa una cantidad establecida en cada nuevo lote. Cuando realiza solicitudes de API, se necesita el ID de carga como un parámetro en el URL de solicitud de API. Si desea obtener información más detallada sobre el Id de carga más reciente, consulte Obtención del ID de carga más reciente en la página 10. Para obtener detalles sobre la obtención de la lista de ID de carga que han pasado a estar disponibles después de un ID de carga específico, consulte Obtención de ID de carga que siguen a un ID de carga dado en la página 10. Copyright IBM Corp. 2013 7
El ID de carga también sirve para filtrar procesos al solicitar datos desde la API o para solicitar datos mediante programación en su llamada de API de forma que se obtenga de forma continuada los últimos datos. Consulte Filtrado con los ID de carga en la página 9 para obtener información detallada sobre la utilización del ID de carga. Configuración una solicitud de API Filtrado de salida de API Configura solicitudes de API desde la interfaz de usuario IBM Digital Data Exchange. Nota: Su ID de usuario tendrá acceso a las API Digital Data Exchange sólo si pertenece a un rol de usuario al que se le ha otorgado permisos a la API. Además, su acceso puede verse limitado a informes específicos. Si necesita obtener ayuda relacionada con los permisos de usuario, póngase en contacto con el administrador del sistema. 1. Pulse Gestionar > API. 2. Especifique los detalles de tipos de evento de datos que desea extraer datos. a. Seleccione el tipo de evento de datos para su solicitud de la API. b. Seleccione el idioma en el que desea se devuelvan los datos. c. Seleccione el formato en el que desea que se devuelvan los datos. Para obtener detalles sobre los formatos soportados, consulte Visualización de uso de la API en la página 11. 3. Seleccione los campos de datos que quiere extraer desde la lista de Campos de datos disponibles y muévalos a la lista campos de datos seleccionados. Si no realiza ninguna selección, de forma predeterminada, en la solicitud de datos se incluyen todos los campos de datos asociados con el tipo de evento de datos seleccionado. Seleccione más de un campo cada vez manteniendo la tecla Control o Mayús pulsadas. Mueva campos arrostrándolos y soltándolos, o utilizando los botones de teclas hacia la derecha. El botón de flecha de la derecha sencilla mueve los campos seleccionados; el botón de flecha derecha doble mueve todos los campos, independientemente de si han sido o no seleccionados. 4. Cuando haya seleccionado todos los campos para los que desea extraer los datos, pulse Generar URL de API. El URL se genera y se muestran en la parte inferior de la página. 5. Copie y pegue el URL en una barra de direcciones del navegador para acceder a sus datos extraídos. Cuando crea una solicitud de API, tiene la posibilidad de crear filtros para limitar el contenido que devuelve. Los criterios de filtrado son específicos del tipo de evento que seleccione para su solicitud. Siga los pasos que se indican a continuación para especificar condiciones de filtrado para su solicitud de API. 1. Pulse Gestionar > API. 2. En la página de configuración de la solicitud de API, después de seleccionar los campos de datos que desea que la solicitud de API devuelva, pulse el enlace 8 IBM Digital AnalyticsDigital Data Exchange Guía de API
Añadir una condición de filtro. 3. Añada al menos un criterio para filtrar su solicitud de datos de API. Por ejemplo, para una solicitud de API de Eventos de compra de artículo, tiene la posibilidad de filtrar los datos devueltos en base a Precio base y Cantidad de producto. Filtrado con los ID de carga 4. Después de haber terminado de especificar sus criterios de filtro, pulse Generar URL de API. El URL de API que se obtiene incluye solo los datos que satisfacen sus condiciones de filtro. Las condiciones de filtrado se restablecen cada vez que selecciona un nuevo tipo de evento de datos y cuando al navegar deja la página de la API. El ID de carga identifica el lote de datos que se está solicitando y es necesario como un parámetro en el URL de solicitud de API. 1. Obtenga el ID de carga que representa cada lote de datos que desea solicitar. 2. Modifique el URL de solicitud de API añadiendo la siguiente cadena al final del URL: &filter=load_id+eq+nnnnnnnnnn, donde nnnnnnnnnn es el número del ID de carga. Capítulo 2. La API de Digital Data Exchange 9
Ejemplo: solicitud de datos de únicamente el ID de carga 1335478800 El URL que debería utilizar para solicitar los datos asociados con el ID de carga 1335478800 debería ser: https://welcome.coremetrics.com:8080/analyticswebapp/api/1.0//report-data/ ddx/carts.ftl?clientid=<clientid>&username=<userid>&format=xls &userauthkey=<authkey>&language=en_us&viewid=default.ftl &filter=load_id+eq+1335478800 Obtención del ID de carga más reciente Es posible obtener el ID de carga más reciente desde la interfaz de usuario o realizando una solicitud de API. Desde la interfaz de usuario 1. Pulse Gestionar > API. 2. En la página de configuración de solicitud de API, se visualiza el ID de carga más reciente en la esquina superior derecha. Pulse en el ID de carga en cualquier momento para renovar el campo ID de carga y ver el último ID de carga disponible. Solicitud de API "GetLastLoadID" 1. Pulse Gestionar > API. 2. En la página de configuración de solicitud de API, copie el URL de solicitud de ID de carga, que tiene el siguiente formato: http://welcome.coremetrics.com/analyticswebapp/api/1.0/getlastloadid?userauthkey =<authkey>&clientid=<clientid>&username=<userid> 3. Utilice el URL mediante programación o simplemente péguelo en el campo de dirección de un navegador web. El número del último ID de carga disponible se devuelve con este formato: {"loadid":"nnnnnnnnnn"}, donde nnnnnnnnnn es el número de ID de carga. Obtención de ID de carga que siguen a un ID de carga dado Para obtener todos los ID de carga disponibles que se han generado después de un ID de carga dado, realice una solicitud de API getloadidsafter. 1. Pulse Gestionar > API. 2. En la página de configuración de solicitud de API, copie el URL de solicitud de ID de carga, que tiene el siguiente formato:http://welcome.coremetrics.com/ analyticswebapp/api/1.0/getlastloadid?userauthkey=<authkey> &clientid=<clientid>&username=<userid> 3. Sustituya el parámetro getlastloadid con getloadidsafter. 4. Adjunte el ID de carga: &load_id=nnnnnnnnnn. Consulte el ejemplo que aparece más adelante para ver el formato correcto del URL que se utiliza para realizar una solicitud de API getloadidsafter. 5. Utilice el URL mediante programación o simplemente péguelo en el campo de dirección de un navegador web. Todos los ID de carga disponibles que se han generado después del ID de carga que haya proporcionado se devolverán con este formato: {"loadids":["nnnnnnnnn1","nnnnnnnnn2","nnnnnnnnn3"]}, donde nnnnnnnn1, nnnnnnnnn2 y nnnnnnnnn3 son ID de carga exclusivos. 10 IBM Digital AnalyticsDigital Data Exchange Guía de API
Ejemplo: getloadidsafter Load ID 1333581000 El URL que se utilizará para obtener los ID de carga disponibles después del ID de carga 133358100 debería ser: http://welcome.coremetrics.com/analyticswebapp/api/1.0/getloadidsafter?userauthkey =<authkey>&clientid=<clientid>&username=<userid>&load_id=1333581000 Formatos de los informes de la API La API de Digital Data Exchange devuelve informes en estos formatos: XLS CSV XML JSON El archivo de informe es *.xls y se denomina download.xls. El archivo de informe es *.csv y se denomina download.csv. Se devolverá una página web con datos con formato XML en el navegador. Se devolverá una página web con datos con formato JSON en el navegador. Formato de URLs generados El formato del los URL generados por la interfaz API Digital Data Exchange siga la estructura que se describe en este tema. La interfaz de la API genera un URL para el usuario según datos del informe que ha configurado. Puede modificar el URL para manipular la consulta, de forma que, por ejemplo, puede repetidamente realizar la misma llamada a la API en varios intervalos. La estructura básica del URL es https://welcome.coremetrics.com/ analyticswebapp/api/1.0/report-data/ddx/, seguida de: 1. Tipo de evento de datos 2. ID de cliente 3. Nombre del usuario que solicita el informe 4. Formatos del fichero de informe (xls, csv, xml, ojson) 5. Token de la API (generado automáticamente por la API) 6. Idioma 7. Los campos de datos seleccionados Ejemplo de URL En este ejemplo, el URL se rompe en varias líneas para simplificar la lectura. El URL real no contiene retornos de carro. https://welcome.coremetrics.com:8080/analyticswebapp/api/1.0/ /report-data/ddx/orders.ftl?clientid=<clientid>&username=<userid> &format=xls&userauthkey=<authkey>&language=en_us&viewid=default.ftl &metrics=client_id,client_order_number,event_date,load_id,order_total Visualización de uso de la API El informe de uso de la API de Digital Data Exchange muestra una lista de las solicitudes efectuadas a la API durante el periodo seleccionado en el informe. Para cada solicitud, vea la fecha y la hora, los tipos de eventos de datos, el nombre de usuario, la solicitud de dirección IP y el número de registros devueltos. Capítulo 2. La API de Digital Data Exchange 11
Filtro de datos del informe de uso de la API Filtre los datos que se ven en el informe utilizando el control Periodo. También puede pulsar Opciones de informe para acceder a las opciones de agenda y filtro. Buscar datos en el informe de uso de la API Buscar artículos específicos especificando el texto de búsqueda en el campo Buscar en tabla. Ordene cada columna de forma ascendente o descendente pulsando la flecha situada en la esquina de cada cabecera de columna. Resolución de problemas con solicitudes de API En esta sección se muestra una lista de errores que podría encontrar al someter las solicitudes de API. Utilización de ID de carga como parámetro Resultado de la solicitud (ejemplo) {"errorcodes":["invalid_load_id"], "lastloadid":"1333125300", "minloadid":"1332776700"} {"loadids":[]} {"errorcodes":["user_authentication _FAILED"]} {"errorcodes":["api_user_authentication _FAILED"]} {"errorcodes":["invalid_load_id"]} {"loadid":null} {"errorcodes":["please_contact_customer _SUPPORT"]} Descripción del error El ID de carga proporcionado para el parámetro getloadidsafter no se encontró en la base de datos. La respuesta incluye el minloadid (el ID de carga más antiguo en la base de datos) y el lastloadid (el último ID de carga encontrado en la base de datos). No se ha proporcionado el ID de carga para el parámetro getloadidsafter. El nombre del usuario no era correcto o no se encontró, o bien la clave de autenticación era incorrecta o no se encontró El ID de cliente no era correcto o no se encontró. Nota: No es posible realizar solicitudes de API a no ser que su ID de cliente esté habilitado para la API Digital Data Exchange. El ID de carga que se proporcionó no era un entero. No hay ID de carga en la base de datos. Se ha producido un error no relacionado con la autenticación ni con la validación del ID de carga. Póngase en contacto con el servicio de soporte al cliente. 12 IBM Digital AnalyticsDigital Data Exchange Guía de API
Capítulo 3. Referencia de campos de datos de la API de Digital Data Exchange En la siguiente tabla se muestra una lista de campos de datos disponibles para cada informe de tipo de evento de datos en la API de Digital Data Exchange API. Para cada campo de datos, se muestra el tipo de datos y el número máximo de caracteres. Eventos de cesta Campo de datos Precio base Numérico (16,2) ID de cliente Numérico (8,0) ID de cookie Numérico (30,0) Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) ID de carga Numérico ID de producto CHARVAR (256) Nombre de producto CHARVAR (256) Cantidad del producto Numérico (8,0) ID de sesión Numérico (38,0) Campos de evento de cesta de atributo de compra de 1 CHARVAR (256) a50 ID de sitio CHARVAR (256) ID de ubicación de sitio CHARVAR (256) Nombre de ubicación de sitio CHARVAR (256) Eventos de conversión Campo de datos ID de cliente Numérico (8,0) Tipo de acción de evento de conversión Numérico (2,0) Campos de atributo de evento de conversión de 1a50 CHARVAR (256) Categoría de evento de conversión CHARVAR (256) ID de evento de conversión CHARVAR (256) Puntos de evento de conversión Numérico (8,0) ID de cookie Numérico (30,0) Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) ID de carga Numérico ID de sesión Numérico (38,0) Copyright IBM Corp. 2013 13
Campo de datos ID de sitio CHARVAR (256) Inicio de sesión de cookie Campo de datos ID de cliente Numérico (8,0) ID de cookie Numérico (30,0) ID de página de salida CHARVAR (256) ID de ubicación de sitio de salida CHARVAR (256) URL de destino CHARVAR (1024) ID de página de entrada CHARVAR (256) ID de ubicación de sitio de entrada CHARVAR (256) Fecha de evento Indicación de fecha y hora sin huso horario Distintivo de primera visita CHARVAR (1) ID de hora Numérico (2,0) Dirección IP CHARVAR (256) ID de carga Numérico Distintivo CGM CHARVAR (1) Nombre de referencia CHARVAR (256) Tipo de referencia CHARVAR (1) URL de referencia CHARVAR (1024) Enlace de búsqueda CHARVAR (1024) Palabra de búsqueda CHARVAR (256) ID de sesión Numérico (38,0) Páginas vistas de sesión Numérico (10,0) Tiempo transcurrido de sesión Numérico (6,0) Agente de usuario CHARVAR (256) Eventos de elemento Campo de datos ID de cliente Numérico (8,0) ID de cookie Numérico (30,0) Campos de atributo de elemento de 1a50 CHARVAR (256) Categoría de elemento CHARVAR (50) ID de elemento CHARVAR (50) Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) ID de carga Numérico ID de sesión Numérico (38,0) 14 IBM Digital AnalyticsDigital Data Exchange Guía de API
Campo de datos ID de sitio CHARVAR (256) Eventos de abandono de artículos Campo de datos Precio base Numérico (16,2) ID de cliente Numérico (8,0) ID de cookie Numérico (30,0) Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) ID de carga Numérico ID de producto CHARVAR (256) Nombre de producto CHARVAR (256) Cantidad del producto Numérico (8,0) ID de sesión Numérico (38,0) Campos de evento de abandono de artículos de atributo CHARVAR (256) de compra de 1a50 ID de sitio CHARVAR (256) ID de ubicación de sitio CHARVAR (256) Nombre de ubicación de sitio CHARVAR (256) Eventos de compra de artículo Campo de datos Precio base Numérico (16,2) ID de cliente Numérico (8,0) ID de cookie Numérico (30,0) Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) ID de carga Numérico ID de producto CHARVAR (256) Nombre de producto CHARVAR (256) Cantidad del producto Numérico (8,0) ID de sesión Numérico (38,0) Campos de evento de artículo comprado de atributo de CHARVAR (256) compra de 1a50 ID de sitio CHARVAR (256) ID de ubicación de sitio CHARVAR (256) Nombre de ubicación de sitio CHARVAR (256) Capítulo 3. Referencia de campos de datos de la API de Digital Data Exchange 15
Pulsaciones CGM Campo de datos ID de cliente Numérico (8,0) ID de cookie Numérico (30,0) Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) Campos de atributo de programa de marketing de 1 a CHARVAR (256) 50 ID de carga Numérico Parámetro de 1a4 CHARVAR (256) ID de sesión Numérico (38,0) ID de sitio CHARVAR (256) Eventos de pedido Campo de datos ID de cliente Numérico (8,0) Número de pedido de cliente Numérico (30,0) ID de cookie Numérico (30,0) Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) ID de carga Numérico Total de pedido Numérico (16,2) Campos de atributo de pedido/transacción de 1a50 CHARVAR (256) ID de sesión Numérico (38,0) Cargos de envío Numérico (16,2) ID de sitio CHARVAR (256) Total de líneas Numérico (3,0) Eventos de página vista Campo de datos ID de cliente Numérico (8,0) ID de cookie Numérico (30,0) URL de destino CHARVAR (1024) Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) ID de carga Numérico Palabra de búsqueda en el sitio CHARVAR (256) ID de página CHARVAR (256) Nombre de página CHARVAR (256) 16 IBM Digital AnalyticsDigital Data Exchange Guía de API
Campo de datos Tiempo transcurrido de página Numérico (6,0) Campos de atributo de página vista de 1a50 CHARVAR (256) URL de referencia CHARVAR (1024) Recuento de resultados de búsqueda Numérico (10,0) ID de sesión Numérico (38,0) ID de sitio CHARVAR (256) ID de ubicación de sitio CHARVAR (256) Nombre de ubicación de sitio CHARVAR (256) Eventos de producto visto Campo de datos ID de cliente Numérico (8,0) ID de cookie Numérico (30,0) Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) ID de carga Numérico ID de página CHARVAR (256) ID de producto CHARVAR (256) Nombre de producto CHARVAR (256) Campos de atributo de vista de producto de 1a50 CHARVAR (256) ID de sesión Numérico (38,0) ID de sitio CHARVAR (256) ID de ubicación de sitio CHARVAR (256) Nombre de ubicación de sitio CHARVAR (256) Pulsaciones de análisis físico del sitio web Campo de datos ID de cliente Numérico (8,0) ID de cookie Numérico (30,0) Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) ID de carga Numérico Parámetro de 1a4 CHARVAR (256) ID de sesión Numérico (38,0) ID de sitio CHARVAR (256) Capítulo 3. Referencia de campos de datos de la API de Digital Data Exchange 17
Acceso a datos de registro Campo de datos Edad Numérico (3,0) Ciudad CHARVAR (256) ID de cliente Numérico (8,0) ID de cookie Numérico (30,0) País/región CHARVAR (256) Nivel educativo CHARVAR (256) Dirección de correo electrónico CHARVAR (256) Fecha de evento Indicación de fecha y hora sin huso horario Género CHAR (1) ID de hora Numérico (2,0) ID de carga Numérico Nivel de ingresos máximo Numérico (14,2) Nivel de ingresos mínimo Numérico (14,2) Campos de atributo de registro de 1a50 CHARVAR (256) ID de registro CHARVAR (256) ID de sitio CHARVAR (256) Estado/Provincia CHARVAR (256) Código postal CHARVAR (256) Pulsaciones de promoción de sitio Campo de datos ID de cliente Numérico (8,0) ID de cookie Numérico (30,0) Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) ID de carga Numérico Parámetro de 1a4 CHARVAR (256) ID de sesión Numérico (38,0) ID de sitio CHARVAR (256) Propiedades técnicas Campo de datos Nombre de navegador CHARVAR (100) ID de cliente Numérico (8,0) Intensidad de color CHARVAR (30) ID de cookie Numérico (30,0) 18 IBM Digital AnalyticsDigital Data Exchange Guía de API
Campo de datos Fecha de evento Indicación de fecha y hora sin huso horario ID de hora Numérico (2,0) Es de dispositivo móvil CHARVAR (1) Versión JavaScript CHARVAR (30) Idioma CHARVAR (100) ID de carga Numérico Soporte de cookie móvil CHARVAR (1) Dispositivo móvil CHARVAR (100) Nombre de marketing de dispositivo móvil CHARVAR (100) Modelo de dispositivo móvil CHARVAR (30) Tipo de dispositivo móvil CHARVAR (30) Proveedor de dispositivo móvil CHARVAR (100) Soporte de flash móvil CHARVAR (1) Pantalla táctil móvil CHARVAR (1) Soporte de vídeo 3GP móvil CHARVAR (1) Soporte de vídeo MP4 móvil CHARVAR (1) Soporte de vídeo WMV móvil CHARVAR (1) Sistema operativo CHARVAR (100) Resolución de pantalla CHARVAR (30) ID de sesión Numérico (38,0) ID de sitio CHARVAR (256) Zona horaria CHARVAR (30) Capítulo 3. Referencia de campos de datos de la API de Digital Data Exchange 19
20 IBM Digital AnalyticsDigital Data Exchange Guía de API
Apéndice A. Información adicional de contacto En caso de que necesite una asistencia complementaria, póngase en contacto con IBM mediante uno de los siguientes métodos: v Soporte al cliente: cm_support@us.ibm.com v Comentarios del producto: cm_feedback@us.ibm.com Nota: Los comentarios del producto son recomendaciones para la mejora de los productos; no utilice la dirección de los comentarios para obtener asistencia adicional. IBM 1001 E Hillsdale Boulevard Foster City, CA 94402 Tfno. gratuito: 1 866 493 2673 Correo: cm_support@us.ibm.com IBM Austin 11501 Burnet Road Building 905, Floor 2 Austin, TX 78758-3400 Tfno. gratuito: 1 866 493 2673 IBM Europe Ltd. Lotus Park The Causeway Staines Middlesex TW18 3AG Reino Unido Tel: 0808 234 4736 Correo: cm_europe@us.ibm.com EE.UU. Europa IBM Francia 17 Avenue de l'europe 92275 Bois Colombes Cedex Francia Tel: 0800 91 4912 Correo: cm_france@us.ibm.com Asia-pacífico IBM Hong Kong Limited Silvercord Tower 2 Room 907 30, Canton Road Tsim Sha Tsui Kowloon Hong Kong SAR, China Tfno.: +852 8201 0823 Fax: +852 8201 0832 Correo: cm_asiapac@us.ibm.com IBM Client Support cm_support@us.ibm.com Centro de soporte técnico https://support.coremetrics.com IBM Dallas 750 W John Carpenter Freeway Irving, TX 75039 Tfno. gratuito: 1 866 493 2673 IBM GmbH Beim Strohhause 17 D-20097 Hamburg Alemania Tel: 0800 664 8899 Correo: cm_deutschland@us.ibm.com IBM Australia y Nueva Zelanda 60 Southgate Ave Southgate VIC 3006 AUSTRALIA (Aus) 1800 69 CORE (NZ) 0800 69 CORE Correo: cm_asiapac@us.ibm.com Copyright IBM Corp. 2013 21
IBM agradece sus comentarios Puede enviar los comentarios a la siguiente dirección. IBM Bay Area Lab 1001 E Hillsdale Boulevard Foster City, California 94404 EE.UU. Puede enviarnos los comentarios de manera electrónica mediante uno de los siguientes métodos: Tfno. gratuito 1+866-493-2673 Centro de soporte técnico: https://support.coremetrics.com Correo electrónico de Internet: cm_support@us.ibm.com World Wide Web: www.ibm.com/marketing-solutions/ En caso de que quiera una respuesta, asegúrese de incluir su nombre, dirección, número de teléfono o fax. Asegúrese también de incluir la siguiente información en su comentario o nota: v Título de este documento v Número de página o tema relacionado con el comentario Cuando envíe la información a IBM, garantiza a IBM un derecho no exclusivo para utilizar o distribuir la información según lo considere oportuno sin incurrir ninguna obligación sobre usted. 22 IBM Digital AnalyticsDigital Data Exchange Guía de API
Apéndice B. Soporte Centro de soporte técnico El sitio de soporte de IBM Digital Analytics se encuentra en https:// support.coremetrics.com o pulsando el enlace Soporte en la barra de menús de la aplicación. El Sitio web del centro de soporte técnico contiene lo siguiente: v Una base de conocimiento direccionable para responder preguntas y proporcionar acceso instantáneo a documentos esenciales, como guías de implementación, glosarios de métricas, guías del usuario, notas del release, etc. v Herramientas educativas, tales como formaciones basadas en web y seminarios web de archivos. v Información de marketing que incluye estudios de casos, libros blancos y eventos próximos, como la Cumbre de los clientes. v Notificaciones del soporte técnico. v Rastreo de problemas desde la creación de un tíquet pasando por su resolución, que proporciona información detallada del estado de sus consultas. v Comentarios para que pueda ofrecer sugerencias para mejorar el sitio de soporte. (Enviar comentarios acerca de las aplicaciones de IBM Digital Analytics a feedback@coremetrics.com). v Chat para que pueda contactar con uno de nuestros representantes de Prácticas recomendadas al instante. Copyright IBM Corp. 2013 23
24 IBM Digital AnalyticsDigital Data Exchange Guía de API
Avisos Esta información se ha desarrollado para productos y servicios ofrecidos en EE.UU. Es posible que IBM no ofrezca los productos, servicios o funciones que se tratan en este documento en otros países. Póngase en contacto con su representante local de IBM para obtener más información sobre los productos y servicios disponibles en su zona. Las referencias a programas, productos o servicios de IBM no pretenden establecer ni implicar que sólo puedan utilizarse dichos productos, programas o servicios de IBM. En su lugar, se puede utilizar cualquier producto, programa o servicio funcionalmente equivalente que no infrinja ninguno de los derechos de propiedad intelectual de IBM. Sin embargo, es responsabilidad del cliente evaluar y verificar el funcionamiento de cualquier producto, programa o servicio que no sea de IBM. IBM puede tener patentes o solicitudes de patentes pendientes que cubran el tema principal descrito en este documento. La entrega de este documento no le otorga ninguna licencia sobre dichas patentes. Puede enviar consultas sobre licencias, por escrito, a: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 EE.UU. Para consultas sobre licencias relacionadas con información de doble byte (DBCS), póngase en contacto con el departamento de propiedad intelectual de IBM de su país o envíe sus consultas, por escrito, a: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan, Ltd. 19-21, Nihonbashi-Hakozakicho, Chuo-ku Tokyo 103-8510, Japón El párrafo siguiente no se aplica al Reino Unido ni a ningún otro país donde estas disposiciones sean incompatibles: INTERNATIONAL BUSINESS MACHINES CORPORATION PROPORCIONA ESTA PUBLICACIÓN "TAL CUAL" SIN GARANTÍAS DE NINGÚN TIPO, NI EXPLÍCITAS NI IMPLÍCITAS, INCLUYENDO PERO NO LIMITÁNDOSE A ELLAS, LAS GARANTÍAS IMPLÍCITAS DE NO VULNERACIÓN, COMERCIALIZACIÓN O IDONEIDAD PARA UN FIN CONCRETO. Algunos países no permiten la renuncia a garantías explícitas o implícitas en determinadas transacciones, por lo que puede que esta declaración no sea aplicable en su caso. Esta información puede incluir imprecisiones técnicas o errores tipográficos. Periódicamente se efectúan cambios en la información aquí contenida; estos cambios se incorporarán en nuevas ediciones de la publicación. IBM puede realizar en cualquier momento mejoras o cambios en los productos o programas descritos en esta publicación sin previo aviso. Copyright IBM Corp. 2013 25
Cualquier referencia incluida en esta información a sitios Web que no sean de IBM sólo se proporciona para su comodidad y en ningún modo constituye una aprobación de dichos sitios Web. Los materiales de dichos sitios Web no forman parte de los materiales para este producto de IBM y el uso de dichos sitios Web corre a cuenta y riesgo del Cliente. IBM puede utilizar o distribuir cualquier información que se le proporcione en la forma que considere adecuada, sin incurrir por ello en ninguna obligación para con el remitente. Los titulares de licencias de este programa que deseen obtener información sobre el mismo con el fin de permitir: (i) el intercambio de información entre programas creados independientemente y otros programas (incluido éste) y (ii) el uso mutuo de información que se haya intercambiado, deben ponerse en contacto con: IBM Bay Area Lab 1001 E Hillsdale Boulevard Foster City, California 94404 EE.UU. Dicha información puede estar disponible, sujeta a los términos y condiciones correspondientes, incluyendo, en algunos casos, el pago de una tarifa. El programa bajo licencia que se describe en este documento y todo el material bajo licencia disponible los proporciona IBM bajo los términos de las Condiciones Generales de IBM, Acuerdo Internacional de Programas Bajo Licencia de IBM o cualquier acuerdo equivalente entre las partes. Cualquier dato que se encuentre en este documento se ha determinado en un ambiente controlado. Por lo tanto, los resultados obtenidos en otros entornos operativos podrían variar significativamente. Es posible que algunas medidas se hayan desarrollado con sistemas en nivel de desarrollo y no hay garantía de que estas medidas sean las mismas en sistemas con disponibilidad general. Además, algunas medidas se podrían haber estimado en extrapolación. Los resultados podrían variar. Los usuarios de este documento deberían verificar los datos aplicables para sus entornos específicos. La información relacionada con productos que no son de IBM se ha obtenido de los proveedores de dichos productos de sus anuncios publicados o de otras fuentes de disponibilidad pública. IBM no ha comprobado estos productos y no puede confirmar la precisión de su rendimiento, compatibilidad ni contemplar ninguna otra reclamación relacionada con los productos que no son de IBM. Las preguntas relacionadas con las funciones de los productos que no son de IBM deberán dirigirse a los proveedores de estos productos. Todas las sentencias relacionadas con la futura dirección de IBM o intento están sujetas al cambio o retirada sin previo aviso y sólo representan objetivos y metas. Esta información cuenta con ejemplos de datos e informes que se utilizan en operaciones de negocios a diario. Para ilustrarlas de manera más completa posible, los ejemplos incluyen nombre de individuos, empresas, marcas y productos. Todos estos nombres son ficticios y cualquier similitud a los nombres y direcciones que haya utilizado una empresa real es pura coincidencia. 26 IBM Digital AnalyticsDigital Data Exchange Guía de API
Marcas comerciales IBM, el logotipo de IBM e ibm.com son marcas registradas o marcas comerciales registradas de International Business Machines Corp., registrada en muchas jurisdicciones en todo el mundo. Otros nombres de servicios y productos podrían ser marcas registradas de IBM u otras compañías. Hay disponible una lista actual de marcas registradas de IBM en la Web en Información de marca registrada y copyright en www.ibm.com/legal/copytrade.shtml. Consideraciones de la política de privacidad Los productos de software de IBM, incluido el software que se ofrece como soluciones de servicio, ("Ofertas de software") podrían utilizar cookies u otras tecnologías para recopilar información de uso del producto, para ayudar a mejorar la experiencia del usuario final, para ajustar interacciones con el usuario final o para otros propósitos. Una cookie es un elemento de datos que un sitio web puede enviar a su navegador, que a su vez se puede almacenar en su sistema como una etiqueta que identifica su sistema. En muchos casos, estas cookies no recopilan información personal. Si está utilizando una Oferta de Software que recopila información personal a través de cookies o de una tecnología similar, a continuación le informamos sobre los pormenores. Dependiendo de las configuraciones desplegadas, esta Oferta de software puede utilizar cookies persistentes o de sesión que recopilan el nombre de cada usuario así como información personal adicional con el propósito de gestionar sesiones, mejorar la usabilidad del usuario o a otros efectos funcionales o de seguimiento. Estas cookies se pueden inhabilitar, pero al hacerlo también eliminará las funcionalidades que habilitan. Existen varias jurisdicciones que regulan la recopilación de información personal a través de tecnologías como las de cookies o similares. Si las configuraciones desplegadas para esta Oferta de Software le proporcionan como cliente la posibilidad de recopilar información personal sobre usuarios a través de cookies u otras tecnologías, debería buscar su propio asesoramiento legal en relación a todas las leyes aplicables a dicha recopilación de datos, incluidos los requisitos para proporcionar avisos y el consentimiento cuando sea lo propio. IBM exige que los Clientes (1) proporcionen un enlace claro y visible a los términos de uso del sitio web del Cliente (por ejemplo, su política de privacidad) que incluya un enlace a las prácticas de uso y de recopilación de datos del Cliente y de IBM, (2) notifiquen que las cookies y los gif transparentes/balizas web se ubican en el sistema del visitante por parte de IBM en nombre del Cliente junto con una explicación del propósito de dicha tecnología, y (3) en la medida que lo exija la ley, obtiene el consentimiento de los visitantes del sitio web antes ubicar cookies y gifs transparentes/balizas web por parte del Cliente o IBM en nombre del Cliente en los dispositivos del visitante del sitio web. Si desea obtener más información sobre la utilización de las distintas tecnologías, incluidas las cookies, para estos propósitos, consulte la declaración de privacidad en línea de IBM en http://www.ibm.com/privacy/details/us/en, en la sección que se titula "Cookies, Web Beacons and Other Technologies". Avisos 27
28 IBM Digital AnalyticsDigital Data Exchange Guía de API
Impreso en España