Adobe© Digital Marketing Suite

API de Test&Target

Contents API de Test&Target..................................................................................................4 API de informe de auditoría....................................................................................................4 Crear la URL base.....................................................................................................................................4 Incluir parámetros para filtrar la consulta...................................................................................................5 Inspeccionar la respuesta de la consulta...................................................................................................5 Analizar la respuesta de la consulta..........................................................................................................6

API de copia de campaña.......................................................................................................6 Crear la URL base.....................................................................................................................................6 Agregar parámetros de consulta................................................................................................................6

API de lista de campañas.......................................................................................................7 Crear la URL base.....................................................................................................................................8 Incluir parámetros para filtrar la consulta...................................................................................................8 Inspeccionar la respuesta de la consulta...................................................................................................9 Analizar la respuesta de la consulta........................................................................................................10

API de estado de campaña...................................................................................................10 Crear la URL base...................................................................................................................................10 Agregar parámetros de consulta..............................................................................................................10

API de vista de campaña......................................................................................................11 Crear la URL base...................................................................................................................................11 Agregar parámetros de consulta..............................................................................................................12 Inspeccionar la respuesta de la consulta.................................................................................................12

API de herramienta de página de aterrizaje..........................................................................14 API de informes de rendimiento............................................................................................16 Crear la URL base...................................................................................................................................16 Incluir parámetros para filtrar la consulta.................................................................................................16 Inspeccionar la respuesta de la consulta.................................................................................................17 Analizar la respuesta de la consulta........................................................................................................19

API de paso de perfiles y conversión sin conexión...............................................................19 Pasar un perfil de usuario........................................................................................................................20 Asigna un ID de usuario de terceros a T&T.............................................................................................21

Last updated 2/21/2012

API de Test&Target

Contents

API de ID de campaña de terceros.......................................................................................22 Asociar el ID de terceros..........................................................................................................................22 Buscar una campaña por ID de terceros.................................................................................................22

API de creación de oferta de utilidades................................................................................23 Crear la URL base...................................................................................................................................23 Agregar parámetros de consulta..............................................................................................................23

Last updated 2/21/2012

API de Test&Target

API de Test&Target

4

API de Test&Target Las API de Test&Target proporcionan acceso mediante programación a las características y los perfiles de informes de Test&Target (T&T). Note: Test&Target solamente es compatible con la interfaz REST. No es compatible con SOAP.

API de informe de auditoría La API de informe de auditoría de campaña permite extraer mediante programación datos de informes de auditoría de una sola campaña. Puede recuperar los datos de informe de auditoría de análisis sin conexión, almacenamiento permanente o crear una interfaz de creación de informes personalizada. Note: T&T solamente almacena los datos de auditoría durante 4 semanas. Si desea conservarlos, puede guardarlos en una ubicación secundaria con la API de informe de auditoría de campañas o la interfaz de administración. El uso de la API de informes de auditoría de campañas supone: • Crear la URL base • Incluir parámetros para filtrar la consulta • Inspeccionar la respuesta de la consulta • Analizar la respuesta de la consulta

Crear la URL base Por ejemplo: https://testandtarget.omniture.com/api?client

Parámetro client email password

Descripción (Requerido) El nombre de cliente T&T. (Requerido) La dirección de correo electrónico asociada al cliente T&T. (Requerido) La contraseña de cliente T&T.

Note: En los parámetros y valores se distingue entre mayúsculas y minúsculas.

API de Test&Target

5

Incluir parámetros para filtrar la consulta Agrega a cada operación los parámetros y los valores que se necesitan como filtro. Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=mypassword&operation=auditReport&campaignId=1234&start=2007-08-01T00:00&end=2007-09-01T00:00&step=step1&environment=production&format=csv

Parámetro operation

campaignId

start

en

step

environment

format

