API Data Warehouse - Adobe Marketing Cloud

Transcription

API Data Warehouse - Adobe Marketing Cloud
Adobe© Digital Marketing Suite
API Data Warehouse
Contents
API Data Warehouse................................................................................................3
Méthodes 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
Types de données personnalisés............................................................................................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
Exemple de code...................................................................................................................18
Exemple de demande d'annulation Data Warehouse..............................................................................18
Exemple de demande de vérification Data Warehouse............................................................................18
Exemple de création d'un segment Data Warehouse..............................................................................19
Exemple de demande Data Warehouse...................................................................................................20
Last updated 2/22/2012
API Data Warehouse
API Data Warehouse
3
API Data Warehouse
L'API Data Warehouse vous permet de demander des rapports qui affichent un niveau avancé de relations entre
les données brutes, en fonction de vos questions particulières. Par exemple, vous pouvez utiliser l'API Data
Warehouse pour générer un rapport sur les pages de sortie des visiteurs qui achètent un article donné sur votre
site.
Les rapports Data Warehouse sont envoyés par courrier électronique ou par FTP. Leur traitement peut prendre
72 heures, voire davantage, suivant la complexité de la requête et le volume de données à traiter.
Note: Adobe ne propose pas d'accords sur les niveaux de service (SLA) et ne fait aucune déclaration de
niveau de service pour ce qui concerne les segments Data Warehouse.
Méthodes Data Warehouse
L'API Data Warehouse comprend les méthodes suivantes.
Créez des appels de méthode SOAP et REST à l'aide des paramètres et du nom de la méthode décrits ici. Pour
plus d'informations sur l'utilisation des services Web avec SOAP et REST, reportez-vous à la section Mise en
route.
DataWarehouse.CancelRequest
Annule un segment Data Warehouse demandé précédemment.
Paramètres DataWarehouse.CancelRequest
Paramètre
Type
Request_Id
xsd:int
Description
Identifiant de la demande Data Warehouse à annuler.
Réponse DataWarehouse.CancelRequest
Type
Description
xsd:string
Confirme l'annulation de la demande de segment Data Warehouse.
DataWarehouse.CheckRequest
Envoie une demande de rapport unique à distribuer par courrier électronique ou FTP.
Paramètres DataWarehouse.CheckRequest
Paramètre
Type
Request_Id
xsd:int
Description
Identifiant de la demande Data Warehouse pour laquelle un
état doit être renvoyé.
API Data Warehouse
4
Paramètre
Type
Description
Vous pouvez uniquement vérifier l'état d'une demande que
vous avez envoyée.
Réponse DataWarehouse.CheckRequest
Type
Description
tns:data_warehouse_request
Structure contenant des informations sur le segment de données spécifié. Si le Request_Id
spécifié ne contient aucune donnée, la méthode renvoie la réponse suivante :
Empty data set. No data for Request ID <Request_Id>.
DataWarehouse.CreateSegment
Crée une définition de segment qui détermine les données de suite de rapports que l'API Data Warehouse inclut
dans le nouveau segment Data Warehouse.
Paramètres DataWarehouse.CreateSegment
Paramètre
Type
Description
rsid
xsd:int
segment
tns:data_warehouse_segment
Suite de rapports utilisée pour générer le segment.
Définition de segment utilisée pour définir le nouveau segment.
Réponse DataWarehouse.CreateSegment
Type
Description
xsd:int
Identifiant unique pour le nouveau segment. En cas d'échec de la création du segment, la
structure SOAP renvoie une anomalie d'environnement décrivant l'erreur.
DataWarehouse.GetReportData
Indique à l'API Data Warehouse de récupérer un fichier de segment créé précédemment par un appel
DataWarehouse.Request à l'aide du paramètre send_via_api.
Paramètres DataWarehouse.GetReportData
Paramètre
Type
Request_Id
xsd:int
rsid
xsd:string
start_row
xsd:int
Description
Identifiant de demande renvoyé par l'appel DataWarehouse.Request .
Suite de rapports associée à la demande Data Warehouse.
Pour l'heure, ce paramètre n'est pas utilisé. Indiquez une valeur 0 ou 1.
API Data Warehouse
5
Réponse DataWarehouse.GetReportData
Type
Description
tns:data_warehouse_report
Tableau contenant l'appel DataWarehouse.Request spécifié.
DataWarehouse.GetSegment
Crée un filtre de segment qui détermine les données de suite de rapports que l'API Data Warehouse inclut dans sa
réponse à une demande Data Warehouse.
Paramètres DataWarehouse.GetSegment
Paramètre
Type
Description
rsid
xsd:int
segment
xsd:int
Suite de rapports utilisée pour générer le segment.
Identifiant du segment. L'API Data Warehouse génère cette
valeur après avoir créé un segment.
Réponse DataWarehouse.GetSegment
Type
Description
tns:data_warehouse_segment
Structure contenant les données du segment Data Warehouse.
DataWarehouse.GetSegments
Récupère des segments Data Warehouse pour la période spécifiée.
Paramètres DataWarehouse.GetSegments
Paramètre
Type
Description
rsid
xsd:int
start_date
xsd:date
end_date
xsd:date
Identifiant de la suite de rapports dans laquelle vous souhaitez
générer un segment Data Warehouse.
Date de début du segment Data Warehouse.
Date de fin du segment Data Warehouse.
Réponse DataWarehouse.GetSegments
Type
Description
tns:segment_folders
Liste de segments pour la période spécifiée.
API Data Warehouse
6
DataWarehouse.ReplaceSegment
Supprime le segment Data Warehouse spécifié et crée un segment de la structure indiquée.
Paramètres DataWarehouse.ReplaceSegment
Paramètre
Type
Description
id
xsd:int
rsid
xsd:int
segment
tns:data_warehouse_segment
Identifiant du segment à supprimer. L'API Data Warehouse fournit
cette valeur dans la réponse afin de créer une opération de
segmentation.
Suite de rapports utilisée pour créer le segment.
Définition de segment utilisée pour définir le jeu de données du
nouveau segment.
Réponse DataWarehouse.ReplaceSegment
Type
Description
xsd:int
Identifiant unique pour le nouveau segment.
En cas d'échec de la création du segment, la structure SOAP renvoie une anomalie
d'environnement décrivant l'erreur.
DataWarehouse.Request
Envoie une demande de rapport unique à distribuer par courrier électronique ou FTP.
Paramètres DataWarehouse.Request
Paramètre
Type
rsid
xsd:string
Contact_Name
xsd:string
Contact_Phone
xsd:string
Email_To
xsd:string*
Description
Identifiant de la suite de rapports à utiliser avec la demande
Data Warehouse. Data Warehouse doit être activé sur la suite
de rapports et vous devez disposer des privilèges sur cette
suite.
Nom de la personne à l'origine de la demande Data
Warehouse.
Numéro de téléphone de la personne à l'origine de la demande
Data Warehouse.
Adresse électronique à laquelle l'API Data Warehouse doit
envoyer le fichier de données. La messagerie électronique
API Data Warehouse
Paramètre
7
Type
Description
constitue le mécanisme de distribution par défaut. Cependant,
vous pouvez également utiliser FTP.
Email_Subject
xsd:string
Report_Name
xsd:string
Report_Description
xsd:string
File_Name
xsd:string
Date_Type
xsd:string
Texte que l'API Data Warehouse place dans la ligne d'objet
du message électronique.
Nom de la demande Data Warehouse telle qu'elle doit
apparaître dans le message électronique.
(Facultatif) Description de la demande Data Warehouse telle
qu'elle doit apparaître dans le message électronique.
(Facultatif) Nom du fichier de données contenant les résultats
de la demande Data Warehouse. Par exemple, indiquez
DW_Data pour renvoyer un fichier de données nommé
DW_Data.csv.
Type de la plage de dates utilisée avec la demande Data
Warehouse. Les valeurs acceptables sont les suivantes :
range: indique que vous souhaitez utiliser une plage de dates
personnalisée. Pour ce faire, indiquez la date de début du
rapport à l'aide du paramètre Date_From et la date de fin à
l'aide du paramètre Date_To.
preset : indique que vous souhaitez utiliser une plage de dates
prédéfinie. Pour ce faire, indiquez la date prédéfinie du rapport
à l'aide du paramètre Date_Preset.
Date_Preset
xsd:string
(Facultatif) Plage de dates prédéfinie à utiliser avec la
demande Data Warehouse. Indiquez ce paramètre lorsque
Date_Type = preset.
Les valeurs acceptables sont les suivantes (sensibles à la
casse) : 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
(Facultatif) Date de fin de la plage de dates personnalisée
pour la demande Data Warehouse. Indiquez ce paramètre
lorsque Date_Type = range.
Les valeurs de date doivent être au format MM/DD/YY.
API Data Warehouse
8
Paramètre
Type
Date_From
xsd:string
Description
(Facultatif) Date de début de la plage de dates personnalisée
à utiliser avec la demande Data Warehouse. Indiquez ce
paramètre lorsque Date_Type = range.
Les valeurs de date doivent être au format MM/DD/YY.
Date_Granularity
xsd:string
Granularité de la demande Data Warehouse.
Les valeurs acceptables sont les suivantes : 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
(Facultatif) Segment à utiliser avec cette demande Data
Warehouse. Cette valeur doit être un identifiant de segment
global valide. Utilisez DataWarehouse.GetSegments pour
obtenir la liste des identifiants de segment valides.
(Facultatif) Mesures à inclure dans la demande Data
Warehouse. Une demande valide doit contenir au moins une
mesure ou ventilation. Utilisez ReportSuite.GetAvalableMetrics
pour obtenir la liste des mesures disponibles pour une suite
de rapports.
(Facultatif) Ventilations à inclure dans la demande Data
Warehouse. Une demande valide doit contenir au moins une
mesure ou ventilation. Utilisez
ReportSuite.GetAvalableElements pour obtenir la liste des
ventilations disponibles pour une suite de rapports.
(Facultatif) Emplacement de livraison du segment Data
Warehouse. Les valeurs acceptables sont les suivantes :
Laisser vierge : ne renseignez aucune valeur pour ce
paramètre si vous souhaitez que l'API Data Warehouse
distribue le fichier de segment par courrier électronique. La
messagerie électronique constitue le mécanisme de
distribution par défaut.
Nom d'hôte FTP : indiquez un nom d'hôte FTP pour que l'API
Data Warehouse distribue le segment par FTP.
send_via_api : Indiquez la valeur send_via_api pour que l'API
Data Warehouse distribue le segment à l'aide de son interface
REST. Dans ce cas, une fois le segment terminé, la méthode
DataWarehouse.CheckRequest fournit l'URL REST à laquelle
vous pouvez effectuer le téléchargement.
FTP_Port
xsd:int
(Facultatif) Numéro de port FTP.
API Data Warehouse
9
Paramètre
Type
Description
FTP_Dir
xsd:string
FTP_UserName
xsd:string
FTP_Password
xsd:string
(Facultatif) Répertoire FTP dans lequel l'API Data Warehouse
place le fichier (/reports/here, par exemple).
(Facultatif) Nom d'utilisateur utilisé pour se connecter au
serveur FTP indiqué dans FTP_Host.
(Facultatif) Mot de passe correspondant à l'utilisateur FTP
indiqué dans FTP_UserName.
Réponse DataWarehouse.Request
Type
Description
xsd:int
Identifiant affecté à cette demande Data Warehouse par les serveurs Adobe.
DataWarehouse.VerifySegment
Valide la définition de segment spécifiée sans créer de nouveau segment Data Warehouse.
Cela se révèle particulièrement utile pour vérifier la syntaxe du segment avant de créer le segment dans l'API Data
Warehouse.
Paramètres DataWarehouse.VerifySegment
Paramètre
Type
Description
segment
tns:data_warehouse_segment
Définition du segment à vérifier.
Réponse DataWarehouse.VerifySegment
Type
Description
xsd:boolean
Renvoie True si la syntaxe du filtre de segment est valide. Dans le cas contraire, une
anomalie d'environnement est renvoyée au niveau de la première erreur de syntaxe dans
la définition du segment.
Types de données personnalisés
L'API Data Warehouse utilise ces structures de données personnalisées, y compris les types énumérés.
Un type de données définit la structure utilisée pour organiser et contenir un jeu de données spécifique. Les types
de données peuvent être composés de plusieurs éléments, correspondant chacun à un tableau, une énumération,
une structure ou à un élément "primitif". Adobe définit des types de données à l'aide de la convention suivante :
<namespace>:<type>
API Data Warehouse
10
Par exemple :
• xsd:int indique que le type de données fait partie de l'espace de noms xsd (XML Schema Definition - Définition
de schéma XML) et que le type est int (Entier). XML définit certains types de données (courants) primitifs, tels
que int, string ou date. La Définition de schéma XML décrit tous les types de données primitifs.
• tns:code_items indique que le type de données fait partie de l'espace de noms tns (espace de noms Adobe
privé) et que le type de données personnalisé est code_items. L'espace de noms tns préfixe tous les types de
données personnalisés de la Suite de marketing en ligne.
tns:data_warehouse_report
Structure de données contenant des informations sur un rapport Data Warehouse.
Nom
Type
start_row
xsd:int
end_row
xsd:int
headings
tns:data_warehouse_report_headings
row
tns:data_warehouse_report_row_list
finished
xsd:boolean
Description
Première ligne de données à inclure dans le rapport. Cette valeur
doit toujours être 1.
Dernière ligne de données à inclure dans le rapport. Cette valeur
doit toujours être égale au nombre d'éléments présents dans
row_list.
Liste des en-têtes de colonne de ce rapport.
Liste des lignes de données de ce rapport.
Cet élément n'est pas activé pour l'instant. Par conséquent, il
renvoie toujours True.
Indique que des données supplémentaires sont disponibles
(rapport par pages).
tns:data_warehouse_report_headings
Tableau de xsd:string.
tns:data_warehouse_report_row
Tableau de xsd:string.
tns:data_warehouse_report_row_list
Tableau de tns:data_warehouse_report_row .
tns:data_warehouse_request
Structure de données contenant les paramètres de configuration d'une source de données de type traitement
complet.
API Data Warehouse
Nom
status
11
Type
Description
xsd:int
Code représentant l'état du segment de données. Les valeurs
d'état acceptables sont les suivantes :
Code
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Message
En attente de démarrage (demande créée ;
estimation des besoins en termes de traitement)
En cours
Terminé
En attente
Annulé
Comporte une erreur
En attente de démarrage (serveur attribué ; en
attente de démarrage du traitement)
Trop volumineux
En attente de démarrage (estimation terminée ;
en attente d'un serveur disponible)
En attente de données
En attente d'envoi
En attente de vérification
En attente d'envoi
Envoi vers le produit
Envoi en cours
En attente de la suite (déconseillé)
En attente de la suite (déconseillé)
Suite en cours
API Data Warehouse
Nom
12
Type
Description
Code
18
message
filesize
data_url*
Message
Non livré
xsd:string
Brève description du paramètre d'état. La chaîne du message est
située en regard du code d'état.
xsd:string
Ce paramètre est renseigné uniquement lorsque status = 2.
Taille du segment de données demandé, exprimée en Mo.
xsd:string
Ce paramètre est renseigné uniquement lorsque status = 2.
Contient l'URL à laquelle vous pouvez télécharger le segment de
données terminé.
* Dès qu'un segment de données est complet, la valeur data_url est utilisée dans une demande GET HTTP pour
le récupérer. Lors de la demande d'un segment de données via data_url, vous devez fournir vos informations
d'authentification de la Suite de marketing en ligne comme vous le feriez pour utiliser tout autre appel d'API de cette
suite. Pour de plus amples informations sur WSSE, consultez la section <<Authentification des services Web>>.
L'exemple de code suivant illustre l'utilisation de cURL* pour générer la demande GET à partir d'un poste de travail
Linux :
curl "<Genesis REST URL>" -H "$(php <wsse.php> <username> <secret>)
Une demande REST réussie comprend les composants suivants :
Nom
data URL
username
secret
wsse.php
Description
URL associée à un segment de données spécifique (par exemple :
https://api.omniture.com/rest/?id=123456).
Votre nom d'utilisateur Suite de marketing en ligne.
Votre question secrète Suite de marketing en ligne (mot de passe).
Fichier script contenant les données d'authentification WSSE relatives à la demande Data
Warehouse. Ce fichier peut se présenter comme suit :
#!/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];
API Data Warehouse
Nom
13
Description
$created = date('c');
$nonce = md5(rand(), true);
$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
Structure de données contenant les paramètres de configuration d'une source de données de type traitement
complet.
Nom
Type
name
xsd:string
Description
Nom descriptif du segment Data Warehouse.
Ce nom ne peut pas contenir plus de
255 caractères.
group_include
tns:data_warehouse_segment_group
group_exclude
tns:data_warehouse_segment_group
Indique les données à inclure explicitement dans
le fichier de données. Bien que vous deviez
inclure l'élément group_include, vous n'êtes
pas obligé d'y renseigner des données si vous
ne souhaitez pas utiliser une règle d'inclusion.
Indique les données à exclure explicitement du
fichier de données. Bien que vous deviez inclure
l'élément group_exclude, vous n'êtes pas obligé
d'y renseigner des données si vous ne souhaitez
pas utiliser une règle d'inclusion.
tns:data_warehouse_segment_group
Structure (appelée un groupe) contenant des règles, ainsi que des informations relatives à leur combinaison, en
vue de créer une définition de segment.
API Data Warehouse
14
Nom
Type
type
xsd:string
Description
Indique le type de segment. Les valeurs acceptables, qui sont
sensibles à la casse, sont les suivantes :
ROOT : groupe de segments de niveau supérieur. Le groupe de
niveau supérieur doit obligatoirement être ROOT.
VISITOR : conteneur destiné aux calculs de visiteurs.
VISIT : conteneur destiné aux calculs de visites.
PAGE : conteneur destiné aux calculs de pages.
EVENT : conteneur destiné aux événements.
name
xsd:string
Nom du groupe de segments. Le nom du groupe de niveau
supérieur doit obligatoirement être Include. N'importe quelle chaîne
descriptive peut être utilisée comme nom pour les groupes de
segments imbriqués.
Ce nom ne peut pas contenir plus de 255 caractères.
group_operator
xsd:string
Opérateur booléen utilisé pour combiner des groupes dans le
paramètre group_list. Les valeurs acceptables sont les suivantes :
AND : vous pouvez combiner des groupes à l'aide d'un opérateur
AND booléen.
OR : vous pouvez combiner des groupes à l'aide d'un opérateur
OR booléen.
rule_operator
xsd:string
Opérateur booléen utilisé pour combiner des règles dans le
paramètre rule_list. Les valeurs acceptables sont les suivantes :
AND: vous pouvez combiner des groupes à l'aide d'un opérateur
AND booléen.
OR: vous pouvez combiner des groupes à l'aide d'un opérateur OR
booléen.
rule_list
tns:data_warehouse_segment_rule_list
Liste des règles contenues dans l'objet Groupe. Les restrictions
suivantes s'appliquent à des listes de règles dans des groupes de
segments :
• La liste de règles d'un groupe de segments ROOT ne peut contenir
aucune règle.
• La liste de règles d'un groupe de segments EVENT peut contenir
une seule règle de type EVENT.
• La liste de règles EVENT peut contenir un nombre indéfini de
règles non EVENT.
API Data Warehouse
15
Nom
Type
Description
group_list
tns:data_warehouse_segment_group_list
Liste des groupes de segments contenus dans ce groupe. Les
restrictions suivantes s'appliquent lors de l'imbrication de groupes
de segments :
• Le groupe ROOT est l'objet de groupe supérieur et ne peut pas
comporter de parent.
• Un groupe EVENT ne peut pas avoir un parent de type EVENT.
• Un groupe VISIT ne peut pas avoir un parent de type PAGE, VISIT
ou EVENT.
• Un groupe VISITOR ne peut pas avoir un parent de type PAGE,
VISIT, VISITOR ou EVENT.
• Un groupe PAGE ne peut pas avoir un parent de type PAGE ou
EVENT.
tns:data_warehouse_segment_rule
Structure définissant une seule règle de segmentation.
Nom
Type
operator
xsd:string
Description
Opérateur booléen utilisé pour cette règle. Les valeurs acceptables sont les
suivantes. Vous pouvez également laisser le champ operator vide.
= (est égal à)
!= (n'est pas égal à)
> (est supérieur à)
< (est inférieur à)
>= (est plus grand ou égal à)
<= (est plus petit ou égal à)
NOT CONTAINS (ne contient pas)
CONTAINS ALL OF (contient tous les)
NOT CONTAINS ALL OF (ne contient pas tous les)
CONTAINS ONE OF (contient l'un des)
NOT CONTAINS ONE OF (ne contient aucun des)
type
xsd:string
Propriété à utiliser pour la comparaison des règles. Par exemple : column.
Le type ne peut pas contenir plus de 100 caractères.
value
xsd:string
Valeur à utiliser dans le cadre de la comparaison des règles.
API Data Warehouse
Nom
16
Type
Description
La valeur ne peut pas contenir plus de 255 caractères.
event
xsd:int
Identifiant de l'événement que vous souhaitez écouter. Lors de la création d'une
règle Event, vous devez respecter les conventions suivantes :
- Lorsque vous spécifiez un événement, toutes les autres valeurs (opérateur,
type et valeur) doivent être vierges (chaîne de 0 caractère ou valeur NULL). Lorsque vous ne spécifiez pas d'événement, la valeur d'événement doit être
vierge (chaîne de 0 caractère ou valeur NULL). - Les règles Event doivent se
trouver dans une valeur rule_list d'un groupe de segments de type EVENT.
Le paramètre d'événement accepte les valeurs suivantes :
Identifiant
d'événement
1
2
10
11
12
13
14
20
100
101
102
103
104
105
Description
PURCHASE
PRODUCT_VIEW
SHOPPING_CART_OPEN
SHOPPING_CART
SHOPPING_CART_ADD
SHOPPING_CART_REMOVE
SHOPPING_CART_VIEW
Instance de campagne
Instance de variable eVar1
Instance de variable eVar2
Instance de variable eVar3
Instance de variable eVar4
Instance de variable eVar5
Instance de variable eVar6
API Data Warehouse
Nom
17
Type
Description
Identifiant
d'événement
Description
106
Instance de variable eVar7
107
Instance de variable eVar8
108
Instance de variable eVar9
109
Instance de variable eVar10
110
Instance de variable eVar11
111
Instance de variable eVar12
tns:data_warehouse_segment_rule_list
Tableau de tns:data_warehouse_segment_rule .
tns:segment
Structure de données contenant un seul segment de données.
Nom
Type
id
xsd:string
name
xsd:string
definition
xsd:string
Description
Identifiant unique du segment.
Nom du segment.
Définition du segment utilisée pour indiquer les données à inclure
dans le segment.
tns:segments
Tableau de tns:segment .
tns:segment_folder
Structure de données contenant des informations sur un ensemble de segments de données.
API Data Warehouse
18
Nom
Type
namespace
xsd:string
folder_name
xsd:string
segments
tns:segments
Description
Espace de noms associé à ce dossier de segments.
Nom du dossier de segments.
Liste des segments associés au dossier.
tns:segment_folders
Tableau de tns:segment_folder .
Exemple de code
L'API Data Warehouse comprend les exemples de code ci-dessous.
Le code suivant n'est proposé qu'à titre de démonstration. Lorsque vous préparez le code pour votre entreprise,
utilisez vos propres valeurs, noms, emplacements de fichiers, etc.
Exemple de demande d'annulation Data Warehouse
Exemple d'appel de méthode DataWarehouse.CancelRequest et réponse qui y est associée.
Demande 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>
Réponse 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>
Exemple de demande de vérification Data Warehouse
Exemple d'appel de méthode DataWarehouse.CheckRequest et réponse qui y est associée.
API Data Warehouse
19
Demande 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>
</soapenv:Body>
</soapenv:Envelope>
Réponse 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>
Exemple de création d'un segment Data Warehouse
Exemple d'appel de méthode DataWarehouse.CreateSegment et réponse qui y est associée.
Demande 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>
API Data Warehouse
20
<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>
<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>
Exemple de demande Data Warehouse
Exemple d'appel de méthode DataWarehouse.Request et réponse qui y est associée.
Demande 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>
API Data Warehouse
<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>
Réponse DataWarehouse.Request
<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.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

Documents pareils