Adobe© Digital Marketing Suite API de fuentes de datos Contents API de fuentes de datos..........................................................................................4 Introducción.............................................................................................................................4 ID de fuentes de datos............................................................................................................5 Métodos de fuentes de datos..................................................................................................8 DataSource.SetupFull................................................................................................................................9 DataSource.SetupTraffic............................................................................................................................9 DataSource.SetupWebLog.......................................................................................................................10 DataSource.SetupGeneric.......................................................................................................................10 DataSource.GetIDs..................................................................................................................................11 DataSource.GetInfo..................................................................................................................................11 DataSource.BeginDataBlock....................................................................................................................12 DataSource.AppendDataBlock.................................................................................................................13 DataSource.ProcessIncompleteVisits......................................................................................................15 DataSource.GetFileIDs............................................................................................................................15 DataSource.GetFileInfo............................................................................................................................16 DataSource.GetFileStatus........................................................................................................................16 DataSource.Restart..................................................................................................................................17 DataSource.Deactivate............................................................................................................................17 Tipos de datos personalizados.............................................................................................18 tns:colArray..............................................................................................................................................18 tns:dataSourceFileInfo.............................................................................................................................18 tns:dataSourceFileStatus.........................................................................................................................19 tns:dataSourceFiles.................................................................................................................................20 tns:dataSourceInfo...................................................................................................................................20 tns:dsFileStruct........................................................................................................................................21 tns:ds_full_injection_type.........................................................................................................................21 tns:ds_full_settings...................................................................................................................................21 tns:ds_generic_settings...........................................................................................................................22 tns:ds_setup_result..................................................................................................................................22 tns:ds_traffic_data_scope........................................................................................................................23 Last updated 2/21/2012 API de fuentes de datos Contents tns:ds_traffic_settings...............................................................................................................................23 tns:ds_weblog_formats............................................................................................................................24 tns:ds_weblog_settings............................................................................................................................24 tns:errorList..............................................................................................................................................24 tns:fileIDResult.........................................................................................................................................24 tns:fileInfoResult.......................................................................................................................................25 tns:fileStatusResult..................................................................................................................................25 tns:infoResult............................................................................................................................................25 tns:intArray...............................................................................................................................................25 tns:rowArray.............................................................................................................................................25 tns:simpleDataSource..............................................................................................................................25 tns:simpleDataSourceArray......................................................................................................................25 tns:status..................................................................................................................................................26 tns:warningList.........................................................................................................................................26 Código de ejemplo................................................................................................................26 Last updated 2/21/2012 API de fuentes de datos API de fuentes de datos 4 API de fuentes de datos Las fuentes de datos permiten importar datos a SiteCatalyst para fines de informe y optimización. Una vez importados, muchos tipos de fuentes de datos se encuentran disponibles en todo Adobe Online Marketing Suite, como en SearchCenter, Discover y Data Warehouse. Estos servicios pueden analizar las fuentes de datos por separado o en conjunto con los mecanismos tradicionales de recopilación de datos. Para obtener más información sobre las fuentes de datos, consulte la Guía del usuario de fuentes de datos , que se encuentra disponible en el sistema de ayuda de SiteCatalyst. Note: Una vez enviados mediante la API de fuentes de datos, los datos importados no se distinguen de los datos de SiteCatalyst recopilados usando otros métodos (como JavaScript, AppMeasurement y la API de inserción de datos). Después de importados los datos, ya no se puede volver atrás. Introducción La API de fuentes de datos facilita el proceso de importación de datos de fuentes de datos. En lugar de utilizar el proceso estándar de envío de archivos mediante FTP para enviar los datos a los servidores de colecciones de datos Adobe, utilice la API de fuentes de datos para enviar bloques de datos HTTP usando una interfaz SOAP o REST. Esta forma resulta especialmente práctica para cargar los datos históricos que se usarán en los informes de SiteCatalyst. Además de proporcionar un mecanismo automático para el envío de datos a SiteCatalyst, la API de fuentes de datos también verifica los datos básicos de forma inmediata. En el momento del envío, la API de fuentes de datos verifica el formato y la estructura de los datos básicos del bloque de envío y devuelve un error si observa algún problema. De modo que el problema se puede corregir inmediatamente y volver a enviar el bloque de datos. Por el contrario, en un envío de datos a través de FTP, la verificación de datos no se realiza hasta que SiteCatalyst intenta procesar los datos. Esta diferencia en el punto de verificación resulta en un retraso de al menos 30 minutos antes de conocer la existencia de un error de formato de los datos. Para obtener información detallada sobre las fuentes de datos, consulte la Guía del usuario de fuentes de datos , que se encuentra disponible en el sistema de ayuda de SiteCatalyst. API de fuentes de datos 5 El proceso general de creación de una fuente de datos con la API de fuentes de datos es el siguiente: 1. Se llama a uno de los métodos de configuración de fuentes de datos (DataSource.SetupFull, DataSource.SetupTraffic, DataSource.SetupWebLog, DataSource.SetupGeneric) para crear el tipo de fuentes de datos que se necesita. 2. Se llama a DataSource.GetIDs o DataSource.GetInfo para obtener el ID de fuente de datos de una nueva fuente de datos. 3. Se llama a DataSource.BeginDataBlock y, si fuera necesario, DataSource.AppendDataBlock para agregar datos a la nueva fuente de datos y enviar la fuente de datos a la cola de procesamiento. Si fuera necesario, se llamará a DataSource.ProcessIncompleteVisits para cerrar las visitas del sitio Web que abarcan los bloques de datos para las fuentes de datos de procesamiento completo. 4. Se llama a DataSource.GetFileIDs o DataSource.GetFileInfo para obtener el ID de archivo del archivo de la fuente de datos en la cola de procesamiento. 5. Se llama a DataSource.GetFileStatus para supervisar el estado del archivo de fuentes de datos. Cuando concluye el procesamiento de las fuentes de datos, los datos enviados a través de la fuente de datos están disponibles en SiteCatalyst. 6. Se llama a DataSource.Restart o DataSource.Deactivate para administrar la fuente de datos según sea necesario. ID de fuentes de datos El ID de fuentes de datos es un valor numérico que identifica el tipo de fuentes de datos. Muchos de los métodos de fuentes de datos descritos en la API de fuentes de datos requieren y/o devuelven un ID de fuentes de datos. En la tabla siguiente se muestran las fuentes de datos disponibles con el ID de fuentes de datos asociado a cada una. A continuación, cada nombre de fuente de datos es la agrupación de fuentes de datos a la que pertenece la fuente de datos. Las agrupaciones de fuentes de datos identifican diferentes tipos de fuentes de datos que comparten funciones y requisitos fundamentales similares. Las agrupaciones son una forma de clasificar las fuentes de datos desde el punto de vista de los sistemas back-end que procesan las fuentes de datos. API de fuentes de datos 6 La API de fuentes de datos organiza fuentes de datos basadas en agrupaciones, en lugar de la categoría y el tipo usados en la IU de fuentes de datos en SiteCatalyst. Si desea más información sobre las agrupaciones de fuentes de datos, consulte "Agrupaciones de fuentes de datos" en la Guía del usuario de fuentes de datos , disponible en Ayuda > Documentación. Fuente de datos ID de fuente de datos SiteCatalyst Web Beacons 1 Las señalizaciones de JavaScript son el principal método de recopilación de datos de SiteCatalyst. La fuente de datos no puede activarse ni eliminarse a través de esta interfaz. Si desea cambiar o agregar una fuente de datos de señalización Web, comuníquese con su representante de cuentas. 2 La mayoría de los servidores Web generan archivos de registro donde se anotan todas las páginas servidas. Mediante el uso de esta fuente de datos, puede procesar los archivos de registro con la mayoría de los datos de servidores Web y agregarlos a sus informes. 3 SiteCatalyst puede "resumir" los datos de varias páginas en un solo conjunto de informes. Estos informes reflejan la actividad de todos los sitios Web asociados. La fuente de datos no puede activarse ni eliminarse a través de esta interfaz. Si desea cambiar o agregar una fuente de datos de resumen de SiteCatalyst, comuníquese con su representante de cuentas. 4 Usando el Asistente para segmentos, puede sacar el máximo partido a la tecnología ASI de SiteCatalyst para crear informes que reflejen la actividad de un segmento concreto. Por ejemplo: con el asistente podrá crear un segmento que muestre solo las visitas que finalizan con una compra. 5 Integre impresiones y otras métricas de primera línea sobre las actividades de los servicios de publicidad desde su servidor de publicidad en SiteCatalyst. Constituye la fuente de datos genérica del servidor de publicidad y debe utilizarse si no se admite el servidor de publicidad específico. 6 Integre las métricas del servidor de campañas de correo electrónico en SiteCatalyst. Dentro de las métricas incorporadas comúnmente se incluye la cantidad de mensajes enviados, recibidos y leídos. Constituye la fuente de datos genérica de campaña de correo electrónico y debe utilizarse si no se admite el servidor de campaña de correo electrónico específico. 7 Importe datos sobre su rendimiento de pago por clic, incluidas las impresiones, los clics y el coste. Constituye la fuente de datos genérica de pago por clic y debe utilizarse si no se admite el servidor de pago por clic específico. (N/D) Web Server Log Files (Web Log) SiteCatalyst Rollups (N/D) ASI (N/D) Generic Ad Server (Standard) Generic Email Campaign Server (Standard) Generic Pay-per-Click Service (Standard) Descripción API de fuentes de datos 7 Fuente de datos ID de fuente de datos Generic Call Center 8 Integre información sobre su centro de llamadas en los informes de SiteCatalyst. Dentro de las métricas comúnmente importadas se incluyen la cantidad de llamadas, la duración de estas, el agente y el total de ventas. Constituye la fuente de datos genérica del centro de llamadas y debe utilizarse si su software de centro de llamadas específico no es compatible. 9 Facilita la integración de información desde el software de asistencia técnica al cliente en la interfaz de informes de SiteCatalyst. Incluye métricas, tales como la cantidad de incidentes nuevos, la cantidad de incidentes resueltos y el tiempo empleado para resolverlos. Constituye la fuente de datos genérica de asistencia al cliente y debe utilizarse si no se admite la aplicación de servicio al cliente específica. 10 Integre resultados del estudio desde una herramienta de un tercero a SiteCatalyst y mostrar la satisfacción de los clientes al interactuar con el sitio. Constituye la fuente de datos genérica de estudio y debe utilizarse si no se admite el servicio de datos de estudio específico. 11 Integra datos desde una aplicación o servicio que realiza el seguimiento de la velocidad de descarga con los datos de SiteCatalyst. Constituye la fuente de datos genérica de velocidad de descarga y debe utilizarse si no se admite el servicio o software de velocidad de descarga específico. 12 Use esta fuente de datos genérica cuando no encuentre otra que coincida mejor con el tipo de datos que desea importar a SiteCatalyst. 14 Importa datos de tráfico de todo el sitio Web. Por ejemplo, vistas de páginas. 15 Importa datos de tráfico desglosados por otra variable de sitio Web. Por ejemplo, vistas de páginas por producto. 17 Ofrece cargas masivas, manuales o automáticas de Excel, en SearchCenter. 20 La fuente de datos completa genérica permite importar datos de archivos de registro a SiteCatalyst. Los datos se procesarán como si los servidores Online Marketing Suite los hubiera recibido en la (Standard) Generic Customer Support Application (Standard) Generic Survey Data (Standard) Generic Site Download Speed (Standard) Generic Data Source Summary Data Only (Standard) Site-Level Traffic Data Source Descripción (Traffic) Breakdown Traffic Data Source (Traffic) SearchCenter Bulk Upload (Standard) Generic Data Source (Full Processing) API de fuentes de datos Fuente de datos 8 ID de fuente de datos Descripción fecha y hora especificadas (a cada visita se le pone una marca de fecha y hora). Product Returns 26 Importe los datos de devoluciones de productos y asócielos con el ID de la compra. Utilice esta fuente de datos para identificar motores de búsqueda, palabras clave, campañas y otros atributos que tengan mayor probabilidad de generar devoluciones. Product Cost 27 Proporcione el coste real de los productos comprados y enviados desde su sitio. Una vez que el coste o la ganancia se asocia con los productos, genere informes precisos en cuanto a campañas, palabras claves y promociones internas más rentables del sitio. Order Status 28 Utilice métricas para identificar el estado de cada pedido hecho, incluso los pedidos cancelados, enviados, finalizados o considerados fraudulentos. La información de estado de los pedidos identifica qué métodos de adquisición generan la mayor cantidad de pedidos finalizados. Lead Generation 29 Cargue información sobre los resultados de cada posible cliente generado en su sitio, incluso el ingreso real generado. Una vez que el ingreso es atribuido con precisión a las ID de los posibles clientes, podrá identificar las campañas y promociones más rentables. Online Quote 30 Registre los ingresos por transacciones sin conexión y otras métricas resultantes de las cotizaciones en línea. Una vez que se proporcionan las métricas puede identificar las campañas y promociones más rentables que condujeron a la cotización. Call Center Data 31 Cargue las transacciones del centro de llamadas para identificar las situaciones (campañas, promociones, etc.) que condujeron a los clientes a coger el teléfono. Generic Data Source Transaction ID 32 Relacione eventos sin conexión con un evento en línea. El ID de la transacción actúa como una clave entre los eventos sin conexión y los eventos en línea. (Integration) Métodos de fuentes de datos La API de fuentes de datos incluye estos métodos. Crear llamadas de métodos desde SOAP y REST empleando el nombre del método y los nombres de parámetro aquí descritos. Si desea más información acerca de cómo usar los servicios Web con SOAP y REST, consulte Introducción. API de fuentes de datos 9 Note: Muchos métodos de fuentes de datos requieren y/o devuelven un ID de fuentes de datos, que es un valor numérico que identifica el tipo de fuentes de datos asociado con la llamada de este método. Si desea más información, consulte ID de fuentes de datos. DataSource.SetupFull Crea una nueva fuente de datos de procesamiento completo. Si desea más información sobre los tipos de fuentes de datos, consulte "Acceso a las fuentes de datos” en la Guía del usuario de fuentes de datos. Parámetros de DataSource.SetupFull Parámetro Tipo Requerido reportSuiteID xsd:string Sí dataSourceID xsd:int Sí dataSourceSettings tns:ds_full_settings No Descripción El ID del conjunto de informes en el que se desea crear esta fuente de datos. El ID de la nueva fuente de datos. La configuración de la nueva fuente de datos. Respuesta DataSource.SetupFull Tipo Descripción tns:ds_setup_result Devuelve datos sobre la nueva fuente de datos. DataSource.SetupTraffic Crea una nueva fuente de datos de tráfico. Si desea más información sobre los tipos de fuentes de datos, consulte "Acceso a las fuentes de datos” en la Guía del usuario de fuentes de datos. Parámetros de DataSource.Setup Parámetro Tipo Requerido Descripción reportSuiteID xsd:string Sí dataSourceID xsd:int Sí dataSourceSettings tns:ds_traffic_settings No El ID del conjunto de informes en el que se desea crear esta fuente de datos. El ID de la nueva fuente de datos. La configuración de la nueva fuente de datos. API de fuentes de datos 10 Respuesta DataSource.SetupTraffic Tipo Descripción tns:ds_setup_result Devuelve datos sobre la nueva fuente de datos. DataSource.SetupWebLog Crea una nueva fuente de datos de registro Web. Si desea más información sobre los tipos de fuentes de datos, consulte "Acceso a las fuentes de datos” en la Guía del usuario de fuentes de datos. Parámetros de DataSource.SetupWebLog Parámetro Tipo Requerido Descripción reportSuiteID xsd:string Sí dataSourceID xsd:int Sí dataSourceSettings tns:ds_weblog_settings No El ID del conjunto de informes en el que se desea crear esta fuente de datos. El ID de la nueva fuente de datos. La configuración de la nueva fuente de datos. Respuesta DataSource.SetupWebLog Tipo Descripción tns:ds_setup_result Devuelve datos sobre la nueva fuente de datos. DataSource.SetupGeneric Crea una nueva fuente de datos genérica. Si desea más información sobre los tipos de fuentes de datos, consulte "Acceso a las fuentes de datos” en la Guía del usuario de fuentes de datos. Parámetros de DataSource.SetupGeneric Parámetro Tipo Obligatorio Descripción reportSuiteID xsd:string Sí dataSourceID xsd:int Sí dataSourceType xsd:int No El ID de conjunto de informes en el que se desea crear esta fuente de datos. El ID de la nueva fuente de datos. Especifica el tipo de fuentes de datos que se creará. Si desea más información sobre los tipos de fuentes de datos, API de fuentes de datos Parámetro 11 Tipo Obligatorio Descripción consulte "Acceso a las fuentes de datos" en la Guía del usuario de fuentes de datos. dataSourceSettings tns:ds_generic_settings No La nueva configuración de fuentes de datos. Respuesta DataSource.SetupGeneric Tipo Descripción tns:ds_setup_result Devuelve datos sobre la nueva fuente de datos. DataSource.GetIDs Devuelve una lista de ID de fuentes de datos asociada al conjunto de informes especificado. Si desea más información sobre los tipos de fuentes de datos, consulte "Acceso a las fuentes de datos” en la Guía del usuario de fuentes de datos. Parámetros de DataSource.GetIDs Parámetro Tipo Requerido Descripción reportSuiteID xsd:string Sí El ID del conjunto de informes en el que se desea crear esta fuente de datos. Respuesta DataSource.GetIDs Tipo Descripción tns:simpleDataSourceArray Una lista de ID de fuentes de datos. DataSource.GetInfo Devuelve información sobre las fuentes de datos asociadas al conjunto de informes especificado. Parámetros DataSource.GetInfo Parámetro Tipo Requerido Descripción reportSuiteID xsd:string Sí El ID del conjunto de informes en el que se desea crear esta fuente de datos. API de fuentes de datos 12 Respuesta DataSource.GetInfo Tipo Descripción tns:infoResult Una lista de fuentes de datos e información sobre ellas. DataSource.BeginDataBlock Envía el primer bloque de datos HTTP en un envío de fuentes de datos. Los bloques de datos individuales pueden contener un máximo de 10.000 filas de datos (para mantener el HTTP POST por debajo de 10 MB), por lo que quizás tenga que enviar los datos en varios bloques de datos. Parámetros de DataSource.BeginDataBlock Parámetro Tipo reportSuiteID xsd:string dataSourceID xsd:string Obligatorio Descripción Sí El ID del paquete de informes en el que se desea enviar el bloque de datos. Sí El ID de fuente de datos en el que se desea enviar el bloque de datos. Puede obtener este ID llamando a DataSource.GetIDs . blockName xsd:string columnNames tns:colArray rows tns:rowArray * endOfBlock xsd:string No El nombre del archivo que aparece en el registro de fuentes de datos. Si no se especifica uno, se genera un nombre de bloque. Sí Los nombres de las columnas de datos (los encabezados de columna) enviados a través de las fuentes de datos. Sí Los datos que se enviarán a los servidores de colección de SiteCatalyst. No Indica si es el último bloque del envío de datos. Puede usar el parámetro endOfBlock de las formas siguientes. Autofinalización: Incluya <endOfBlock/> para indicar que este es el último bloque de la fuente de datos. Entonces, las fuentes de datos ponen en cola la fuente de datos para procesarla. Con el parámetro: Incluya false o 0 como parámetro de endOfBlock para indicar que este bloque NO es el último de la fuente de datos. API de fuentes de datos Parámetro 13 Tipo Obligatorio Descripción Note: Si su cliente SOAP lo permite, también puede excluir el parámetro endOfBlock para indicar que este bloque no es el último de la fuente de datos. *El XML del parámetro row en la llamada de BeginDataBlock es similar al siguiente. Este ejemplo XML no incluye el parámetro <endOfBlock/>, que indica que ya no vienen más datos a través de la llamada de DataSource.AppendDataBlock . <reportSuiteID xsi:type="xsd:string">myReportSuite</reportSuiteID> <dataSourceID xsi:type="xsd:string">12345</dataSourceID> <blockName xsi:type="xsd:string">myTestFile</blockName> <columnNames xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[3]"> <item xsi:type="xsd:string">date</item> <item xsi:type="xsd:string">evar 1</item> <item xsi:type="xsd:string">event 2</item> </columnNames> <rows xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:colArray[2]"> <item xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[3]"> <item xsi:type="xsd:string">1/1/2009</item> <item xsi:type="xsd:string">product1</item> <item xsi:type="xsd:string">2.50</item> </item> <item xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[3]"> <item xsi:type="xsd:string">1/2/2009</item> <item xsi:type="xsd:string">product2</item> <item xsi:type="xsd:string">4.25</item> </item> </rows> Respuesta DataSource.BeginDataBlock Parámetro Type Descripción status xsd:string Indica si la llamada se ha realizado correctamente. Los valores válidos de devolución son Failed o Success. Si se produce un error en la llamada, las fuentes de datos devuelven un mensaje de error. blockID xsd:int El ID empleado para agregar bloques de datos adicionales a este envío de fuentes de datos. A este parámetro se le asigna un valor solo si el bloque de datos no incluye la etiqueta <endOfBlock/>. fileID xsd:int El ID que genera la cola de procesamiento para identificar un envío de fuentes de datos concreto. Este valor es un identificador uniforme, independiente del método de envío de datos concreto (HTTP o FTP). A este parámetro solo se le asigna un valor si el bloque de datos incluye la etiqueta <endOfBlock/>. DataSource.AppendDataBlock Agrega un bloque de datos HTTP adicional al envío de datos de fuentes de datos. Los bloques de datos individuales pueden contener un máximo de 10.000 filas de datos (para mantener el HTTP POST por debajo de 10 MB), por lo que quizás tenga que enviar los datos en varios bloques de datos. API de fuentes de datos 14 Parámetros de DataSource.AppendDataBlock Parámetro Tipo reportSuiteID xsd:string dataSourceID xsd:string blockID xsd:int rows tns:rowArray * endOfBlock xsd:string Obligatorio Descripción Sí El ID del paquete de informes en el que se desea enviar el bloque de datos. Sí El ID de fuente de datos en el que se desea enviar el bloque de datos. Puede obtener este ID llamando a DataSource.GetIDs. No El ID del primer bloque enviado para este envío de datos. BeginDataBlock devuelve el blockID en su respuesta, siempre y cuando endOfBlock no esté incluido en la llamada de BeginDataBlock. Sí Los datos que se enviarán a los servidores de colecciones de SiteCatalyst. No Indica si este es el último bloque del envío de datos. Puede usar el parámetro endOfBlock de las formas siguientes. Autofinalización: Incluya <endOfBlock/> para indicar que este es el último bloque de la fuente de datos. Entonces, las fuentes de datos ponen en cola la fuente de datos para procesarla. Con el parámetro: Incluya false o 0 como parámetro de endOfBlock para indicar que este bloque NO es el último de la fuente de datos. Note: Si su cliente SOAP lo permite, también puede excluir el parámetro endOfBlock para indicar que este bloque no es el último de la fuente de datos. *El XML del parámetro row en la llamada de AppendDataBlock es similar al siguiente. Este ejemplo de XML incluye el parámetro <endOfBlock/>, que indica que ya no vienen más datos y que la API de fuentes de datos puede poner los datos en la cola de procesamiento. <reportSuiteID xsi:type="xsd:string">myReportSuite</reportSuiteID> <dataSourceID xsi:type="xsd:string">12345</dataSourceID> <blockID xsi:type="xsd:string">54321</blockName> <rows xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:colArray[2]"> <item xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[3]"> <item xsi:type="xsd:string">1/3/2009</item> <item xsi:type="xsd:string">product3</item> <item xsi:type="xsd:string">1.75</item> </item> <item xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[3]"> <item xsi:type="xsd:string">1/4/2009</item> API de fuentes de datos 15 <item xsi:type="xsd:string">product4</item> <item xsi:type="xsd:string">3.25</item> </item> </rows> <endOfBlock/> Respuesta DataSource.AppendDataBlock Parámetro Type Descripción status xsd:string Indica si la llamada se ha realizado correctamente. Los valores válidos de devolución son Failed o Success. Si se produce un error en la llamada, las fuentes de datos devuelven un mensaje de error. fileID xsd:int El ID que genera la cola de procesamiento para identificar un envío de las fuentes de datos. Este valor es un identificador uniforme, independiente del método de envío de datos concreto (HTTP o FTP). A este parámetro solo se le asigna un valor si el bloque de datos incluye la etiqueta <endOfBlock/>. DataSource.ProcessIncompleteVisits Indica a las fuentes de datos que procesen los datos relacionados con las visitas al sitio inconclusas del archivo o bloque de datos actual. Las visitas pueden abarcar archivos o bloques de datos, por lo que las fuentes de datos apartan a un lado estas visitas incompletas hasta que se les pida que las procesen. Este método solo se aplica a las fuentes de datos de procesamiento completo y cierra cualquier visita abierta al final del bloque de datos enviados antes de llamar a ProcessIncompleteVisits. Parámetros de DataSource.ProcessIncompleteVisits Parámetro Tipo Requerido Descripción reportSuiteID xsd:string Sí dataSourceID xsd:string Sí El ID del conjunto de informes en el que desea crear esta fuente de datos. El ID de fuente de datos. Puede averiguar este ID llamando a DataSource.GetIDs . Respuesta DataSource.ProcessIncompleteVisits Tipo Descripción tns:status Indica si la llamada se ha realizado correctamente. DataSource.GetFileIDs Devuelve una lista de archivos o bloques de datos enviados a la fuente de datos especificada. Este método devuelve los ID de archivo asignados a los bloques de datos cuando entran en la cola de procesamiento. API de fuentes de datos 16 Parámetros DataSource.GetFileIDs Parámetro Tipo Obligatorio Descripción reportSuiteID xsd:string Sí dataSourceID xsd:string Sí filter xsd:string Sí El ID del conjunto de informes en el que se desea crear esta fuente de datos. El ID de fuentes de datos. Puede obtener este ID llamando a DataSource.GetIDs . Un valor de cadena que limita los ID de archivo devueltos a los que incluyen el valor especificado. Respuesta DataSource.GetFileIDs Tipo Descripción tns:fileIDResult Indica si la llamada se ha realizado correctamente. DataSource.GetFileInfo Devuelve información sobre los archivos enviados a la fuente de datos especificada. Parámetros DataSource.GetFileInfo Parámetro Tipo Obligatorio Descripción reportSuiteID xsd:string Sí dataSourceID xsd:string Sí filter xsd:string Sí El ID del conjunto de informes en el que se desea crear esta fuente de datos. El ID de fuente de datos. Puede obtener este ID llamando a DataSource.GetIDs . Un valor de cadena que limita la información de archivo devuelta a los ID de archivo que incluyen el valor especificado. Respuesta DataSource.GetFileInfo Tipo Descripción tns:fileInfoResult Una lista de archivos enviados a la fuente de datos especificada. DataSource.GetFileStatus Devuelve información de estado sobre los archivos enviados a la fuente de datos especificada. API de fuentes de datos 17 La información de estado indica si el archivo está en cola para procesamiento, en procesamiento o ya ha sido procesado. Parámetros de DataSource.GetFileStatus Parámetro Tipo Requerido Descripción reportSuiteID xsd:string Sí dataSourceID xsd:string Sí El ID del conjunto de informes en el que desea crear esta fuente de datos. El ID de fuente de datos. Puede averiguar este ID llamando a DataSource.GetIDs . Respuesta DataSource.GetFileStatus Tipo Descripción tns:fileStatusResult El estado actual de procesamiento de archivos en el que se encuentra la fuente de datos especificada. DataSource.Restart Reinicia el procesamiento de la fuente de datos de procesamiento completo. Si un archivo de procesamiento completo contiene errores, las fuentes de datos se pausan durante el procesamiento de archivos para dar lugar a que se corrijan los errores. DataSource.Restart informa al sistema de que se han corregido los errores del archivo y de que el procesamiento puede continuar. Parámetros de DataSource.Restart Parámetro Tipo Requerido Descripción reportSuiteID xsd:string Sí dataSourceID xsd:string Sí El ID del conjunto de informes en el que desea crear esta fuente de datos. El ID de fuente de datos. Puede averiguar este ID llamando a DataSource.GetIDs . Respuesta DataSource.Restart Tipo Descripción tns:status Indica si la llamada se ha realizado correctamente. DataSource.Deactivate Desactiva la fuente de datos especificada. API de fuentes de datos 18 Parámetros de DataSource.Deactivate Parámetro Tipo Requerido Descripción reportSuiteID xsd:string Sí dataSourceID xsd:string Sí El ID del conjunto de informes en el que desea crear esta fuente de datos. El ID de fuente de datos. Puede averiguar este ID llamando a DataSource.GetIDs . Respuesta DataSource.Deactivate Tipo Descripción tns:status Indica si la llamada se ha realizado correctamente. Tipos de datos personalizados La API de fuentes de datos utiliza estas estructuras de datos personalizadas, incluidos los tipos enumerados. El tipo de datos define la estructura para organizar y contener un conjunto específico de datos. Los tipos de datos pueden constar de dos o más elementos, cada uno de los cuales puede ser una matriz, una enumeración, una estructura o un elemento “primitivo”. Adobe define los tipos de datos utilizando la siguiente convención: <namespace>:<type> Por ejemplo: • xsd:int indica que el tipo de datos es parte del xsd espacio de nombre (Definición de esquema XML) y que el tipo es int (Entero). XML define ciertos tipos de datos primitivos (comunes) como entero, cadena o fecha. En Definición de esquema XML se describen todos los tipos de datos primitivos. • tns:code_items indica que el tipo de datos es parte del espacio de nombre tns (un espacio de nombre Adobe privado) y que el tipo de datos personalizado es code_items. El espacio de nombre tns aparece como prefijo en todos los tipos de datos personalizados de Online Marketing Suite. tns:colArray Una matriz de xsd:string. tns:dataSourceFileInfo Estructura de datos que contiene información sobre un archivo enviado a una fuente de datos. Elemento Tipo id xsd:string fileName xsd:string Descripción El identificador de archivo único. El nombre de archivo. API de fuentes de datos 19 Elemento Tipo startDate xsd:string finishDate xsd:string fileSizeBytes xsd:int fileRows xsd:int errors tns:errorList warnings tns:warningList receivedDate xsd:string status xsd:string Descripción La fecha y hora de inicio del procesamiento del archivo. La fecha y hora de finalización del procesamiento del archivo. El tamaño del archivo en bytes. El número de filas de datos del archivo. Una lista de errores fatales del archivo. Una lista de advertencias no fatales del archivo. La fecha y hora en la que los servidores Adobe recibieron el archivo. Estado del procesamiento del archivo. Los valores admitidos son Success y Failure. tns:dataSourceFileStatus Estructura de datos que contiene información de estado sobre un archivo enviado a una fuente de datos. Elemento Tipo fileName xsd:string startDate xsd:string finishDate xsd:string fileSizeBytes xsd:int fileRows xsd:int errors tns:errorList warnings tns:warningList receivedDate xsd:string Descripción El nombre del archivo. La fecha y hora de inicio del procesamiento del archivo. La fecha y hora de finalización del procesamiento del archivo. El tamaño del archivo en bytes. El número de filas de datos del archivo. Una lista de errores fatales del archivo. Una lista de advertencias no fatales del archivo, organizadas por fila de datos. La fecha y hora en la que los servidores Adobe recibieron el archivo. API de fuentes de datos 20 Elemento Tipo status xsd:string Descripción El estado del procesamiento del archivo. Los valores admitidos son Success y Failure. tns:dataSourceFiles Una matriz de tns:dataSourceFileInfo . tns:dataSourceInfo Estructura de datos que contiene las opciones de configuración para una fuente de datos de procesamiento completo. Elemento Tipo dataSourceID xsd:string type xsd:string name xsd:string email xsd:string activateDate xsd:string ftpPath xsd:string ftpLoginID xsd:string ftpPassword xsd:string haltOnWarning xsd:int Descripción El identificador único de la fuente de datos. El tipo de la fuente de datos. El nombre de la fuente de datos. La dirección de correo electrónico administrativa asociada a la fuente de datos. La fecha y hora en las que se activó la fuente de datos. El host FTP de la fuente de datos (para recibir datos). El nombre de inicio de sesión en FTP de la fuente de datos. La contraseña de inicio de sesión en FTP de la fuente de datos. Indica si el procesamiento de las fuentes de datos se ha detenido a causa de un error no fatal. Los valores admitidos son: 0: No detenido. 1: Detenido. haltOnError xsd:int Indica si el procesamiento de las fuentes de datos se ha detenido a causa de un error fatal. Los valores admitidos son: 0: No detenido. 1: Detenido. API de fuentes de datos 21 Elemento Tipo lockedByError xsd:int Descripción Indica si la fuente de datos está bloqueada a causa de un error fatal. Los valores admitidos son: 0: No bloqueada. 1: Bloqueada. tns:dsFileStruct Estructura de datos que contiene información sobre los archivos enviados asociados a una fuente de datos. Elemento Tipo dataSourceID xsd:string dataSourceName xsd:string dsFileInfo tns:dataSourceFiles Descripción El identificador único de fuentes de datos. El nombre de la fuente de datos. Una lista de archivos asociados a la fuente de datos. tns:ds_full_injection_type Una lista enumerada de tipos de inyección de fuentes de datos completas. El tipo enumerado incluye los siguientes elementos de tipo xsd:string. Elemento Live Historic Descripción Indica datos en los que influye el tiempo. Online Marketing Suite procesa los datos activos con su tasa de facturación CPMM estándar. Indica datos en los que no influye el tiempo. Online Marketing Suite procesa los datos históricos a una tasa de facturación con descuentos. tns:ds_full_settings Estructura de datos que contiene las opciones de configuración para una fuente de datos de procesamiento completo. Elemento Tipo dataSourceName xsd:string dataSourceEmail xsd:string injectionType tns:ds_full_injection_type Descripción El nombre de la fuente de datos. La dirección de correo electrónico en la que las fuentes de datos envían notificaciones y alertas. El tipo de datos incluidos en esta fuente de datos. API de fuentes de datos 22 Elemento Tipo allowOutOfOrderHits xsd:boolean Descripción Cuando se define en True, indica a los servidores Adobe que procesen los envíos de datos en orden no secuencial, es decir, en un orden diferente al orden en que ocurrieron los eventos. Note: Aún así, los registros individuales deben estar ordenados. stopOnWarning xsd:boolean Cuando se define en True, los servidores de Adobe detienen el procesamiento si encuentran una advertencia no fatal. tns:ds_generic_settings Estructura de datos que contiene las opciones de configuración para una fuente de datos genérica. Elemento Tipo dataSourceName xsd:string dataSourceEmail xsd:string metricNames array(xsd:string) metricEvents array(xsd:string) dimensionNames array(xsd:string) Descripción El nombre de la fuente de datos. La dirección de correo electrónico en la que las fuentes de datos envían notificaciones y alertas. La métrica que se incluirá en la fuente de datos. Esta matriz debe tener el mismo número de elementos que metricEvents. El evento de SiteCatalyst que se asociará a cada métrica. Esta matriz debe tener el mismo número de elementos que metricNames. Las dimensiones que se incluirán en la fuente de datos. Esta matriz debe tener el mismo número de elementos que dimensionVariables. dimensionVariables array(xsd:string) Las dimensiones SiteCatalyst, como las eVar y campañas, que se asociarán a cada dimensión. Esta matriz debe tener el mismo número de elementos que dimensionNames. tns:ds_setup_result Estructura de datos que contiene información sobre una fuente de datos nueva. API de fuentes de datos 23 Elemento Tipo dataSourceID xsd:int status xsd:string Descripción Un identificador único para la nueva fuente de datos. Indica si la llamada se ha realizado con éxito. Los valores válidos de devolución son Success y Failed. tns:ds_traffic_data_scope Una lista numerada de ámbitos para los datos de las fuentes de datos de tráfico. El tipo enumerado incluye los siguientes elementos de tipo xsd:string. Elemento Site Level Breakdown Descripción Indica el ámbito de los datos en todo el sitio para la fuente de datos. Indica un ámbito de datos más detallado para la fuente de datos. tns:ds_traffic_settings Estructura de datos que contiene las opciones de configuración para una fuente de datos de tráfico. Elemento Tipo dataSourceName xsd:string dataSourceEmail xsd:string dataScope tns:ds_traffic_data_scope standardBreakdowns array(xsd:string) Descripción El nombre de las fuentes de datos. La dirección de correo electrónico donde las fuentes de datos envían notificaciones y alertas. El ámbito de los datos de la fuente de datos. Uno o más desgloses estándar para los datos de la fuente de datos. Cuando dataScope = Breakdown, debe haber al menos un desglose estándar o personalizado. Los valores admitidos son: Page, Channel y Server. customBreakdownNames array(xsd:string) Los nombres de cada desglose personalizado (propiedades 1-75 de SiteCatalyst). Esta matriz debe tener el mismo número de elementos que customBreakdownValues. customBreakdownValues array(xsd:string) Una o más propiedades de tráfico en la forma propX, donde X es un número del 1 al 75. Compruebe que la propiedad seleccionada está habilitada en la consola de administración. API de fuentes de datos Elemento 24 Tipo Descripción Esta matriz debe tener el mismo número de elementos que customBreakdownNames. metricList array(xsd:string) Uno o más eventos para importar. Para una lista de métricas válidas, consulte "Métricas válidas de tráfico" en la Guía del usuario de fuentes de datos. tns:ds_weblog_formats Una lista enumerada de tipos de inyección de fuentes de datos completas. El tipo enumerado incluye los siguientes elementos de tipo xsd:string. Elemento NCSA Common Log NCSA Extended W3C Extended Log Microsoft IIS Log Descripción El predeterminado de Apache. Apache. IIS 4.0 y posteriores IIS 3.0 y anteriores tns:ds_weblog_settings Estructura de datos que contiene las opciones de configuración para una fuente de datos de tráfico. Elemento Tipo dataSourceName xsd:string dataSourceEmail xsd:string logFormat tns:ds_weblog_formats Descripción El nombre de la fuente de datos. La dirección de correo electrónico en la que las fuentes de datos envían notificaciones y alertas. El formato de registro usado con esta fuente de datos. tns:errorList Una matriz de xsd:string. tns:fileIDResult Estructura de datos que contiene una lista de los ID de archivo enviados a una fuente de datos concreta. API de fuentes de datos 25 Elemento Tipo result tns:intArray status tns:status Descripción Un identificador único para la fuente de datos nueva. Indica si la llamada se ha realizado correctamente. Los valores válidos de devolución son Success y Failed. tns:fileInfoResult Una matriz de tns:dsFileStruct . tns:fileStatusResult Estructura de datos que contiene información sobre el estado de un único archivo de una fuente de datos. Elemento Tipo fileStatus tns:dataSourceFileStatus status tns:status Descripción Un identificador único para una fuente de datos nueva. Indica si la llamada se ha realizado correctamente. Los valores válidos de devolución son Success y Failed. tns:infoResult Una matriz de tns:dataSourceInfo . tns:intArray Una matriz de xsd:int. tns:rowArray Una matriz de tns:colArray. tns:simpleDataSource Estructura de datos que contiene información básica sobre una fuente de datos. Elemento Tipo dataSourceID xsd:int dataSourceName xsd:string tns:simpleDataSourceArray Una matriz de tns:simpleDataSource . Descripción Un identificador único para la fuente de datos. El nombre de la fuente de datos. API de fuentes de datos 26 tns:status Estructura de datos que contiene información sobre el estado de una fuente de datos. Elemento Tipo Descripción statusCode xsd:int message xsd:string El código de estado de la fuente de datos. Un breve mensaje asociado al estado de la fuente de datos actual. tns:warningList Una matriz de xsd:string. Código de ejemplo Este código de ejemplo demuestra una interacción básica de las fuentes de datos con PHP. Aunque su código de fuente de datos será mucho más complejo, este ejemplo muestra los componentes principales y sus interacciones en el entorno de fuentes de datos. Note: No espere copiar y pegar este código y que la interacción de las fuentes de datos funcione. A lo largo de todo el ejemplo, se han empleado valores genéricos y datos estáticos en aras de la simplicidad. <?php require_once 'nusoap.php'; define( 'WSDL_DOCUMENT', 'omnitureAPI.wsdl' ); // This is the data to be sent. It // In a typical situation this data file. $columnNames = array( 'date', 'evar $rows = array ( array ( '1/1/2009', 'product1', array ( '1/2/2009', 'product2', array ( '1/3/2009', 'product3', ); will be formatted into XML below. would be read from some other location, like a database or 1', 'event 2' ); '2.50' ), '4.25' ), '3.75' ) // Seed the number generator list( $usec, $sec ) = explode( ' ', microtime() ); srand( (float)$sec + ((float)$usec * 100000) ); // SOAP login credentials $rsid = 'myReportSuiteID'; $dsid = 'myDataSourceID'; $username = 'myUserName'; $secret = 'mySecret'; // Returns the security header function GetHeader ( ) { // Create a unique identifier (a.k.a. nonce). // This example is used for simplicity in demonstration. // Use a method that guarantees uniqueness in a production environment. global $username; API de fuentes de datos 27 global $secret; $nonce = md5( rand() ); $created = date( "Y-m-d H:i:s" ); $comboString = $nonce . $created . $secret; $sha1String = sha1( $comboString ); $password = base64_encode( $sha1String ); $header = '<wsse:Security SOAP-ENV:mustUnderstand="1"> <wsse:UsernameToken wsu:Id="User"> <wsse:Username>'.$username.'</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">'.$password.'</wsse:Password> <wsse:Nonce>'.$nonce.'</wsse:Nonce> <wsu:Created>'.$created.'</wsu:Created> </wsse:UsernameToken> </wsse:Security>'; return $header; } // Gather function parameters $params = array ( 'reportSuiteID' => $rsid, 'dataSourceID' => $dsid, 'blockName' => 'myTestFile', 'columnNames' => $columnNames, 'rows' => $rows, 'endOfBlock' => TRUE ); // Create nuSOAP client // nusoap.php's soapclient class cannot co-exist with the PHP 5 soapclient. You must // rename it to something else. $client = new nusoapclient( WSDL_DOCUMENT, TRUE ); // Call Omniture Web services function $result = $client->call( 'DataSource.BeginDataBlock', $params, 'http://omniture.com', '', GetHeader() ); // Display results echo "RESULTS:\n"; print_r( $result ); echo "\n"; ?>