Descripción (Requerido) Identifica el tipo de acción T&T que va a ejecutarse. Para generar informes de auditoría, este valor es siempre auditReport. (Requerido) El ID de la campaña que desea consultar. Para identificar el ID de lista de campañas, use la API de lista de campañas o mire en el parámetro campaignDescriptionId en la URL cuando visualice una campaña en la herramienta T&T. (Requerido) La fecha y hora de inicio del informe. Especifique la fecha usando el siguiente formato: YYYY-MM-DDTHH:mm. El informe de rendimiento utiliza la configuración de zona horaria especificada en el explorador Web. (Requerido) La hora y fecha de finalización del informe. Especifique la fecha usando el siguiente formato: YYYY-MM-DDTHH:mm. El informe de rendimiento utiliza la configuración de zona horaria especificada en el explorador Web. (Opcional) El nombre de la métrica de éxito con codificación URL (anteriormente denominado paso). De forma predeterminada, el valor de step es last step. (Opcional) El nombre de grupo host con codificación URL, tal y como se define en la herramienta T&T. De forma predeterminada, el valor de environment es Production. (Opcional) El formato de salida del informe. Actualmente, el único valor admitido para este parámetro es csv (valores separado por comas).

Inspeccionar la respuesta de la consulta T&T genera el informe de auditoría en formato CSV, que puede importar a cualquier programa de hoja de cálculo, como Microsoft* Excel*. Por ejemplo: "Campaign: landing campaign RFM" "Downloaded at: 2007-08-24. Time zone: EST5EDT" "Step: Conversion" "Campaign Id","Recipe","Order Date","Order Time","Order Ids"

Id","Amount","Order Flag","Product

"worst","" 42,81,"2007-08-20","17:25:29","1187645128929",$429.00,"---","9" 42,81,"2007-08-20","17:25:36","1187645135874",$319.00,"---","7" 42,81,"2007-08-20","17:25:43","1187645142834",$325.00,"---","5" "best",""

API de Test&Target

6

42,82,"2007-08-20","16:56:11","1187643370833",$325.00,"---","5" 42,82,"2007-08-20","16:56:16","1187643376266",$479.00,"---","3" 42,82,"2007-08-20","16:58:15","1187643495634",$99.95,"---","42"

Analizar la respuesta de la consulta Otra opción es utilizar un lenguaje de secuencia de comandos, como Perl, Python y Ruby, para manipular mediante programación el contenido de los informes de auditoría y, de este modo, crear informes personalizados.

API de copia de campaña La API de copia de campaña permite crear una nueva campaña T&T basada en una campaña de origen existente. El uso de API de creación de oferta de utilidades supone: • Crear la URL base • Agregar parámetros de consulta

Crear la URL base Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=pword

Parámetro client

company

email password

Descripción (Opcional) El código de cliente T&T. Debe proporcionar un valor para el parámetro client o, bien, para el parámetro company para llevar a cabo la operación. (Opcional) El ID de empresa Online Marketing Suite. Debe proporcionar un valor para el parámetro client o, bien, para el parámetro company para llevar a cabo la operación. (Requerido) La dirección de correo electrónico asociada al cliente T&T. (Requerido) La contraseña de cliente T&T.

Note: En los parámetros y valores se distingue entre mayúsculas y minúsculas.

Agregar parámetros de consulta Agrega a cada operación los parámetros y valores necesarios para establecer el estado de la campaña T&T. Por ejemplo, utilice la siguiente URL para copiar una campaña T&T, sustituyendo cada uno de los parámetros de la URL por su valor correspondiente: https://testandtarget.omniture.com/[email protected]&password=pword&operation=copyCampaign&id=123&thirdPartyId=extID501&new3rdPartyId=extID995&branch=2&segment=3&action=approve&name=Name

API de Test&Target

Parámetro operation

id

thirdpartyId

new3rdPartyId

branch

segment

action

name

7

