API de Data Warehouse - Adobe Marketing Cloud

Adobe© Digital Marketing Suite
API de Data Warehouse
Contents
API de Data Warehouse...........................................................................................3
Métodos de Data Warehouse..................................................................................................3
DataWarehouse.CancelRequest................................................................................................................3
DataWarehouse.CheckRequest.................................................................................................................3
DataWarehouse.CreateSegment...............................................................................................................4
DataWarehouse.GetReportData................................................................................................................4
DataWarehouse.GetSegment....................................................................................................................5
DataWarehouse.GetSegments..................................................................................................................5
DataWarehouse.ReplaceSegment.............................................................................................................6
DataWarehouse.Request...........................................................................................................................6
DataWarehouse.VerifySegment.................................................................................................................9
Tipos de datos personalizados...............................................................................................9
tns:data_warehouse_report.....................................................................................................................10
tns:data_warehouse_report_headings.....................................................................................................10
tns:data_warehouse_report_row..............................................................................................................10
tns:data_warehouse_report_row_list.......................................................................................................10
tns:data_warehouse_request...................................................................................................................10
tns:data_warehouse_segment.................................................................................................................13
tns:data_warehouse_segment_group......................................................................................................13
tns:data_warehouse_segment_rule.........................................................................................................15
tns:data_warehouse_segment_rule_list...................................................................................................17
tns:segment..............................................................................................................................................17
tns:segments............................................................................................................................................17
tns:segment_folder...................................................................................................................................17
tns:segment_folders.................................................................................................................................18
Código de ejemplo................................................................................................................18
Ejemplo de solicitud de cancelación de Data Warehouse........................................................................18
Ejemplo de solicitud de comprobación de Data Warehouse....................................................................18
Ejemplo de creación de segmentos de Data Warehouse........................................................................19
Ejemplo de solicitud de Data Warehouse.................................................................................................20
Last updated 2/21/2012
API de Data Warehouse
API de Data Warehouse
3
API de Data Warehouse
Data Warehouse le permite solicitar informes para mostrar las relaciones de datos avanzadas de los datos sin
procesar basándose en sus propias preguntas. Por ejemplo: puede utilizar Data Warehouse para informar las
páginas de salida de los visitantes que compraron un cierto artículo en el sitio.
Los informes de Data Warehouse se envían por correo electrónico o FTP y su procesamiento puede llevar 72 horas
o más, dependiendo de la complejidad de la consulta y la cantidad de datos solicitada.
Note: Adobe no ofrece Acuerdos de nivel de servicio (SLA, Service Level Agreements) ni se compromete
en lo que respecta al nivel de servicio en relación con los segmentos de Data Warehouse.
Métodos de Data Warehouse
La API de Data Warehouse 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.
DataWarehouse.CancelRequest
Cancela un segmento de Data Warehouse solicitado anteriormente.
Parámetros de DataWarehouse.CancelRequest
Parámetro
Tipo
Request_Id
xsd:int
Descripción
El ID de solicitud de Data Warehouse que se cancelará.
Respuesta DataWarehouse.CancelRequest
Tipo
Descripción
xsd:string
Confirma la cancelación de la solicitud de segmento de Data Warehouse.
DataWarehouse.CheckRequest
Envía una solicitud de informe una sola vez que se entregará por correo electrónico o FTP.
Parámetros de DataWarehouse.CheckRequest
Parámetro
Tipo
Request_Id
xsd:int
Descripción
El ID de solicitud de Data Warehouse para el cual se devuelve
el estado.
Solo puede comprobar el estado de una solicitud que usted
haya enviado.
API de Data Warehouse
4
Respuesta DataWarehouse.CheckRequest
Tipo
Descripción
tns:data_warehouse_request
Una estructura que contiene información sobre el segmento de datos especificado. Si el
Request_Id especificado no contiene ningún dato, el método devuelve la siguiente
respuesta:
Empty data set. No data for Request ID <Request_Id>.
DataWarehouse.CreateSegment
Crea una definición de segmento que determina los datos del conjunto de informes que el Data Warehouse incluye
en el nuevo segmento de Data Warehouse.
Parámetros de DataWarehouse.CreateSegment
Parámetro
Tipo
Descripción
rsid
xsd:int
segment
tns:data_warehouse_segment
El conjunto de informes utilizado para generar el segmento.
La definición de segmento utilizada para definir el nuevo
segmento.
Respuesta DataWarehouse.CreateSegment
Tipo
Descripción
xsd:int
Un ID único de segmento para el nuevo segmento. Si se produce un error al crear el
segmento, el marco SOAP devuelve un error de entorno que describe el error.
DataWarehouse.GetReportData
Indica al Data Warehouse que recupere un archivo de segmento que una llamada a DataWarehouse.Request
creó anteriormente usando el parámetro send_via_api.
Parámetros de DataWarehouse.GetReportData
Parámetro
Tipo
Request_Id
xsd:int
rsid
xsd:string
start_row
xsd:int
Descripción
El identificador de solicitud que devuelve la llamada a
DataWarehouse.Request .
El conjunto de informes asociado a la solicitud de Data Warehouse.
Este parámetro no está en uso actualmente. Especifique un valor de 0
o 1.
API de Data Warehouse
5
Respuesta DataWarehouse.GetReportData
Tipo
Descripción
tns:data_warehouse_report
Una tabla que contiene la llamada a DataWarehouse.Request especificada.
DataWarehouse.GetSegment
Crea un filtro de segmentos que determina los datos de conjuntos de informes que Data Warehouse incluirá en la
respuesta de archivos de datos para una solicitud de Data Warehouse.
Parámetros de DataWarehouse.GetSegment
Parámetro
Tipo
Descripción
rsid
xsd:int
segment
xsd:int
El conjunto de informes usado para generar el segmento.
El ID de segmento. Data Warehouse genera este valor después
de crear un nuevo segmento.
Respuesta DataWarehouse.GetSegment
Tipo
Descripción
tns:data_warehouse_segment
Una estructura que contiene los datos de segmento de Data Warehouse.
DataWarehouse.GetSegments
Recupera segmentos de un Data Warehouse para el intervalo de fechas especificado.
Parámetros de DataWarehouse.GetSegments
Parámetro
Tipo
Descripción
rsid
xsd:int
start_date
xsd:date
end_date
xsd:date
El ID de conjunto de informes en el que se desea generar un
segmento de Data Warehouse.
La fecha de inicio del segmento de Data Warehouse.
La fecha de fin del segmento de Data Warehouse.
Respuesta DataWarehouse.GetSegments
Tipo
Descripción
tns:segment_folders
Una lista de segmentos para el intervalo de fechas especificado.
API de Data Warehouse
6
DataWarehouse.ReplaceSegment
Elimina el segmento de Data Warehouse especificado y crea un nuevo segmento de Data Warehouse de la estructura
especificada.
Parámetros de DataWarehouse.ReplaceSegment
Parámetro
Tipo
Descripción
id
xsd:int
rsid
xsd:int
segment
tns:data_warehouse_segment
El ID del segmento que se eliminará. Data Warehouse proporciona
este valor en la respuesta a una operación de creación de segmento.
El conjunto de informes usado para crear el nuevo segmento.
La definición del segmento usada para definir el conjunto de datos del
segmento nuevo.
Respuesta DataWarehouse.ReplaceSegment
Tipo
Descripción
xsd:int
Un identificador único de segmento para el nuevo segmento.
Si se produce un error al crear el segmento, el marco SOAP devuelve un error de entorno
que describe el error.
DataWarehouse.Request
Envía una solicitud de informe una sola vez que se entregará por correo electrónico o FTP.
Parámetros de DataWarehouse.Request
Parámetro
Tipo
rsid
xsd:string
Contact_Name
xsd:string
Contact_Phone
xsd:string
Email_To
xsd:string*
Descripción
El ID del conjunto de informes que se utilizará con la solicitud
de Data Warehouse. El conjunto de informes debe tener
habilitado Data Warehouse y el usuario necesita tener
derechos en el conjunto de informes.
El nombre de la persona que realiza la solicitud de Data
Warehouse.
El número de teléfono de la persona que realiza la solicitud
de Data Warehouse.
La dirección de correo electrónico en la que se desea que
Data Warehouse envíe el archivo de datos. El modo de envío
API de Data Warehouse
Parámetro
7
Tipo
Descripción
predeterminado es el correo electrónico, pero también se
puede utilizar el FTP si se desea.
Email_Subject
xsd:string
Report_Name
xsd:string
Report_Description
xsd:string
File_Name
xsd:string
Date_Type
xsd:string
El texto que Data Warehouse incluye en la línea de asunto
del correo electrónico.
El nombre de solicitud de Data Warehouse tal como se desea
que aparezca en el correo electrónico.
(Opcional) Una descripción de la solicitud de Data Warehouse
tal como se desea que aparezca en el correo electrónico.
(Opcional) El nombre del archivo de datos que contiene los
resultados de la solicitud de Data Warehouse. Por ejemplo,
especifique DW_Data para devolver un archivo de datos con
el nombre DW_Data.csv.
El tipo de intervalo de datos utilizado con la solicitud de Data
Warehouse. Los valores admitidos son:
range: Especifica que se desea utilizar un intervalo de datos
personalizado. Para ello, especifique la fecha de inicio del
informe utilizando el parámetro Date_From y la fecha de fin,
usando el parámetro Date_To.
preset: Especifica que se desea utilizar un intervalo de fechas
predefinido. Para ello, especifique la fecha predefinida del
informe usando el parámetro Date_Preset.
Date_Preset
xsd:string
(Opcional) El intervalo de fechas predefinido que se usará
con la solicitud del Data Warehouse. Especifique este
parámetro cuando Date_Type = preset.
Los valores admitidos son los siguientes (se distingue entre
mayúsculas y minúsculas): Last month, Last week, Last 2
weeks, Last 4 weeks, Last 7 days, Last 30 days, This
month, This week, Today, Yesterday.
Date_To
xsd:string
(Opcional) La fecha de fin del intervalo de fechas
personalizado para la solicitud de Data Warehouse.
Especifique este parámetro cuando Date_Type = range.
Los valores de fecha deben usar el formato MM/DD/YY.
API de Data Warehouse
8
Parámetro
Tipo
Date_From
xsd:string
Descripción
(Opcional) La fecha de inicio del intervalo de fechas
personalizado para la solicitud de Data Warehouse.
Especifique este parámetro cuando Date_Type = range.
Los valores de fecha deben usar el formato MM/DD/YY.
Date_Granularity
xsd:string
El grado de detalle de la solicitud de Data Warehouse.
Los valores admitidos son los siguientes: none, hour, day,
week, month, quarter, year.
Segment_Id
xsd:int
Metric_List
array(xsd:string)
Breakdown_List
array(xsd:string)
FTP_Host
xsd:string
(Opcional) El segmento que se usará con esta solicitud de
Data Warehouse. Este valor debe ser un ID de segmento
global válido. Use DataWarehouse.GetSegments para obtener
una lista de ID de segmento válidos.
(Opcional) Las métricas que se incluirán en la solicitud de
Data Warehouse. Una solicitud válida debe contener al menos
una métrica o un desglose.
UseReportSuite.GetAvalableMetrics para obtener una lista
de las métricas disponibles para este conjunto de informes.
(Opcional) El desglose que se incluirá en la solicitud de Data
Warehouse. Una solicitud válida debe contener al menos una
métrica o un desglose. UseReportSuite.GetAvalableElements
para obtener una lista de los desgloses disponibles para un
conjunto de informes.
(Opcional) La ubicación de entrega del segmento de Data
Warehouse. Los valores admitidos son:
Leave Blank: No especifique ningún valor para este parámetro
si desea que Data Warehouse entregue el archivo de
segmento por correo electrónico. El correo electrónico es el
modo de entrega predeterminado.
FTP Host Name: Especifique un nombre de host FTP para
que Data Warehouse entregue el segmento por FTP.
send_via_api: Especifique el valor send_via_api para que
Data Warehouse entregue el segmento utilizando su interfaz
REST. En este caso, cuando el segmento concluye,
DataWarehouse.CheckRequest proporciona la URL de REST
en la que se puede descargar el segmento.
FTP_Port
xsd:int
(Opcional) El número de puerto FTP.
API de Data Warehouse
9
Parámetro
Tipo
Descripción
FTP_Dir
xsd:string
FTP_UserName
xsd:string
FTP_Password
xsd:string
(Opcional) El directorio del FTP en el que Data Warehouse
deja el archivo de datos (Por ejemplo, /reports/here).
(Opcional) Nombre de usuario utilizado para iniciar sesión en
el servidor FTP especificado en FTP_Host.
(Opcional) Contraseña correspondiente al usuario de FTP
especificado en FTP_UserName.
Respuesta DataWarehouse.Request
Tipo
Descripción
xsd:int
El ID de solicitud que los servidores Adobe asignan a esta solicitud de Data Warehouse.
DataWarehouse.VerifySegment
Verifica la definición del segmento especificado sin crear un segmento de Data Warehouse nuevo.
Resulta útil para comprobar la sintaxis del segmento antes de crear el segmento nuevo en Data Warehouse.
Parámetros de DataWarehouse.VerifySegment
Parámetro
Tipo
Descripción
segment
tns:data_warehouse_segment
La definición del segmento que hay que verificar.
Respuesta DataWarehouse.VerifySegment
Tipo
Descripción
xsd:boolean
Devuelve True si la sintaxis del filtro de segmentos es válida. De lo contrario, devuelve un
error de entorno en el primer error de sintaxis en la definición del segmento.
Tipos de datos personalizados
La API de Data Warehouse 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:
API de Data Warehouse
10
• 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:data_warehouse_report
Estructura de datos que contiene información sobre un informe de Data Warehouse.
Nombre
Tipo
Descripción
start_row
xsd:int
end_row
xsd:int
headings
tns:data_warehouse_report_headings
row
tns:data_warehouse_report_row_list
finished
xsd:boolean
La primera fila de datos que se incluirá en el informe. Este valor
debe ser siempre 1.
La última fila de datos que se incluirá en el informe. Este valor
debe ser siempre igual al número de elementos de row_list.
Una lista de encabezados de columna de este informe.
Una lista de filas de datos de este informe.
Este elemento no está actualmente habilitado, por lo que siempre
devuelve True.
Indica que hay más datos disponibles (un informe paginado).
tns:data_warehouse_report_headings
Una matriz de xsd:string.
tns:data_warehouse_report_row
Una matriz de xsd:string.
tns:data_warehouse_report_row_list
Una matriz de tns:data_warehouse_report_row .
tns:data_warehouse_request
Estructura de datos que contiene las opciones de configuración para una fuente de datos de procesamiento completo.
Nombre
status
Tipo
Descripción
xsd:int
Un código que representa el estado del segmento de datos. Los
valores de estado admitidos son:
API de Data Warehouse
Nombre
11
Tipo
Descripción
Código
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Mensaje
Esperando para comenzar (se ha creado la
solicitud y se están valorando las necesidades de
procesamiento)
En curso
Finalizado
Detenido
Cancelado
Error
Esperando para comenzar (se ha asignado el
servidor y se está esperando a que el servidor
inicie el procesamiento)
Demasiado grande
Esperando para comenzar (se ha terminado la
valoración y se espera a que haya un servidor
disponible)
Esperando los datos
Esperando a enviar
Esperando a verificar
Esperando a enviar
Enviado a producto
Enviando
Esperando para continuar (desaprobado)
Esperando para continuar (desaprobado)
Continuando
API de Data Warehouse
Nombre
12
Tipo
Descripción
Código
18
mensaje
filesize
data_url*
Mensaje
No entregado
xsd:string
Una breve descripción del parámetro de estado. La cadena de
mensaje se presenta arriba, junto al código de estado.
xsd:string
Solo se rellena cuando status = 2. El tamaño del segmento de
datos solicitados, en MB.
xsd:string
Solo se rellena cuando status = 2. Contiene la URL en la que
se puede descargar el segmento de datos completado.
*Una vez completado un segmento de datos, el valor de data_url en una solicitud HTTP GET para recuperar el
segmento de datos. Cuando se solicita un segmento de datos mediante data_url, hay que facilitar las credenciales
de Online Marketing Suite igual que se haría al usar cualquier otra llamada de API de Online Marketing Suite. Si
desea más información sobre WSSE, consulte <<Autenticación de servicios Web>>.
El siguiente código de ejemplo muestra cómo usar cURL* para generar la solicitud GET desde una estación de
trabajo Linux:
curl "<Genesis REST URL>" -H "$(php <wsse.php> <username> <secret>)
Una solicitud REST correcta incluye los componentes siguientes:
Nombre
data URL
username
secret
wsse.php
Descripción
La URL asociada a un segmento de datos específico (por ejemplo,
https://api.omniture.com/rest/?id=123456).
El nombre de usuario de Online Marketing Suite.
La clave secreta (contraseña) para Online Marketing Suite.
Un archivo de secuencias de comandos que contiene los datos de autenticación WSSE para la
solicitud de Data Warehouse. Este archivo debe tener la siguiente forma:
#!/usr/local/bin/php
<?
date_default_timezone_set('America/Denver');
$mode='header';
if ($argv[1] == '-q') {
$mode='qs';
array_shift($argv);
}
$username = $argv[1];
$secret = $argv[2];
$created = date('c');
$nonce = md5(rand(), true);
API de Data Warehouse
Nombre
13
Descripción
$base64_nonce = base64_encode($nonce);
$password_digest = base64_encode(sha1($nonce.$created.$secret, true));
if ($mode == 'header') {
echo "X-WSSE: UsernameToken Username=\"$username\",
PasswordDigest=\"$password_digest\", Nonce=\"$base64_nonce\",
Created=\"$created\"";
} else {
echo http_build_query(array(
'auth_digest' => $password_digest,
'auth_nonce' => $base64_nonce,
'auth_created' => $created,
'auth_username' => $username,
));
}
tns:data_warehouse_segment
Estructura de datos que contiene las opciones de configuración para una fuente de datos de procesamiento completo.
Nombre
Tipo
name
xsd:string
Descripción
Un nombre descriptivo para el segmento de Data
Warehouse.
El nombre no puede superar los 255 caracteres.
group_include
tns:data_warehouse_segment_group
group_exclude
tns:data_warehouse_segment_group
Especifica datos que deben incluirse
explícitamente en el archivo de datos. Aunque
debe incluir el elemento group_include, puede
dejarlo vacío si no quiere usar una regla de
inclusión.
Especifica los datos que deben excluirse
explícitamente del archivo de datos. Aunque
debe incluir el elemento group_exclude, puede
dejarlo vacío si no quiere usar una regla de
exclusión.
tns:data_warehouse_segment_group
Una estructura (llamada Grupo) que contiene reglas, e información sobre la combinación de estas reglas, para crear
una definición de segmento.
Nombre
Tipo
type
xsd:string
Descripción
Especifica el tipo de segmento. Los valores admitidos, en los que
se distingue entre mayúsculas y minúsculas, son:
API de Data Warehouse
Nombre
14
Tipo
Descripción
ROOT: El grupo de segmentos de nivel superior. El grupo de
segmentos de nivel superior debe ser ROOT.
VISITOR: Contenedor de los cálculos de visitante.
VISIT: Contenedor de los cálculos de visita.
PAGE: Contenedor de los cálculos de página.
EVENT: Contenedor de eventos.
name
xsd:string
El nombre de grupo del segmento. El nombre de grupo de
segmentos de nivel superior debe ser Include. A los grupos de
segmentos animados se les puede dar un nombre que consista
en una cadena descriptiva.
El nombre no puede superar los 255 caracteres.
group_operator
xsd:string
Operador booleano usado para combinar grupos en el parámetro
group_list. Los valores admitidos son:
AND: Combina grupos usando el operador booleano AND.
OR: Combina grupos usando el operador booleano OR.
rule_operator
xsd:string
Operador booleano usado para combinar reglas en el parámetro
rule_list. Los valores admitidos son:
AND: Combina grupos usando el operador booleano AND.
OR: Combina grupos usando el operador booleano OR.
rule_list
tns:data_warehouse_segment_rule_list
Una lista de reglas combinadas por el objeto Group. Las siguientes
restricciones se aplican a las listas de reglas de los grupos de
segmento:
• La lista de reglas de un grupo de segmentos ROOT no puede
contener ninguna regla.
• La lista de reglas de un grupo de segmentos EVENT puede
contener exactamente una regla de estilo EVENT.
• La lista de reglas EVENT puede contener todas las reglas de
estilo diferente a EVENT que se quiera.
group_list
tns:data_warehouse_segment_group_list
Una lista de grupos de segmentos contenida en este grupo. Para
la anidación de grupos de segmentos se aplican las siguientes
restricciones:
• Un grupo ROOT debe ser el objeto de grupo superior y no puede
tener un objeto principal.
API de Data Warehouse
Nombre
15
Tipo
Descripción
• Un grupo EVENT no puede tener un elemento principal de tipo
EVENT.
• Un grupo VISIT no puede tener un elemento principal de tipo
PAGE, VISIT ni EVENT.
• Un grupo VISITOR no puede tener un elemento principal de tipo
PAGE, VISIT, VISITOR ni EVENT.
• Un grupo PAGE no puede tener un elemento principal de tipo
PAGE ni EVENT.
tns:data_warehouse_segment_rule
Una estructura que define una sola regla de segmento.
Nombre
Tipo
operator
xsd:string
Descripción
El operador booleano usado para esta regla. Los valores admitidos son los
siguientes: También puede dejar operator en blanco.
= (igual a)
!= (no es igual a)
> (mayor que)
< (menor que)
>= (mayor que o igual a)
<= (menor que o igual a)
NOT CONTAINS (no contiene)
CONTAINS ALL OF (contiene todo)
NOT CONTAINS ALL OF (no contiene todo)
CONTAINS ONE OF (contiene alguno)
NOT CONTAINS ONE OF (no contiene ninguno)
type
xsd:string
Propiedad que se usará para la comparación de reglas. Por ejemplo, column.
El tipo no puede superar los 100 caracteres.
value
xsd:string
Valor que se usará para la comparación de reglas.
El valor no puede superar los 255 caracteres.
event
xsd:int
El ID del evento que se desea escuchar. Al crear una regla de evento, se deben
observar las siguientes convenciones:
API de Data Warehouse
Nombre
16
Tipo
Descripción
- Cuando se especifica un evento, todos los demás valores (operator, type y
value) deben dejarse en blanco (una cadena de caracteres 0 o un valor NULL).
- Cuando no se especifica un evento, el valor event debe dejarse en blanco
(una cadena de caracteres 0 o un valor NULL). - Las reglas de evento deben
estar contenidas en una rule_list de un grupo de segmentos de tipo EVENT.
El parámetro event acepta los siguientes valores admitidos:
ID de evento
1
2
10
11
12
13
14
20
100
101
102
103
104
105
106
107
108
Descripción
PURCHASE
PRODUCT_VIEW
SHOPPING_CART_OPEN
SHOPPING_CART
SHOPPING_CART_ADD
SHOPPING_CART_REMOVE
SHOPPING_CART_VIEW
Instancia de campaña
Instancia de la eVar1
Instancia de la eVar2
Instancia de la eVar3
Instancia de la eVar4
Instancia de la eVar5
Instancia de la eVar6
Instancia de la eVar7
Instancia de la eVar8
Instancia de la eVar9
API de Data Warehouse
Nombre
17
Tipo
Descripción
ID de evento
Descripción
109
Instancia de la eVar10
110
Instancia de la eVar11
111
Instancia de la eVar12
tns:data_warehouse_segment_rule_list
Una matriz de tns:data_warehouse_segment_rule .
tns:segment
Estructura de datos que contiene un solo segmento de datos.
Nombre
Tipo
id
xsd:string
name
xsd:string
definition
xsd:string
Descripción
El identificador único de segmento.
El nombre de segmento.
La definición de segmento usada para especificar los datos que
se incluirán en este segmento.
tns:segments
Una matriz de tns:segment .
tns:segment_folder
Estructura de datos que contiene información sobre una colección de segmentos de datos.
Nombre
Tipo
namespace
xsd:string
folder_name
xsd:string
segments
tns:segments
Descripción
El espacio de nombre asociado a esta carpeta de segmentos.
El nombre de la carpeta de segmentos.
Una lista de segmentos asociados a la carpeta de segmentos.
API de Data Warehouse
18
tns:segment_folders
Una matriz de tns:segment_folder .
Código de ejemplo
La API de Data Warehouse incluye estos códigos de ejemplo.
El siguiente código se proporciona únicamente para fines de demostración. Utilice sus propios valores, nombres,
ubicaciones de archivos, etcétera, al preparar el código de su empresa.
Ejemplo de solicitud de cancelación de Data Warehouse
Un ejemplo de llamada al método DataWarehouse.CancelRequest y la respuesta asociada.
Solicitud DataWarehouse.CancelRequest
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:omn="http://www.omniture.com/">
<soapenv:Header/>
<soapenv:Body>
<omn:DataWarehouse.CancelRequest
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<Request_Id xsi:type="xsd:int">69760</Request_Id>
</omn:DataWarehouse.CancelRequest>
</soapenv:Body>
</soapenv:Envelope>
Respuesta DataWarehouse.CancelRequest
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:DataWarehouse.CancelRequestResponse xmlns:ns1="http://www.omniture.com/">
<return xsi:type="xsd:string">Request Cancelled</return>
</ns1:DataWarehouse.CancelRequestResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Ejemplo de solicitud de comprobación de Data Warehouse
Un ejemplo de llamada al método DataWarehouse.CheckRequest y la respuesta asociada.
Solicitud DataWarehouse.CheckRequest
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:omn="http://www.omniture.com/">
<soapenv:Header/>
<soapenv:Body>
<omn:DataWarehouse.CheckRequest
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<Request_Id xsi:type="xsd:int">669</Request_Id>
</omn:DataWarehouse.CheckRequest>
API de Data Warehouse
19
</soapenv:Body>
</soapenv:Envelope>
Respuesta DataWarehouse.CheckRequest
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:DataWarehouse.CheckRequestResponse xmlns:ns1="http://www.omniture.com/">
<return xsi:type="xsd:string">Complete</return>
</ns1:DataWarehouse.CheckRequestResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Ejemplo de creación de segmentos de Data Warehouse
Un ejemplo de llamada al método DataWarehouse.CreateSegment y la respuesta asociada.
Solicitud DataWarehouse.CreateSegment
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:omn="http://www.omniture.com/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:sopenc="sopenc">
<soapenv:Header/>
<soapenv:Body>
<omn:DataWarehouse.CreateSegment
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<rsid xsi:type="xsd:string">my_report_suite</rsid>
<segment xsi:type="omn:data_warehouse_segment">
<!--You may enter the following 3 items in any order-->
<name xsi:type="xsd:string">SOAP API Event Test Segment</name>
<group_include xsi:type="omn:data_warehouse_segment_group">
<!--You may enter the following 6 items in any order-->
<type xsi:type="xsd:string">ROOT</type>
<name xsi:type="xsd:string">Include</name>
<group_operator xsi:type="xsd:string">UNKNOWN</group_operator>
<rule_operator xsi:type="xsd:string">AND</rule_operator>
<rule_list xsi:type="omn:data_warehouse_segment_rule_list"
soapenc:arrayType="omn:data_warehouse_segment_rule[]"/>
<group_list xsi:type="omn:data_warehouse_segment_group_list"
soapenc:arrayType="omn:data_warehouse_segment_group[]">
<item xsi:type="mon:data_warehouse_segment_group">
<type xsi:type="xsi:string">VISIT</type>
<name xsi:type="xsi:string">Visit</name>
<group_operator xsi:type="xsd:string">UNKNOWN</group_operator>
<rule_operator xsi:type="xsd:string">AND</rule_operator>
<group_list xsi:type="omn:data_warehouse_segment_group_list"
sopenc:arrayType="omn:data_warehouse_segment_group[]">
<item xsi:type="omn:data_warehouse_segment_group">
<type xsi:type="xsd:string">EVENT</type>
<name xsi:type="xsd;string">Checkout</name>
<group_operator xsi:type="xsd:string">UNKNOWN</group_operator>
<rule_operator xsi:type="xsd:string">AND</rule_operator>
<rule_list xsi:type="omn:data_warehouse_segment_rule_list"
soapenc:arrayType="omn:data_warehouse_segment_rule[]">
<item xsi:type="tns:data_warehouse_segment_rule">
<operator xsi:type="xsd:string"/>
<item xsi:type="xsd:string"/>
<value xsi:type="xsd:string"/>
<event xsi:type="xsd:int">11</event>
</item>
</rule_list>
API de Data Warehouse
20
<group_list xsi:type="omn:data_warehouse_segment_group_list"
soapenc:arrayType="omn:data_warehouse_segment_group[]"/>
</item>
</group_list>
<rule_list xsi:type="omn:data_warehouse_segment_rule_list"
soapenc:arrayType="omn:data_warehouse_segment_rule[]"/>
</item>
</group_list>
</group_include>
<group_exclude xsi:type="omn:data_warehouse_segment_group">
<!--You may enter the following 6 items in any order-->
<type xsi:type="xsd:string">ROOT</type>
<name xsi:type="xsd:string">Exclude</name>
<group_operator xsi:type="xsd:string">UNKNOWN</group_operator>
<rule_operator xsi:type="xsd:string">AND</rule_operator>
<rule_list xsi:type="omn:data_warehouse_segment_rule_list"
soapenc:arrayType="omn:data_warehouse_segment_rule[]"/>
<group_list xsi:type="omn:data_warehouse_segment_group_list"
soapenc:arrayType="omn:data_warehouse_segment_group[]"/>
</group_exclude>
</segment>
</omn:DataWarehouse.CreateSegment>
</soapenv:Body>
</soapenv:Envelope>
Ejemplo de solicitud de Data Warehouse
Un ejemplo de llamada al método DataWarehouse.Request y la respuesta asociada.
Solicitud DataWarehouse.Request
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:omn="http://www.omniture.com/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<omn:DataWarehouse.Request soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<Breakdown_List xsi:type="omn:string_array" soapenc:arrayType="xsd:string[]">
<item xsi:type="xsd:string">browser_height</item>
</Breakdown_List><Contact_Name xsi:type="xsd:string">John Jones</Contact_Name>
<Contact_Phone xsi:type="xsd:string">801-888-8888</Contact_Phone>
<Contact_Name xsi:type="xsd:string">John Jones</Contact_Name>
<Contact_Phone xsi:type="xsd:string">801-000-0000</Contact_Phone>
<Date_Granularity xsi:type="xsd:string">none</Date_Granularity>
<Date_Preset xsi:type="xsd:string">Yesterday</Date_Preset>
<Date_Type xsi:type="xsd:string">preset</Date_Type>
<Email_Subject xsi:type="xsd:string">Periodic Revenue</Email_Subject>
<Email_To xsi:type="xsd:string">[email protected]</Email_To>
<File_Name>xsi:type="xsd:string">Report</File_Name>
<Metric_List xsi:type="omn:string_array" soapenc:arrayType="xsd:string[2]">
<item xsi:type="xsd:string">revenue</item>
<item xsi:type="xsd:string">page_views</item>
</Metric_List>
<Report_Description xsi:type="xsd:string">My API Request</Report_Description>
<Report_Name xsi:type="xsd:string">Periodic Revenue</Report_Name>
<Segment_Id xsi:type="xsd:int">729</Segment_Id>
<rsid xsi:type="xsd:string">reportSuite00000</rsid>
</omn:DataWarehouse.Request>
</soapenv:Body>
</soapenv:Envelope>
Respuesta DataWarehouse.Request
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
API de Data Warehouse
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:DataWarehouse.RequestResponse xmlns:ns1="http://www.omniture.com/">
<Request_Id xsi:type="xsd:int">669</Request_Id>
</ns1:DataWarehouse.RequestResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
21