Upload Login /
...

Data Warehouse API - Adobe Marketing Cloud

by user

on
Category: Documents
>> Downloads: 2
11

views

Report

Comments

Description

Transcript

Data Warehouse API - Adobe Marketing Cloud
Adobe© Marketing Cloud
Data Warehouse API
目次
Data Warehouse API.........................................................................................................4
Data Warehouse のメソッド........................................................................................................................................4
DataWarehouse.CancelRequest.............................................................................................................................................................4
DataWarehouse.CheckRequest..............................................................................................................................................................4
DataWarehouse.CreateSegment...........................................................................................................................................................5
DataWarehouse.GetReportData............................................................................................................................................................5
DataWarehouse.GetSegment.................................................................................................................................................................6
DataWarehouse.GetSegments...............................................................................................................................................................6
DataWarehouse.ReplaceSegment........................................................................................................................................................7
DataWarehouse.Request..........................................................................................................................................................................7
DataWarehouse.VerifySegment..........................................................................................................................................................10
カスタムデータタイプ...............................................................................................................................................10
tns:data_warehouse_report.................................................................................................................................................................11
tns:data_warehouse_report_headings............................................................................................................................................11
tns:data_warehouse_report_row.......................................................................................................................................................11
tns:data_warehouse_report_row_list...............................................................................................................................................11
tns:data_warehouse_request...............................................................................................................................................................12
tns:data_warehouse_segment............................................................................................................................................................14
tns:data_warehouse_segment_group.............................................................................................................................................15
tns:data_warehouse_segment_rule..................................................................................................................................................16
tns:data_warehouse_segment_rule_list..........................................................................................................................................18
tns:segment................................................................................................................................................................................................18
tns:segments..............................................................................................................................................................................................19
tns:segment_folder..................................................................................................................................................................................19
tns:segment_folders................................................................................................................................................................................19
サンプルコード..............................................................................................................................................................19
Data Warehouse のリクエストのキャンセルのサンプル.....................................................................................................19
Data Warehouse のリクエストの確認のサンプル...................................................................................................................20
Data Warehouse のセグメントの作成のサンプル...................................................................................................................20
Last updated 3/18/2013
Data Warehouse API
目次
Data Warehouse リクエストのサンプル.......................................................................................................................................22
Last updated 3/18/2013
Data Warehouse API
Data Warehouse API
4
Data Warehouse API
Data Warehouse を使用すると、個別の問題を基に生データから高度なデータの関連性を表示するレポートを要求
できます。 例えば、サイトで特定のアイテムを購入した訪問者の離脱ページをレポートできます。
Data Warehouse レポートは電子メールまたは FTP 経由で送られ、その処理には、クエリの複雑さと要求されたデー
タ量に応じて 72 時間以上かかります。
注: Data Warehouse セグメントに関して、Adobe はサービス契約SLA は提供しておらず、サービスレベルに
関していかなる保証もしていません。
Data Warehouse のメソッド
Data Warehouse API には以下のメソッドが含まれています。
ここで説明するメソッド名とパラメーター名を使用して SOAP メソッドと REST メソッドの呼び出しを作成しま
す。 SOAP および REST による Web サービスの使用について詳しくは、「はじめに」を参照してください。
DataWarehouse.CancelRequest
以前にリクエストされた Data Warehouse セグメントをキャンセルします。
DataWarehouse.CancelRequest のパラメーター
パラメーター
タイプ
Request_Id
xsd:int
説明
キャンセルする Data Warehouse リクエスト ID。
DataWarehouse.CancelRequest の応答
タイプ
説明
xsd:string
Data Warehouse セグメントのリクエストのキャンセルを確認します。
DataWarehouse.CheckRequest
電子メールまたは FTP で配信される 1 回のみのレポートリクエストを送信します。
DataWarehouse.CheckRequest のパラメーター
パラメーター
タイプ
Request_Id
xsd:int
説明
ステータスを返す必要のある Data Warehouse リクエスト ID。
送信したリクエストのステータスのみを確認できます。
Data Warehouse API
5
DataWarehouse.CheckRequest の応答
タイプ
説明
tns:data_warehouse_request
指定されたデータセグメントに関する情報を含む構造。 指定された Request_Id にデー
タが含まれていない場合、このメソッドは次の応答を返します。
Empty data set. No data for Request ID <Request_Id>.
DataWarehouse.CreateSegment
レポートスイートデータを決定するセグメント定義を作成します。このデータは、Data Warehouse が新しいデー
タウェアハウスセグメントに含めます。
DataWarehouse.CreateSegment のパラメーター
パラメーター
タイプ
説明
rsid
xsd:int
segment
tns:data_warehouse_segment
セグメントの生成に使用するレポートスイート。
新しいセグメントの定義に使用するセグメント定義。
DataWarehouse.CreateSegment の応答
タイプ
説明
xsd:int
新しいセグメントの固有のセグメント ID。セグメントの作成が失敗すると、SOAP フレー
ムワークはエラーを示す環境の障害を返します。
DataWarehouse.GetReportData
send_via_api パラメーターを使用した DataWarehouse.Request の呼び出しによって以前に作成されたセグメ
ントファイルを取得するよう Data Warehouse に指示します。
DataWarehouse.GetReportData のパラメーター
パラメーター
タイプ
Request_Id
xsd:int
説明
DataWarehouse.Request の呼び出しによって返されるリクエストの識
別子。
rsid
xsd:string
start_row
xsd:int
Data Warehouse リクエストに関連付けられているレポートスイート。
このパラメーターは現在使用されていません。 値 0 または 1 を指定し
てください。
Data Warehouse API
6
DataWarehouse.GetReportData の応答
タイプ
説明
tns:data_warehouse_report
指定された DataWarehouse.Request の呼び出しを含むテーブル。
DataWarehouse.GetSegment
レポートスイートデータを決定するセグメントフィルターを作成します。このデータは、Data Warehouse が Data
Warehouse リクエストに対するデータファイルの応答に含めます。
DataWarehouse.GetSegment のパラメーター
パラメーター
タイプ
rsid
xsd:int
segment
xsd:int
説明
セグメントの生成に使用するレポートスイート。
セグメント ID。Data Warehouse では、新しいセグメントの作
成後にこの値を生成します。
DataWarehouse.GetSegment の応答
タイプ
説明
tns:data_warehouse_segment
データウェアハウスのセグメントデータを含む構造。
DataWarehouse.GetSegments
指定された日付範囲の Data Warehouse セグメントを取得します。
DataWarehouse.GetSegments のパラメーター
パラメーター
タイプ
rsid
xsd:int
説明
Data Warehouse セグメントを作成するためのレポートスイート
ID。
start_date
xsd:date
end_date
xsd:date
Data Warehouse セグメントの開始日。
Data Warehouse セグメントの終了日。
Data Warehouse API
7
DataWarehouse.GetSegments の応答
タイプ
説明
tns:segment_folders
指定された日付範囲のセグメントのリスト。
DataWarehouse.ReplaceSegment
指定された Data Warehouse セグメントを削除し、指定された構造の新しい Data Warehouse セグメントを作成しま
す。
DataWarehouse.ReplaceSegment のパラメーター
パラメーター
タイプ
id
xsd:int
説明
削除するセグメントの ID。 Data Warehouse では、セグメントの作成
操作に対する応答でこの値を提供します。
rsid
xsd:int
segment
tns:data_warehouse_segment
新しいセグメントの作成に使用するレポートスイート。
新しいセグメントのデータセットの定義に使用するセグメント定義。
DataWarehouse.ReplaceSegment の応答
タイプ
説明
xsd:int
新しいセグメントの固有のセグメント識別子。
セグメントの作成が失敗すると、SOAP フレームワークはエラーを示す環境の障害を返し
ます。
DataWarehouse.Request
電子メールまたは FTP で配信される 1 回のみのレポートリクエストを送信します。
DataWarehouse.Request のパラメーター
パラメーター
タイプ
rsid
xsd:string
説明
Data Warehouse リクエストで使用するレポートスイートの
ID。 レポートスイートでは Data Warehouse を有効にする必
要があります。また、ユーザーにはこのレポートスイートに
対する権限が必要です。
Contact_Name
xsd:string
Data Warehouse リクエストを行う担当者の名前。
Data Warehouse API
8
パラメーター
タイプ
Contact_Phone
xsd:string
Email_To
xsd:string*
説明
Data Warehouse リクエストを行う担当者の電話番号。
Data Warehouse からのデータファイルの送信先となる電子
メールアドレス。電子メールはデフォルトの配信方法です
が、必要に応じて FTP を使用することもできます。
Email_Subject
xsd:string
Report_Name
xsd:string
Report_Name
xsd:string
Data Warehouse が電子メールの件名に配置するテキスト。
電子メールに表示する Data Warehouse リクエスト名。
オプション 電子メールに表示する Data Warehouse リクエス
トの説明。
File_Name
xsd:string
オプション Data Warehouse リクエストの結果を含むデータ
ファイルの名前。 例えば、DW_Data.csv というデータファ
イルを返すには、DW_Data を指定します。
Date_Type
xsd:string
Data Warehouse リクエストで使用する日付範囲のタイプ。 次
の値がサポートされています。
range カスタムの日付範囲を使用するよう指定します。 その
ためには、Date_From パラメーターを使用してレポートの開
始日を指定し、Date_To パラメーターを使用して終了日を指
定してください。
preset 定義済みの日付範囲を使用するよう指定します。 そ
のためには、Date_Preset パラメーターを使用してレポート
の事前設定日を指定してください。
Date_Preset
xsd:string
オプション Data Warehouse リクエストで使用する定義済み
の日付範囲。 このパラメーターは、Date_Type = preset の
場合に指定します。
サポートされている値は、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
オプション Data Warehouse リクエストのカスタムの日付範
囲の終了日。 このパラメーターは、Date_Type = range の
場合に指定します。
日付の値には MM/DD/YY 形式を使用する必要があります。
Data Warehouse API
9
パラメーター
タイプ
Date_From
xsd:string
説明
オプション Data Warehouse リクエストのカスタムの日付範
囲の開始日。 このパラメーターは、Date_Type = range の
場合に指定します。
日付の値には MM/DD/YY 形式を使用する必要があります。
Date_Granularity
xsd:string
Data Warehouse リクエストの精度。
サポートされている値は、none、hour、day、week、month、
quarter、year です。
Segment_Id
xsd:int
オプション この Data Warehouse リクエストで使用するセグ
メント。 この値は有効なグローバルセグメント ID である必
要があります。有効なセグメント ID のリストを取得するに
は、DataWarehouse.GetSegments を使用します。
Metric_List
array(xsd:string)
オプション Data Warehouse リクエストに含める指標。 有
効なリクエストには指標または分類を 1 つ以上含める必要が
あります。レポートスイートで使用可能な指標のリストを取
得するには、ReportSuite.GetAvalableMetrics を使用します。
Breakdown_List
array(xsd:string)
オプション Data Warehouse リクエストに含める分類。 有
効なリクエストには指標または分類を 1 つ以上含める必要が
あります。レポートスイートで使用可能な分類のリストを取
得するには、ReportSuite.GetAvalableElements を使用します。
FTP_Host
xsd:string
オプション Data Warehouse セグメントの配信場所。 次の
値がサポートされています。
空白のままにする Data Warehouse から電子メールでセグメ
ントファイルを配信する場合は、このパラメーターの値を指
定しないでください。電子メールはデフォルトの配信方法で
す。
FTP ホスト名 Data Warehouse から FTP でセグメントを配信
するには、FTP ホスト名を指定します。
send_via_api Data Warehouse から REST インターフェイスを
使用してセグメントを配信するには、値 send_via_api を指定
します。 この場合、セグメントが完了すると、
DataWarehouse.CheckRequest が REST URL を提供します。この
URL でセグメントをダウンロードできます。
Data Warehouse API
10
パラメーター
タイプ
説明
FTP_Port
xsd:int
FTP_Dir
xsd:string
オプションFTP ポート番号。
オプション Data Warehouse がデータファイルを配置する
FTP ディレクトリ 例 /reports/here 。
FTP_UserName
xsd:string
オプション FTP_Host で指定された FTP サーバーへのログ
インに使用するユーザー名。
FTP_Password
xsd:string
オプション FTP_UserName で指定された FTP ユーザーに対
応するパスワード。
DataWarehouse.Request の応答
タイプ
説明
xsd:int
Adobe のサーバーによってこの Data Warehouse リクエストに割り当てられたリクエスト
ID。
DataWarehouse.VerifySegment
新しい Data Warehouse セグメントを作成せずに、指定されたセグメント定義を検証します。
これは、Data Warehouse に新しいセグメントを作成する前にセグメント構文を確認する場合に役立ちます。
DataWarehouse.VerifySegment のパラメーター
パラメーター
タイプ
segment
tns:data_warehouse_segment
説明
検証するセグメント定義。
DataWarehouse.VerifySegment の応答
タイプ
説明
xsd:boolean
セグメントフィルターの構文が有効な場合は True を返します。 有効でない場合は、セ
グメント定義の最初の構文エラーで環境の障害を返します。
カスタムデータタイプ
Data Warehouse API では、列挙されるタイプを含む次のカスタムデータ構造を使用します。
Data Warehouse API
11
データタイプでは、特定のデータセットを編成して格納するための構造を定義します。 データタイプは、2 つ以
上のエレメント 配列、一覧、構造または「プリミティブ」エレメントを使用可能 で構成することができます。
Adobe では、次の規則を使用してデータタイプを定義します。
<namespace>:<type>
例
• xsd:int は、データタイプが xsd ネームスペースXML スキーマ定義 の一部であり、タイプが intInteger であ
ることを示します。 XML では、int、string、date などの特定のプリミティブ 一般的な データタイプを定義しま
す。 XML スキーマ定義に関するページでは、すべてのプリミティブデータタイプについて説明しています。
• tns:code_items は、データタイプが tns ネームスペースAdobe 固有のネームスペース の一部であり、カスタ
ムデータタイプが code_items であることを示します。 tns ネームスペースは、Marketing Cloud のすべてのカス
タムデータタイプのプレフィックスとして追加されます。
tns:data_warehouse_report
Data Warehouse レポートに関する情報を含むデータ構造です。
名前
タイプ
start_row
xsd:int
説明
レポートに含める最初のデータ行。 この値は必ず 1 にする必
要があります。
end_row
xsd:int
レポートに含める最後のデータ行。 この値は必ず row_list の
エレメント数と同じにする必要があります。
headings
tns:data_warehouse_report_headings
row
tns:data_warehouse_report_row_list
finished
xsd:boolean
このレポートの列見出しのリスト。
このレポートのデータ行のリスト。
現在、このエレメントは無効なので、常に True が返されます。
追加のデータが使用可能であることを示します ページ指定さ
れたレポート 。
tns:data_warehouse_report_headings
xsd:string の配列です。
tns:data_warehouse_report_row
xsd:string の配列です。
tns:data_warehouse_report_row_list
tns:data_warehouse_report_row の配列です。
Data Warehouse API
12
tns:data_warehouse_request
フル処理のデータソースの構成設定を含むデータ構造です。
名前
status
タイプ
説明
xsd:int
データセグメントのステータスを表すコード。 次のステータス
値がサポートされています。
コード
0
メッセージ
開始を待機中 リクエストの作成が完了し、予測
の処理が必要
1
2
3
4
5
6
進行中
完了
保留中
キャンセル
エラーがあります
開始を待機中 サーバーの割り当てが完了し、
サーバーによる処理の開始を待機中
7
8
大きすぎます
開始を待機中 予測が完了し、使用可能なサー
バーを待機中
9
10
11
12
13
14
データを待機中
送信を待機中
確認を待機中
送信を待機中
製品に送信
送信中
Data Warehouse API
名前
13
タイプ
説明
コード
15
16
17
18
message
xsd:string
メッセージ
続行を待機中 廃止
続行を待機中 廃止
継続中
配信されませんでした
status パラメーターの簡単な説明です。 上記のメッセージ文字列
はステータスコードの横に示されます。
filesize
xsd:string
status = 2 の場合にのみ入力されます。 リクエストされたデー
タセグメントのサイズMB 単位 。
data_url*
xsd:string
status = 2 の場合にのみ入力されます。 完了したデータセグメ
ントをダウンロードできる URL が含まれます。
*データセグメントが完了すると、HTTP GET リクエストの data_url の値を使用してデータセグメントを取得し
ます。 data_url を通じてデータセグメントをリクエストするときは、その他の Marketing Cloud API の呼び出し
を使用する場合と同様に、Marketing Cloud の資格情報を指定する必要があります。 WSSE について詳しくは、
「Web Services Authentication」を参照してください。
次のコード例は、cURL* を使用して Linux ワークステーションから GET リクエストを生成する方法を示していま
す。
curl "<Genesis REST URL>" -H "$(php <wsse.php> <username> <secret>)
成功した REST リクエストには次のコンポーネントが含まれます。
名前
data URL
説明
特定のデータセグメントに関連付けられている URL 例えば、
https://api.omniture.com/rest/?id=123456 。
username
secret
Marketing Cloud のユーザー名。
Marketing Cloud のパスワードです。
Data Warehouse API
名前
wsse.php
14
説明
Data Warehouse リクエストの WSSE 認証データを含むスクリプトファイルです。 このファイル
は次のようになります。
#!/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);
$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
フル処理のデータソースの構成設定を含むデータ構造です。
名前
タイプ
name
xsd:string
説明
Data Warehouse セグメントの説明的な名前。
この名前は 255 文字を超えないようにしてくだ
さい。
group_include
tns:data_warehouse_segment_group
データファイルに明示的に含めるデータを指定
します。 group_include エレメントを含める必
要はありますが、包含ルールを使用しない場合
は、このエレメントを空白のままにすることが
できます。
group_exclude
tns:data_warehouse_segment_group
データファイルから明示的に除外するデータを
指定します。 group_exclude エレメントを含め
Data Warehouse API
名前
15
タイプ
説明
る必要はありますが、除外ルールを使用しない
場合は、このエレメントを空白のままにするこ
とができます。
tns:data_warehouse_segment_group
セグメント定義を作成するためのルールおよびそれらのルールの結合に関する情報を含む構造 グループと呼ばれ
ます です。
名前
タイプ
type
xsd:string
説明
セグメントタイプを指定します。次の値がサポートされています
大文字と小文字が区別されます 。
ROOT 最上位のセグメントグループ。最上位のセグメントグルー
プは ROOT にする必要があります。
VISITOR 訪問者計算のためのコンテナ。
VISIT 訪問計算のためのコンテナ。
PAGE ページ計算のためのコンテナ。
EVENT イベントのためのコンテナ。
name
xsd:string
セグメントグループ名。最上位のセグメントグループ名は Include
にする必要があります。説明的な文字列を使用して、ネストされ
たセグメントグループの名前を付けることができます。
この名前は 255 文字を超えないようにしてください。
group_operator
xsd:string
group_list パラメーターでのグループの結合に使用するブール
演算子。 次の値がサポートされています。
AND ブール演算子 AND を使用してグループを結合します。
OR ブール演算子 OR を使用してグループを結合します。
rule_operator
xsd:string
rule_list パラメーターでのルールの結合に使用するブール演算
子。 次の値がサポートされています。
AND: ブール演算子 AND を使用してグループを結合します。
OR:ブール演算子 OR を使用してグループを結合します。
Data Warehouse API
16
名前
タイプ
説明
rule_list
tns:data_warehouse_segment_rule_list
グループオブジェクトによって格納されるルールのリスト。セグ
メントグループのルールリストには次の制限が適用されます。
• ROOT セグメントグループのルールリストにルールを含めるこ
とはできません。
• EVENT セグメントグループのルールリストには、EVENT スタ
イルのルールを 1 つ含めることができます。
• EVENT ルールリストには、任意の数の EVENT スタイル以外の
ルールを含めることができます。
group_list
tns:data_warehouse_segment_group_list
このグループによって格納されるセグメントグループのリスト。
セグメントグループをネストする場合は次の制限が適用されま
す。
• ROOT グループは最上位のグループオブジェクトであり、親を
指定することはできません。
• EVENT グループに EVENT タイプの親を指定することはできま
せん。
• VISIT グループに PAGE、VISIT または EVENT タイプの親を指定
することはできません。
• VISITOR グループに PAGE、VISIT、VISITOR または EVENT タ
イプの親を指定することはできません。
• PAGE グループに PAGE または EVENT タイプの親を指定するこ
とはできません。
tns:data_warehouse_segment_rule
1 つのセグメントルールを定義する構造です。
名前
タイプ
operator
xsd:string
説明
このルールに使用するブール演算子。次の値がサポートされています。また、
operator を空白のままにすることもできます。
= 等しい
!= 等しくない
> より大きい
< より小さい
>= 以上
Data Warehouse API
名前
17
タイプ
説明
<= 以下
NOT CONTAINS 含まない
CONTAINS ALL OF すべてを含む
NOT CONTAINS ALL OF すべてを含まない
CONTAINS ONE OF いずれかを含む
NOT CONTAINS ONE OF いずれかを含まない
type
xsd:string
ルールの比較に使用するプロパティ。 例 column。
type は 100 文字を超えないようにしてください。
value
xsd:string
ルールの比較で使用する値。
value は 255 文字を超えないようにしてください。
event
xsd:int
リッスンするイベントの ID。 イベントルールを作成する場合は、次の規則に
従う必要があります。
- event を指定するときは、他のすべての値operator 、type および value を空白
0 文字の文字列または NULL 値 にする必要があります。 - event を指定しない
ときは、event の値を空白0 文字の文字列または NULL 値 にする必要がありま
す。 - EVENT タイプのセグメントグループの rule_list にはイベントルールを含
める必要があります。
event パラメーターでは次の値がサポートされています。
イベント ID
1
2
10
11
12
13
14
説明
PURCHASE
PRODUCT_VIEW
SHOPPING_CART_OPEN
SHOPPING_CART
SHOPPING_CART_ADD
SHOPPING_CART_REMOVE
SHOPPING_CART_VIEW
Data Warehouse API
名前
18
タイプ
説明
イベント ID
説明
20
キャンペーンのインスタンス
100
eVar1 のインスタンス
101
eVar2 のインスタンス
102
eVar3 のインスタンス
103
eVar4 のインスタンス
104
eVar5 のインスタンス
105
eVar6 のインスタンス
106
eVar7 のインスタンス
107
eVar8 のインスタンス
108
eVar9 のインスタンス
109
eVar10 のインスタンス
110
eVar11 のインスタンス
111
eVar12 のインスタンス
tns:data_warehouse_segment_rule_list
tns:data_warehouse_segment_rule の配列です。
tns:segment
1 つのデータセグメントを含むデータ構造です。
名前
タイプ
id
xsd:string
説明
固有のセグメント識別子。
Data Warehouse API
19
名前
タイプ
name
xsd:string
definition
xsd:string
説明
セグメント名。
このセグメントに含めるデータの指定に使用するセグメント定
義。
tns:segments
tns:segment の配列です。
tns:segment_folder
データセグメントのコレクションに関する情報を含むデータ構造です。
名前
タイプ
namespace
xsd:string
説明
このセグメントフォルダーに関連付けられているネームスペー
ス。
folder_name
xsd:string
segments
tns:segments
セグメントフォルダー名。
セグメントフォルダーに関連付けられているセグメントのリス
ト。
tns:segment_folders
tns:segment_folder の配列です。
サンプルコード
Data Warehouse API には、次のコード例が含まれています。
次のコードはデモ用です。 自社用のコードを準備する際は、実際の値、名前、ファイルの場所などを使用してく
ださい。
Data Warehouse のリクエストのキャンセルのサンプル
サンプルの DataWarehouse.CancelRequest メソッドの呼び出しおよびそれに関連する応答です。
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/>
Data Warehouse API
20
<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>
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>
Data Warehouse のリクエストの確認のサンプル
サンプルの DataWarehouse.CheckRequest メソッドの呼び出しおよびそれに関連する応答です。
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>
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>
Data Warehouse のセグメントの作成のサンプル
サンプルの DataWarehouse.CreateSegment メソッドの呼び出しおよびそれに関連する応答です。
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"
Data Warehouse API
21
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>
<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>
Data Warehouse API
22
Data Warehouse リクエストのサンプル
サンプルの DataWarehouse.Request メソッドの呼び出しおよびそれに関連する応答です。
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>
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>
Fly UP