Descripción (Requerido) Identifica el tipo de acción T&T que va a ejecutarse. Para cambiar el estado de una campaña T&T, este valor es siempre copyCampaign. (Opcional) El ID de la campaña que desea copiar. Debe especificar id o thirdPartyId para identificar la campaña de origen. (Opcional) El identificador de terceros asociado a la campaña de origen. Debe especificar id o thirdPartyId para identificar la campaña de origen. (Opcional) El identificador de terceros que se asociará a la campaña de origen. Si no se especifica, no se asocia ningún ID de terceros a la campaña nueva. Si este valor es el mismo que thirdPartyId, el thirdPartyId de la campaña de origen se establece en NULL. (Opcional) Una lista separada por comas de los ID de ramas que se copiarán en la nueva campaña. Si no se especifica una lista, se copian todas las ramas en la nueva campaña. (Opcional) El segmento que se va a promocionar como condiciones de objetivo de entrada para agregar a la lista actual de condiciones de entrada de campaña. Si no se especifica ningún segmento, la nueva campaña usa las mismas condiciones de entrada que la campaña de origen y copia todos los segmentos a la nueva campaña. (Opcional) Cuando se establece en approve, T&T activa la nueva campaña y desactiva la campaña de origen. En caso contrario, T&T crea la nueva campaña pero no la activa, y deja la campaña de origen activa. El nombre de la nueva campaña. Si no se especifica, el nombre de la nueva campaña es el nombre de la campaña de origen con "(copy)" anexado al final del nombre. Por ejemplo, "campaign1" se convierte en "campaign1 (copy)".

Si la respuesta es 200, indica una operación correcta. T&T también devuelve la información siguiente acerca de la nueva campaña: newCampaignID new3rdPartyID //if defined

API de lista de campañas La API de lista de campañas permite definir mediante programación filtros (de tiempo, estado, etc.) para extraer nombres e identificadores de campaña. El uso de la API de lista de campañas supone: • Crear la URL base • Incluir parámetros para filtrar la consulta

API de Test&Target

8

• Inspeccionar la respuesta de la consulta • Analizar la respuesta de la consulta

Crear la URL base Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=pword

Parámetro client email password

Descripción (Opcional) El nombre de cliente T&T. (Requerido) La dirección de correo electrónico asociada al cliente T&T. (Requerido) La contraseña de cliente T&T.

Note: En los parámetros y valores se distingue entre mayúsculas y minúsculas.

Incluir parámetros para filtrar la consulta Agrega a cada operación los parámetros y los valores que se necesitan como filtro. Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=mypassword&operation=campaignList&before=2007-01-27T12:00&after=2006-04-01T00:00&environment=testEnvironment&name=test&state=saved,activated&labels=label1,library,label2

Parámetro operation

before

after

environment

name

Descripción (Requerido) Identifica el tipo de acción T&T que va a ejecutarse. Para generar informes de listas de campaña, este valor siempre es campaignList. (Requerido) Un valor de fecha. Incluye campañas que han estado activas al menos una vez antes de la fecha especificada. De forma predeterminada, el parámetro before es 2100-01-01T00:00. (Opcional) Un valor de fecha. Incluye campañas que han estado activas al menos una vez después de la fecha especificada. De forma predeterminada, el valor after es 1969-00-00T00:00. (Opcional) El nombre de grupo host con codificación URL, tal y como se define en la herramienta T&T. De forma predeterminada, el valor de environment es Production. (Opcional) El nombre de la campaña, o parte del nombre de la campaña, que desea hacer coincidir.

API de Test&Target

Parámetro state

labels

9

Descripción (Opcional) Una lista separada por comas de los estados que se van a hacer coincidir. Los valores admitidos son: saved, activated, library. De forma predeterminada, los resultados filtrados incluyen todos los estados. (Opcional) Una lista separada por comas de las etiquetas que se van a hacer coincidir. De forma predeterminada, los resultados filtrados incluyen todas las etiquetas.

Inspeccionar la respuesta de la consulta Las respuestas correctas a una consulta usan la siguiente estructura XML: 16 Test Campaign A 17 Test Campaign B

Etiqueta campaign id

name

Descripción Una sola campaña. El identificador de la campaña. Utilice este valor con la API de informe de rendimiento de campañas. El nombre de la campaña especificada.

Las respuestas incorrectas a una consulta usan la siguiente estructura XML: Invalid email or password supplied. Email: [email protected] 401

Etiqueta message

Descripción Una descripción del error. Por ejemplo: Invalid email or password supplied. Email: [email protected].

code

El código de error. Por ejemplo: 401

API de Test&Target

10

Analizar la respuesta de la consulta Otra opción es utilizar un lenguaje de secuencia de comandos, como Perl, Python y Ruby, y la API de informe de rendimiento de campañas para iterar por los resultados de las consultas y recuperar informes de detalles de campañas específicas.

API de estado de campaña La API de estado de campaña permite cambiar el estado de una campaña T&T existente. El uso de la API de estado de campaña supone: • Crear la URL base • Agregar parámetros de consulta

Crear la URL base Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=pword

Parámetro client

company

email password

Descripción (Opcional) El código de cliente T&T. Debe proporcionar un valor para el parámetro client o, bien, para el parámetro company para llevar a cabo la operación. (Opcional) El ID de empresa Online Marketing Suite. Debe proporcionar un valor para el parámetro client o, bien, para el parámetro company para llevar a cabo la operación. (Requerido) La dirección de correo electrónico asociada al cliente T&T. (Requerido) La contraseña de cliente T&T.

Note: En los parámetros y valores se distingue entre mayúsculas y minúsculas.

Agregar parámetros de consulta Agrega a cada operación los parámetros y valores necesarios para establecer el estado de la campaña T&T. Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=pword&operation=setCampaignState&state=Deactivated&campaignId=cam29034&thirdPartyId=extID501>

API de Test&Target

Parámetro operation

state campaignId

thirdpartyId

11

Descripción (Requerido) Identifica el tipo de acción T&T que va a ejecutarse. Para cambiar el estado de una campaña T&T, este valor es siempre setCampaignState. (Requerido) El estado de la campaña. Los valores admitidos incluyen Approved y Deactivated. (Opcional) El ID de la campaña que desea modificar. Debe especificar campaignId o thirdPartyId. (Opcional) El identificador de terceros asociado a la campaña que se desea modificar. Debe proporcionar campaignId o thirdPartyId

La respuesta a la solicitud le indica si la operación ha sido correcta. Por ejemplo: Campaign [7] state set to [Saved]

API de vista de campaña La API de vista de campaña devuelve una “vista” XML de la campaña T&T especificada. El uso de la API de vista de campaña supone: • Crear la URL base • Agregar parámetros de consulta • Inspeccionar la respuesta de la consulta

Crear la URL base Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=pword

Parámetro client

company

email password

Descripción (Opcional) El código de cliente T&T. Debe proporcionar un valor para el parámetro client o, bien, para el parámetro company para llevar a cabo la operación. (Opcional) El ID de empresa Online Marketing Suite. Debe proporcionar un valor para el parámetro client o, bien, para el parámetro company para llevar a cabo la operación. (Requerido) La dirección de correo electrónico asociada al cliente T&T. (Requerido) La contraseña de cliente T&T.

Note: En los parámetros y valores se distingue entre mayúsculas y minúsculas.

API de Test&Target

12

Agregar parámetros de consulta Agrega a cada operación los parámetros y valores necesarios para copiar la campaña T&T. Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=pword&operation=viewCampaign&id=intID995&thirdPartyId=extID501

Parámetro operation

id thirdpartyId

Descripción (Requerido) Identifica el tipo de acción T&T que va a ejecutarse. Para cambiar el estado de una campaña T&T, este valor es siempre viewCampaign. (Opcional) El ID de la campaña que desea ver. Debe especificar id o thirdPartyId. (Opcional) El identificador de terceros asociado a la campaña que se desea modificar. Debe proporcionar id o thirdPartyId

Si T&T encuentra una campaña con el id o thirdPartyId especificado, devuelve un archivo XML que describe la campaña (consulte Muestra de una vista XML de campaña). En caso contrario, devuelve uno de los siguientes mensajes de error: Authentication error code: 401 Invalid request code: 400

Inspeccionar la respuesta de la consulta NNNN third party id //if supplied by client. Campaign Name approved|paused|deactivated|saved|deleted true|false //only 'approved' and 'paused' have enabled = true. YYYY-mm-DDTMM:HH:SS YYYY-mm-DDTMM:HH:SS mboxName url ad equalsIgnoreCase A B (for currently unsupported targets) homePageHero mbox age equals

API de Test&Target

33 NNNN (recipe model ID - doesn't change even on client migration) branch name branch description recipe targeting - same type as targets from displayTargets (for anonymous offers) ... ID offer name http://client.com/page.html ...

Objetivos admitidos Nombre de mbox: mboxName

Objetivo de los parámetros mbox y URL: url | mbox parameter name equals | equalsIgnoreCase|etc value1 value2 ....

Restricción en porcentaje de rama: 95.5

13

API de Test&Target

14

Ofertas admitidas HTML anónimo ofrece: offer content

Redirección anónima ofrece: http://mysite.com/page.html

Contenido predeterminado: Ofertas actualmente no admitidas: ID

No anónimo ofrece: ID offer name

API de herramienta de página de aterrizaje La API de herramienta de página de aterrizaje permite configurar las opciones predeterminadas para la creación de campañas en Test&Target. Permite simplificar el proceso de configuración de campañas para el usuario de T&T (el especialista en mercadotecnia). Por ejemplo, puede predefinir los parámetros URL que desencadenan una campaña. Note: Cuando se usa la API de herramienta de página de aterrizaje, todos los parámetros deben estar codificados para URL. Use la siguiente URL para la herramienta de página de aterrizaje, sustituyendo el valor apropiado para cada uno de los parámetros URL: https://testandtarget.omniture.com/api?tool=API%20tests

Parámetro tool

Descripción (Requerido) El tipo de interfaz de la página de edición. Los valores admitidos son los siguientes: admin: usar una interfaz clásica de edición. simple: usar una nueva interfaz de edición.

campaignName

(Opcional) El nombre de la campaña T&T.

API de Test&Target

Parámetro 3rdPartyCampaignId

campaignTarget

15

Descripción (Opcional) El ID de terceros que se asociará a la campaña. Para obtener más información, consulte la API de ID de campaña de terceros. (Opcional) Expresión objetivo, que toma una de las formas siguientes: page.param('paramName').indexOf('paramValue') >= 0 page.referrer.param('paramName').indexOf('paramValue') >= 0

page

(Opcional) La URL de la página de aterrizaje de la campaña. Tenga en cuenta lo siguiente a la hora de designar una página de aterrizaje: • La URL puede ser HTTP o HTTPS. • La página de aterrizaje debe tener una inclusión mbox.js en la página y, al menos, un mbox. • Los clientes deben tener una cuenta T&T.

returnLink

breadcrumb

branchNames

displayMboxes

conversionMbox

priority

(Opcional) La URL de una página a la que se regresará en caso de problemas. Si no se especifica este parámetro, el explorador Web se cerrará en caso de problemas. (Opcional) El texto que se va a mostrar en un vínculo de sendero de migas. La herramienta de página de aterrizaje usa la URL de returnLink como URL de vínculo de sendero de migas. (Opcional) Una lista separada por comas de los nombres de fórmulas. Si no se especifica este parámetro, la herramienta de página de aterrizaje elige como valor predeterminado la fórmula A. (Opcional) Una lista separada por comas de nombres de mbox. Por ejemplo: Product Page, Category Page, Footer. (Opcional) El nombre del mbox de conversión. Si el parámetro no se especifica, la herramienta de página de aterrizaje usa como valor predeterminado conversion. (Opcional) La prioridad de la campaña utilizada por Test&Target para determinar qué campaña tiene prioridad. Los valores admitidos son los siguientes: 0: prioridad baja 1: prioridad media 2: prioridad alta

label

(Opcional) La etiqueta descriptiva de la campaña. Una etiqueta descriptiva facilita el filtrado de la lista de campañas.

API de Test&Target

16

API de informes de rendimiento La API de informes de rendimiento permite extraer mediante programación información detallada sobre el rendimiento de una sola campaña. Puede recuperar informes de rendimiento sobre análisis sin conexión o crear un tablero de informes personalizado. El uso de la API de informes de rendimiento supone: • Crear la URL base • Incluir parámetros para filtrar la consulta • Inspeccionar la respuesta de la consulta • Analizar la respuesta de la consulta

Crear la URL base Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=pword&type=all

Parámetro client email password type

Descripción (Requerido) El nombre de cliente T&T. (Requerido) La dirección de correo electrónico asociada al cliente T&T. (Requerido) La contraseña de cliente T&T. (Opcional) La métrica de campaña específica. Los valores admitidos son visit, visitor e impression. Si no especifica este parámetro, T&T incluye todas las métricas en el informe.

Note: En los parámetros y valores se distingue entre mayúsculas y minúsculas.

Incluir parámetros para filtrar la consulta Agrega a cada operación los parámetros y los valores que se necesitan como filtro. Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=mypassword&operation=report&campaignId=NNNN&start=YYYY-MM-DD&end=YYYY-MM-DD&environment=testEnvironment&resolution=hour&segment=name

Parámetro operation

Descripción (Requerido) Identifica el tipo de acción T&T que va a ejecutarse. Para generar informes de rendimiento, este valor es siempre Report.

API de Test&Target

Parámetro campaignId

start

end

environment

resolution

segment

17

Descripción (Requerido) El ID de la campaña que desea consultar. Para identificar el ID de lista de campañas, use la API de lista de campañas o mire en el parámetro campaignDescriptionId en la URL cuando visualice una campaña en la herramienta T&T. (Requerido) La fecha y hora de inicio del informe. Especifique la fecha usando el siguiente formato: YYYY-MM-DDTHH:mm. El informe de rendimiento utiliza la configuración de zona horaria especificada en el explorador Web. (Requerido) La hora y fecha de finalización del informe. Especifique la fecha usando el siguiente formato: YYYY-MM-DDTHH:mm. El informe de rendimiento utiliza la configuración de zona horaria especificada en el explorador Web. (Opcional) El nombre de grupo host con codificación URL, tal y como se define en la herramienta T&T. De forma predeterminada, el valor de environment es Production. (Opcional) El período del informe, que puede ser uno de los valores siguientes: hour, day (predeterminado), week, month. (Opcional) El nombre del segmento que se incluirá en el informe. Si no especifica este parámetro, el informe de rendimiento es un resumen de todos los segmentos. Para generar un informe que enumere cada segmento por separado, utilice un valor de segmento de allSegments.

Inspeccionar la respuesta de la consulta La siguiente respuesta de éxito abreviada muestra dos segmentos individuales y la suma de los segmentos. 476.0 370.0 476.0 1117.0 1117.0 1100.0 1100.0 255.0 121.13

API de Test&Target

18

. . . . . .

Etiqueta reports

report

Descripción Contiene todos los informes generados mediante una única solicitud de la API de informe de rendimiento. Contiene un informe. La etiqueta report admite los atributos siguientes: campaignId: consulte el parámetro campaignId en Incluir parámetros para filtrar la consulta. start: consulte el parámetro start en Incluir parámetros para filtrar la consulta. end: consulte el parámetro end en Incluir parámetros para filtrar la consulta. resolution: consulte el parámetro resolution en Incluir parámetros para filtrar la consulta. type: consulte el parámetro type en Incluir parámetros para filtrar la consulta. segment: el nombre del segmento utilizado para generar este informe. Este atributo se omite

cuando se genera un informe resumido de todos los segmentos. segmentId: el ID del segmento utilizado para generar este informe. T&T omite este atributo

cuando se genera un informe resumido de todos los segmentos. sample

Contiene los datos de un único intervalo de informes. Si no hay visitantes en un intervalo de tiempo determinado (por ejemplo, day 2 o hour 5) el resultado XML omite ese nodo. La etiqueta sample admite los atributos siguientes: start: la fecha y hora de inicio de la muestra. duration: la duración de la muestra, tal y como define el parámetro de consulta resolution.

recipe

Contiene la fórmula. El atributo recipe admite el atributo siguiente: name: nombre de la fórmula.

step

Contiene los datos (visitantes, visitas o impresiones) de una única métrica de éxito (mostrar mboxes, conversión, etc.) asociada a esta fórmula. La etiqueta step admite el atributo siguiente: name: el nombre de la métrica de éxito.

amount

Contiene los ingresos asociados a esta fórmula.

API de Test&Target

19

Etiqueta

Descripción

engagementMetrics engagement

Contiene las métricas de compromiso. La etiqueta engagementMetrics admite los atributos siguientes: stepName: el nombre de la métrica de éxito. count: el número de veces que se ha visto esta métrica de éxito. total: el valor calculado de la métrica de éxito. sumOfSquares: contiene el valor "suma de cuadrados", que resulta útil para el cálculo extremo

de órdenes.

Note: La fórmula denominada "Campaign" en cada ejemplo muestra un resumen de esa muestra. Las respuestas incorrectas a una consulta usan la siguiente estructura XML: Invalid email or password supplied. Email: [email protected] 401

Etiqueta message

Descripción Una descripción del error. Por ejemplo: Invalid email or password supplied. Email: [email protected].

code

El código de error. Por ejemplo: 401.

Analizar la respuesta de la consulta Otra opción es utilizar un lenguaje de secuencia de comandos, como Perl, Python y Ruby, para analizar los resultados y escribirlos en un archivo de salida, como un archivo CSV, que se puede visualizar en cualquier aplicación de hoja de cálculo.

API de paso de perfiles y conversión sin conexión La API de paso de perfiles de terceros y de conversión sin conexión permite pasar mediante programación un perfil de usuario y asignar un ID de usuario de terceros a T&T. • Pasar un perfil de usuario: Use la API de paso de perfiles para pasar datos de segmentación de terceros a Test&Target (T&T) como atributos de perfil para definir el objetivo. Esto le permite utilizar Test&Target para dirigir el contenido en función de los datos de segmentación facilitados por los proveedores de análisis, siempre que se conozca el ID de T&T del usuario al que pertenecen los datos que se han pasado.

API de Test&Target

20

Note: La mejor opción es usar el ID de Test&Target, pero la API también admite el uso de ID de terceros (siempre que el ID esté guardado ya en Test&Target). Si necesita más información, póngase en contacto con su representante de cuentas. • Asignar un ID de usuario de terceros a T&T: Use la API de conversión sin conexión para asociar un ID de visitante guardado en su sistema a un ID de visitante de Test&Target. Al hacerlo, podrá agregar nueva información de perfil al perfil persistente Test&Target del visitante. Usar la API de paso de perfiles y de conversión sin conexión supone: • Pasar un perfil de usuario • Asigna un ID de usuario de terceros a T&T

Pasar un perfil de usuario Use la API de paso de perfiles para pasar datos de segmentación de terceros a Test&Target como atributos de perfil para definir el objetivo. Esto le permite utilizar Test&Target para dirigir el contenido en función de los datos de segmentación facilitados por los proveedores de análisis, siempre que se conozca el ID de T&T del usuario al que pertenecen los datos que se han pasado. 1. Crear la URL base. Por ejemplo: https://clientcode.tt.omtrdc.net/m2/clientcode/rest/standard

2. Incluir los parámetros para filtrar los resultados de la lista de campañas. Por ejemplo: https://clientcode.tt.omtrdc.net/m2/clientcode/rest/standard?mbox=confirmed_offline&mboxPC=XXX&mboxHost=offline.offermatica.com&mboxParam=value&profile.Name=value

Note: En los parámetros y valores se distingue entre mayúsculas y minúsculas. Parámetro clientCode mbox mboxPC

mboxHost mboxParam profile.Name

Descripción (Requerido) Código de cliente T&T válido. (Requerido) El nombre del mbox. (Requerido) El ID del perfil de T&T del usuario asociado a los datos de segmentos que se han pasado. (Opcional) El host del mbox. El valor predeterminado es offline.offermatica.com. (Opcional) Una lista de pares nombre/valor para pasar a mbox para dirigir el contenido. (Opcional) Una lista de pares nombre/valor en la que los nombres contienen el prefijo "profile.", que indica a T&T que almacene el par nombre/valor en el perfil de usuario.

3. Inspeccionar la respuesta de la consulta.

API de Test&Target

21

La respuesta a la consulta utiliza la siguiente estructura XML: true 124252

Etiqueta success

Descripción Indica el éxito o error de la consulta. true: éxito false: error.

pcId

El identificador único del usuario. Solo se muestra cuando success = true.

Asigna un ID de usuario de terceros a T&T El API de conversión sin conexión permite asignar un ID de perfil de terceros, un ID de pedido o cualquier otro ID explícitamente asociado a un usuario a un ID de perfil de T&T. Crea la asignación creando una solicitud mbox con el parámetro: mbox3rdPartyId=XXX

Por ejemplo: mboxCreate('application_submitted_online', 'mbox3rdPartyId=CA10021456');

T&T registra el ID de terceros cuando escribe el perfil en la base de datos (con una demora de 30 minutos aproximadamente). Después de registrar el ID, se puede utilizar la API para enviar más solicitudes y usar el ID de perfil de terceros en lugar del mboxId. Por ejemplo: https://clientcode.tt.omtrdc.net/m2/clientcode/rest/standard?mbox=confirmed_offline&mbox3rdPartyId=acmecorp&mboxHost=offline.omniture.com&mboxParam=value&profile.Name=value

Note: En los parámetros y valores se distingue entre mayúsculas y minúsculas. Parámetro clientCode mbox mbox3rdPartyId

mboxHost mboxParam

Descripción (Requerido) Código de cliente T&T válido. (Requerido) El nombre del mbox. (Requerido) El ID del perfil de terceros del usuario asociado a los datos de segmentos que se han pasado. (Opcional) El host del mbox. El valor predeterminado es offline.offermatica.com. (Opcional) Una lista de pares nombre/valor para pasar a mbox para dirigir el contenido.

API de Test&Target

Parámetro profile.Name

22

Descripción (Opcional) Una lista de pares nombre/valor en la que los nombres contienen el prefijo "profile.", que indica a T&T que almacene el par nombre/valor en el perfil de usuario.

API de ID de campaña de terceros La API de ID de campaña de terceros permite asociar un identificador de terceros a una campaña T&T. El uso de la API de ID de campaña de terceros supone: • Asociar el ID de terceros • Buscar una campaña por ID de terceros

Asociar el ID de terceros Puede asociar un ID de terceros a una campaña T&T únicamente cuando la campaña se crea mediante programación (consulte API de copia de campaña). Para ello, especifique el ID de terceros correspondiente en el elemento . Por ejemplo: Example REST Campaign extID501 ...

Buscar una campaña por ID de terceros 1. Crear la URL base. Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=pword

Parámetro client email password

Descripción (Requerido) El nombre de cliente T&T. (Requerido) La dirección de correo electrónico asociada al cliente T&T. (Requerido) La contraseña de cliente T&T.

Note: En los parámetros y valores se distingue entre mayúsculas y minúsculas. 2. Agregue parámetros de consulta para identificar la campaña T&T por su ID de terceros. Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=pword&operation=getCampaignId&campaign3rdPartyId=extID501

API de Test&Target

Parámetro operation

campaign3rdPartiId

23

Descripción (Requerido) Identifica el tipo de acción T&T que va a ejecutarse. Para buscar una campaña T&T, este valor es alwaysgetCampaignId. (Requerido) El ID de la campaña de terceros asociada a la campaña T&T.

API de creación de oferta de utilidades La API de creación de oferta de utilidades permite crear mediante programación una oferta de utilidades. Una oferta de utilidades es una URL que corresponde a una respuesta recuperada por T&T de un servidor de terceros. T&T almacena en caché una respuesta asociada a cada parámetro offerID, que sirve como clave. El uso de la API de creación de oferta de utilidades implica lo siguiente: • Crear la URL base • Agregar parámetros de consulta

Crear la URL base Por ejemplo: https://testandtarget.omniture.com/[email protected]&password=pword

Parámetro client email password

Descripción (Opcional) El código de cliente T&T. (Requerido) La dirección de correo electrónico asociada al cliente T&T. (Requerido) La contraseña de cliente T&T.

Note: En los parámetros y valores se distingue entre mayúsculas y minúsculas.

Agregar parámetros de consulta Agrega a cada operación los parámetros y valores necesarios para establecer el estado de la campaña T&T. Por ejemplo: https://admin.testandtarget.omniture.com/[email protected]&password=pword&operation

API de Test&Target

Parámetro operation

name

url

id

24

Descripción (Requerido) Identifica el tipo de acción T&T que va a ejecutarse. Para cambiar el estado de una campaña T&T, este valor es siempre saveWidgetOffer. (Requerido) El nombre de la oferta de utilidades, que se muestra en la lista de ofertas en la interfaz de administración. (Requerido) URL codificada del servidor de terceros que aloja la respuesta generada dinámicamente. T&T llama a esta URL y almacena en caché la respuesta resultante. (Requerido) El ID de terceros de la oferta de utilidades.

Cuando se crea correctamente una oferta de utilidades, T&T devuelve una respuesta XML que contiene el ID de terceros especificado. Por ejemplo: 999

Si se produce un error en la operación, T&T devuelve una respuesta XML que contiene un mensaje de error. Por ejemplo: Parameter 'id' should not be blank. 400