Adobe© Marketing Cloud
SiteCatalyst レポート API
目次
SiteCatalyst レポート API.................................................................................................4
レポートメソッド...........................................................................................................................................................4
Report.QueueOvertime.............................................................................................................................................................................4
Report.QueueRanked.................................................................................................................................................................................5
Report.QueueTrended...............................................................................................................................................................................5
Report.CancelReport..................................................................................................................................................................................6
Report.GetReportQueue...........................................................................................................................................................................6
Report.GetReport........................................................................................................................................................................................7
Report.GetStatus.........................................................................................................................................................................................7
カスタムデータタイプ..................................................................................................................................................7
tns:booleanOperatorType........................................................................................................................................................................8
tns:comparisonOperatorType................................................................................................................................................................8
tns:report........................................................................................................................................................................................................8
tns:reportCountList.....................................................................................................................................................................................9
tns:reportData..............................................................................................................................................................................................9
tns:reportDataList.....................................................................................................................................................................................10
tns:reportDefinition.................................................................................................................................................................................10
tns:reportDefinitionDateGranularity.................................................................................................................................................10
tns:reportDefinitionElement.................................................................................................................................................................11
tns:reportDefinitionElementList..........................................................................................................................................................12
tns:reportDefinitionLocale....................................................................................................................................................................12
tns:reportDefinitionMetric.....................................................................................................................................................................12
tns:reportDefinitionMetricList..............................................................................................................................................................13
tns:reportDefinitionSearch....................................................................................................................................................................13
tns:reportDefinitionSearches...............................................................................................................................................................13
tns:reportDefinitionSearchType..........................................................................................................................................................13
tns:reportDefinitionSegment...............................................................................................................................................................13
tns:reportDefinitionSegmentCondition...........................................................................................................................................14
tns:reportDefinitionSegmentConditions.........................................................................................................................................14
tns:reportDefinitionSegmentEvent....................................................................................................................................................14
Last updated 3/18/2013
SiteCatalyst レポート API
目次
tns:reportDefinitionSegmentEventList.............................................................................................................................................14
tns:reportDefinitionSegmentList........................................................................................................................................................14
tns:reportDefinitionSegmentType.....................................................................................................................................................14
tns:reportDescription..............................................................................................................................................................................15
tns:reportElement.....................................................................................................................................................................................16
tns:reportElementList..............................................................................................................................................................................16
tns:reportMetric.........................................................................................................................................................................................16
tns:reportMetricList..................................................................................................................................................................................16
tns:reportMetricType...............................................................................................................................................................................16
tns:report_queue......................................................................................................................................................................................16
tns:report_queue_item..........................................................................................................................................................................16
tns:reportQueueResponse.....................................................................................................................................................................17
tns:reportReportSuite..............................................................................................................................................................................17
tns:report_status.......................................................................................................................................................................................17
tns:reportType............................................................................................................................................................................................18
レポート API リファレンス.......................................................................................................................................18
SiteCatalyst のエレメント....................................................................................................................................................................18
SiteCatalyst の指標..................................................................................................................................................................................21
SiteCatalyst レポートのエラーコード...........................................................................................................................................25
レポート API - サンプルコード...............................................................................................................................26
オーバータイムレポートのサンプル............................................................................................................................................26
ランクレポートのサンプル...............................................................................................................................................................27
トレンドレポートのサンプル..........................................................................................................................................................28
キーワード検索のサンプル...............................................................................................................................................................30
Last updated 3/18/2013
SiteCatalyst レポート API
4
SiteCatalyst レポート API
SiteCatalyst レポート API
レポート API を使用すると、UI を使用せずに、プログラムで SiteCatalyst レポートを生成できます。
SiteCatalyst レポート API を使用すると、SiteCatalyst の主要レポートデータにプログラムでアクセスできます。 レ
ポート API では、組織固有のニーズを解決するカスタムレポートを作成できます。 また、レポート API を使用す
ると、インターネットサイトまたは自社のブランドアプリケーションなどのサードパーティのアプリケーション
で SiteCatalyst のデータを使用できます。 データにアクセスして、必要に応じて計算指標を作成したり、データを
フォーマットしたりすることができます。 データは SiteCatalyst のデータ同様に最新です。
SiteCatalyst レポート API は、SiteCatalyst のデータにのみアクセスできます。 Discover やData Warehouseなど
のツールで使用可能な関連データにはアクセスできません。
注: レポート API では、「分類」という用語を汎用的に使用します。この用語は、「コリレーション」 トラ
フィック指標 および「サブリレーション」 コマース指標 両方を示します。
レポートメソッド
SiteCatalyst のレポート API には、以下のメソッドが含まれています。
ここで説明するメソッド名とパラメーター名を使用して、SOAP および REST のメソッド呼び出しを作成します。
SOAP および REST を使った Web サービスの使用方法について詳しくは、「はじめに」を参照してください。
Report.QueueOvertime
オーバータイムレポートリクエストを送信します。 オーバータイムレポートには、指定された指標の情報が、指
定された期間について表示されます。 オーバータイムレポートでは、1 つのレポートに複数の指標を表示できま
す。 オーバータイムレポートで使用可能なエレメントは time のみです。
オーバータイムレポートには、次のような特徴があります。
• 指定された期間にわたって指標を表示する。
• 必要に応じて 1 つのレポートに複数の指標を表示できる。
• Time エレメントのみをサポートする。
注: メソッドのパラメーターは、特に説明がない限り必須です。
Report.QueueOvertime のパラメーター
名前
タイプ
説明
reportDescription
tns:reportDefinition 必要なオーバータイムレポートコンテンツを指定するレポート
定義。
5
SiteCatalyst レポート API
Report.QueueOvertime の応答
タイプ
説明
tns:reportQueueResponse レポートステータスと、レポートのダウンロード
のレポートステータスのリクエスト
ます。
または現在
に使用される ID を含み
Report.GetReport
Report.GetStatus
Report.QueueRanked
ランクレポートリクエストを送信します。 ランクレポートには、指標に関連してレポートページのランクが表示
されます。 ランクレポートでは、1 つのレポートに複数の指標を表示できます。
ランクレポートには、次のような特徴があります。
• 指標に関連してレポートページのランクを表示する。
• 必要に応じて 1 つのレポートに複数の指標を表示できる。
• 必要に応じて 1 つのレポートで複数のエレメントを使用できる。
注: メソッドのパラメーターは、特に説明がない限り必須です。
Report.QueueRanked のパラメーター
名前
タイプ
説明
reportDescription
tns:reportDefinition 必要なランクレポートコンテンツを指定するレポート定義。
Report.QueueRanked の応答
タイプ
説明
tns:reportQueueResponse レポートステータスと、レポートのダウンロード
のレポートステータスのリクエスト
ます。
または現在
に使用される ID を含み
Report.GetReport
Report.GetStatus
Report.QueueTrended
トレンドレポートリクエストを送信します。 トレンドレポートは、1 つの指標 売上高、購入回数、ページビュー
など およびエレメント 製品、カテゴリ、ページなど のトレンドを表示します。
トレンドレポートには、次のような特徴があります。
• 1 つの指標とエレメントの組み合わせに関するトレンドを表示する。
注: メソッドのパラメーターは、特に説明がない限り必須です。
6
SiteCatalyst レポート API
Report.QueueTrended のパラメーター
名前
タイプ
reportDescription
tns:reportDefinition
説明
必要なトレンドレポートコンテンツを指定するレポート定義。
Report.QueueTrended の応答
タイプ
説明
tns:reportQueueResponse
レポートステータスと、レポートのダウンロード Report.GetReport または現在
のレポートステータスのリクエスト
Report.GetStatus
に使用される ID を含み
ます。
Report.CancelReport
以前送信したレポートリクエストをキャンセルして処理キューから削除します。
注意 メソッドのパラメーターは、特に説明がない限り必須です。
Report.CancelReport のパラメーター
名前
タイプ
説明
reportID
xsd:int
「レポートのキュー」リクエストで返されるレポート ID。
Report.CancelReport の応答
タイプ
説明
xsd:int
操作が成功した場合は 1 を返し、失敗した場合は 0 を返します。
Report.GetReportQueue
指定された会社のレポートキューに含まれるレポートのリストを返します。
注意 メソッドのパラメーターは、特に説明がない限り必須です。
Report.GetReportQueue のパラメーター
なし
Report.GetReportQueue の応答
タイプ
tns:report_queue
説明
指定された会社の、現在キューに置かれているレポートリクエストのリスト。
SiteCatalyst は、リクエストと共に提示された認証資格情報に基づいて会社を識別しま
す。
7
SiteCatalyst レポート API
Report.GetReport
指定されたレポートを取得します。 SiteCatalyst によるレポートリクエストの処理が完了した後に、このメソッド
を使用してレポートデータをダウンロードすることができます。
注: メソッドのパラメーターは、特に説明がない限り必須です。
Report.GetReport のパラメーター
名前
タイプ
説明
reportID
xsd:int
「レポートのキュー」リクエストで返されるレポート ID。
Report.GetReport の応答
タイプ
説明
tns:report
指定された reportID のレポートデータを含んでいる構造。
Report.GetStatus
指定されたレポートの現在のステータスを、レポートデータを取得せずに返します。
注: メソッドのパラメーターは、特に説明がない限り必須です。
Report.GetStatus のパラメーター
名前
タイプ
説明
reportID
xsd:int
「レポートのキュー」リクエストで返されるレポート ID。
Report.GetStatus の応答
タイプ
説明
tns:report_status
指定された reportID のステータス情報を含んでいる構造。
カスタムデータタイプ
レポート API では、ここに示す列挙型などのカスタムデータ構造が使用されます。
データタイプは、特定のデータセットをまとめるための構造を定義します。 データタイプは 2 つ以上のエレメン
ト 配列、列挙、構造、またはプリミティブ で構成されている場合があります。 データタイプの定義は次の規則
に従っています。
<namespace>:<type>
次に例を示します。
8
SiteCatalyst レポート API
• xsd:int は、データタイプが xsd ネームスペースXML スキーマの定義 の一部であり、int 整数 タイプである
ことを表します。 XML には、整数、文字列、日付などのプリミティブ 基本 データタイプが定義されています。
XML スキーマ定義にはすべてのプリミティブデータタイプの説明が記載されています。
• tns:code_items は、データタイプが tns ネームスペース アドビ独自のネームスペース の一部であり、カスタ
ムデータタイプが code_items であることを表します。 tns ネームスペースは、すべての Marketing Cloud のカ
スタムデータタイプにプレフィックスとして付加されています。
tns:booleanOperatorType
セグメントの作成時に使用されるブール演算子の列挙リスト。
値
説明
and
ブール演算子の AND を使用して複数のセグメントを評価します。
or
ブール演算子の OR を使用して複数のセグメントを評価します。
tns:comparisonOperatorType
セグメントの条件を評価する算術演算子の列挙リスト。
値
説明
=
等しい。
!=
等しくない。
>
次の値より大きい。
>=
次の値より大きいか等しい。
<
次の値より小さい。
<=
次の値より小さいか等しい。
contains
指定された値を含む。
not-contains
指定された値を含まない。
contains-all
指定されたすべての値を含む。
not-contains-all
指定されたすべての値を含んではいない。
contains-any
指定された値のうち 1 つまたは複数を含む。
not-contains-any
指定されたいずれの値も含まない。
tns:report
特定のレポートリクエストに関連付けられているデータを返す構造データタイプ。
エレメント
タイプ
説明
reportSuite
tns:tns:reportReportSuite
レポートの生成に使用されるレポートスイート。
period
xsd:string
レポートの期間を表す文字列。
9
SiteCatalyst レポート API
エレメント
タイプ
説明
elements
tns:tns:reportElementList
レポートに関連付けられているエレメントのリスト。
metrics
tns:reportMetricList
レポートに関連付けられている指標のリスト。
type
tns:reportType
レポートタイプ。 これは、元のレポートリクエストの作成
に使用されたレポートタイプと一致している必要がありま
す。
data
tns:reportDataList
レポートの大部分を占めるデータ。
totals
tns:reportCountList
指標の合計のリスト。
注: SiteCatalyst では、すべてのレポートに同じレポート形式が使用されます。 ただし、実際のレポート定義
の内容によっては、レポートの一部が使用されない場合があります。 また、Data Warehouse および Discover
では、この標準レポート構造を拡張し、これらのサービスに特有の詳細情報を追加しています。詳しくは、
Data Warehouse API および Discover API を参照してください。
tns:reportCountList
レポート内の各指標の発生回数のカウント。
xsd:double の配列。
tns:reportData
レポートデータを含む構造。
名前
タイプ
説明
name
xsd:string
このデータ項目の名前。
url
xsd:string
データ項目の URL 選択したエレメントに該当する場合 。 例えば、ペー
ジとリンクには URL がありますが、製品にはありません。
year
xsd:int
項目の 4 桁の年 エレメントがオーバータイムレポートまたはトレンドレ
ポートの日付範囲の場合 。
month
xsd:int
項目の 2 桁の月 エレメントがオーバータイムレポートまたはトレンドレ
ポートの日付範囲の場合 。
day
xsd:int
項目の 2 桁の日 エレメントがオーバータイムレポートまたはトレンドレ
ポートの日付範囲の場合 。
hour
xsd:int
項目の 2 桁の時間 エレメントがオーバータイムレポートまたはトレンド
レポートの日付範囲の場合 。
counts
tns:reportCountList
レポート内の各指標の発生回数のカウント。
breakdown
tns:reportDataList
項目のデータ。その次のエレメントに従って分類されます。 例えば、
ページビュー数によって分類されるブラウザーのレポートは、ブラウ
ザーのタイプごとのページビュー数のリストを含むレポートを返しま
す。これは、ランクレポートまたはトレンドレポートにおいて複数のエ
レメントBreakdown が指定される場合にのみ使用されます。
10
SiteCatalyst レポート API
tns:reportDataList
tns:reportData のリスト。
tns:reportDefinition
特定のレポートを作成するための情報を含む構造です。
エレメント
タイプ
説明
reportSuiteID
xsd:string
レポートの生成に使用する SiteCatalyst レポートスイート。 例
reportSuiteID = "corp1"
date
xsd:string
レポートの実行対象となる日付。 date を使用する場合は、
dateFrom と dateTo を使用しないでください。 日付形式は
YYYY-MM-DD4 桁の年、2 桁の月、2 桁の日 ですが、月と日は
オプションです。 例 date = "2009-01"
dateFrom
xsd:string
日付範囲を使用する場合、レポートの実行に使用する開始日。
dateFrom を使用する場合は、date を使用しないでください。
日付形式は YYYY-MM-DD4 桁の年、2 桁の月、2 桁の日 です
が、月と日はオプションです。 例 date = "2009-01-15"
dateTo
xsd:string
日付範囲を使用する場合、レポートの実行に使用する終了日。
dateTo を使用する場合は、date を使用しないでください。 日
付形式は YYYY-MM-DD4 桁の年、2 桁の月、2 桁の日 ですが、
月と日はオプションです。 例 date = "2010-01-15"
dateGranularity
tns:reportDefinitionDateGranularity オーバータイムレポートなど、日付ごとにデータを整理するレ
ポートにデータを表示するために使用する時間単位。 例
dateGranularity = "day"
metrics
tns:reportDefinitionMetricList レポートに含めるイベントのリスト。 レポートでは、指標を
少なくとも 1 つ指定する必要があります ランクレポートとオー
バータイムレポートでは 1 つ以上の指標をサポートします。
トレンドレポートでサポートされる指標は 1 つだけです 。例
metrics = [ {id = "pageViews"},{id = "visits"} ]
elements
tns:reportDefinitionElementList オーバータイムレポートではサポートされていません。
レポートの指標データを分類 整理 するエレメントのリスト。
例えば、ブラウザー エレメント ごとにページビュー数 指標
を分類するレポートを生成できます。 例 elements = [ {id
= "trackingCode", classification = "campaigns", top
= 2, startingWith = 10} ]
locale
tns:reportDefinitionLocale レポートを実行する地理的なロケール。
sortBy
xsd:string
現在は実装されていません。
tns:reportDefinitionDateGranularity
レポートデータの表示に使用する期間を指定する値の列挙リスト。
11
SiteCatalyst レポート API
値
説明
hour
現在の時間のレポートデータを表示します。
day
現在の日のレポートデータを表示します。
week
現在の週のレポートデータを表示します。
month
現在の月のレポートデータを表示します。
quarter
現在の四半期のレポートデータを表示します。
year
現在の年のレポートデータを表示します。
tns:reportDefinitionElement
レポートで使用される 1 つのエレメントを識別する構造データタイプ。
名前
タイプ
説明
id
xsd:string
指標レポートに適用するエレメントの名前を指定します。
classification
xsd:string
オプション エレメントの結果を、この分類に含まれる結果のみに
制限します。 例えば、id = "trackingCode" と classification
= "Campaigns" を設定すると、キャンペーン分類に属するすべての
追跡コードのレポートを取得できます。
top
xsd:int
オプション 返すレポートの行数を指定します。 ページに分割した
レポートを生成する場合に、startingWith と共に使用します。 例え
ば、top=5 と指定した場合、返される行は 5 行です。
startingWith
xsd:int
オプション 返すレポートの最初の行を指定します。 ページに分割
したレポートを生成する場合に、top と共に使用します。 例えば、
startingWith=20 と指定した場合、レポートの開始行は行 20 にな
ります。
search
tns:reportDefinitionSearch
selected
array(xsd:string)
オプション エレメントに検索を適用します。
オプション search、top および startingWith でエレメントのパラメー
ターを設定することはせず、代わりに、リクエストする特定項目の
リストを指定します。
注意
• ランクレポートでは、1 つのレポートで複数のエレメントを使用できます。
• トレンドレポートでは、1 つのレポートに 1 つのエレメントのみ指定できます。
• 定義上、オーバータイムレポートでサポートされるのは日付エレメントのみなので、オーバータイムレポートで
使用するエレメントを指定することはできません。 サポートされているエレメントのリストについては、
「SiteCatalyst のエレメント」を参照してください。
12
SiteCatalyst レポート API
tns:reportDefinitionElementList
tns:reportDefinitionElement のリスト。
tns:reportDefinitionLocale
レポートデータの表示に使用する言語を指定する値の列挙リスト。
値
説明
en_US
英語 米国 。
de_DE
ドイツ語 ドイツ 。
es_ES
スペイン語 スペイン 。
fr_FR
フランス語 フランス 。
jp_JP
日本語 日本 。
ko_KR
韓国語 韓国 。
zh_CN
中国語 中国 。
zh_TW
中国語 台湾 。
tns:reportDefinitionMetric
レポートで使用される 1 つの指標を識別する構造。
名前
タイプ
説明
id
xsd:string
レポートに含める指標の ID。
segment
tns:reportDefinitionSegment セグメント定義。 セグメントを使用すると、レポートの生成時に使
用するデータのサブセットを定義できます。 segment を使用する場
合は、segmentID パラメーターを空白のままにします。
segmentID
xsd:string
レポートの生成時に使用するセグメント定義のセグメント ID。
segmentID を使用する場合は、segment パラメーターを空白のままに
します。
注意
• 複数の標準指標を数学的に組み合わせて 1 つの指標を作成することもできます。これは計算指標と呼ばれます。
計算指標について詳しくは、『管理コンソールユーザーガイド』の「Calculated Metrics」を参照してください。
• SiteCatalyst に用意されている指標のカテゴリは次のとおりです。
• コマース サイトの e コマースアクティビティを測定する指標が含まれます。
• トラフィック サイトトラフィックを測定する指標が含まれます。
• オーバータイムレポートには複数カテゴリの指標を含めることができますが、ランクレポートとトレンドレポー
トでサポートされるのは、一度に 1 つのカテゴリの指標のみです。
• サポートされている指標のリストについては、「SiteCatalyst の指標」を参照してください。
13
SiteCatalyst レポート API
tns:reportDefinitionMetricList
tns:reportDefinitionMetric のリスト。
tns:reportDefinitionSearch
レポート定義で使用するためのキーワード検索を定義する構造。
名前
タイプ
説明
type
tns:reportDefinitionSearchType 使用する検索のタイプ。
keywords
array(xsd:string)
searches
tns:reportDefinitionSearches サブ検索のリスト。 これにより、複雑なレポート検索を作成できま
タイプに基づき、検索に含める、または検索から除外するキーワード
のリスト。
す。
tns:reportDefinitionSearches
tns:reportDefinitionSearch のリスト。
tns:reportDefinitionSearchType
レポート検索で複数の検索語句を結合するためのブール値を列挙したリストです。
値
説明
AND
ブール演算子 AND を使用して複数の検索語句を結合します。
OR
ブール演算子 OR を使用して複数の検索語句を結合します。
NOT
ブール演算子 NOT を使用して複数の検索語句を結合します 語句を検索から効率的に除外します 。
tns:reportDefinitionSegment
レポート定義で使用するためのデータセグメントを定義する構造です。
エレメント タイプ
説明
type
tns:reportDefinitionSegmentType セグメントのタイプを指定します。
invert
xsd:boolean
セグメントを、含めるinvert = false セグメントまたは除外す
るinvert = true セグメントと見なします。
operator
tns:booleanOperatorType
含めるセグメントと除外するセグメントを統合する方法を指
定します。
conditions
tns:reportDefinitionSegmentConditions セグメントに含まれるデータを制限する条件のリスト。
segments
tns:reportDefinitionSegmentList レポートの生成時に使用する既存のセグメントのリスト。
events
tns:reportDefinitionSegmentEventList セグメントに含める 1 つ以上のイベントのリスト。
14
SiteCatalyst レポート API
tns:reportDefinitionSegmentCondition
レポート定義に含まれるセグメントに照らして潜在的なレポートデータを評価する方法を定義する構造です。
名前
タイプ
説明
operator
tns:comparisonOperatorType データがすべての条件を満たす必要がある ブール演算子 AND か、い
ずれか 1 つの条件を満たす必要がある ブール演算子 OR かを示しま
す。
invert
xsd:boolean
element
tns:reportDefinitionElement 条件をテストする特定のデータエレメントを識別します 例えば、
条件を、含める invert = false 条件または除外する invert =
true 条件と見なします。
visitNumber 。
metric
array(xsd:string)
セグメントに含まれるデータを制限する条件のリスト。
tns:reportDefinitionSegmentConditions
レポート定義に複数のセグメントを含む構造です。
名前
タイプ
説明
id
tns:booleanOperatorType
データがすべての条件を満たす必要がある ブール演算子
AND か、いずれか 1 つの条件を満たす必要がある ブール演
算子 OR かを示します。
segment
tns:reportDefinitionSegmentConditionList レポートデータの入力時に適用するセグメントのリスト。
tns:reportDefinitionSegmentEvent
セグメントに含める SiteCatalyst イベントを識別する構造です。
名前
タイプ
説明
id
xsd:string
イベントの識別子。
conditions
tns:reportDefinitionSegmentEventList セグメントに含めるイベントのリスト。
tns:reportDefinitionSegmentEventList
tns:reportDefinitionSegmentEvent のリストです。
tns:reportDefinitionSegmentList
レポート定義で使用するためのデータセグメントを定義する構造です。
tns:reportDefinitionSegment のリスト。
tns:reportDefinitionSegmentType
レポート定義にセグメントを追加するときに使用されるセグメントのタイプを列挙したリストです。
15
SiteCatalyst レポート API
値
説明
visitor
訪問者セグメント。
visit
サイト訪問セグメント。
pageView
ページビューセグメント。
event
イベントベースのセグメント。
tns:reportDescription
特定のレポートを作成するための情報を含む構造です。
エレメント
タイプ
説明
reportSuiteID
xsd:string
レポートの生成に使用する SiteCatalyst レポートスイート。 例
reportSuiteID = "corp1"
date
xsd:string
レポートの実行対象となる日付。 date を使用する場合は、
dateFrom と dateTo を使用しないでください。 日付形式は
YYYY-MM-DD4 桁の年、2 桁の月、2 桁の日 ですが、月と日は
オプションです。 例 date = "2009-01"
dateFrom
xsd:string
日付範囲を使用する場合、レポートの実行に使用する開始日。
dateFrom を使用する場合は、date を使用しないでください。
日付形式は YYYY-MM-DD4 桁の年、2 桁の月、2 桁の日 です
が、月と日はオプションです。 例 date = "2009-01-15"
dateTo
xsd:string
日付範囲を使用する場合、レポートの実行に使用する終了日。
dateTo を使用する場合は、date を使用しないでください。 日
付形式は YYYY-MM-DD4 桁の年、2 桁の月、2 桁の日 ですが、
月と日はオプションです。 例 date = "2010-01-15"
dateGranularity
tns:reportDefinitionDateGranularity オーバータイムレポートなど、日付ごとにデータを整理するレ
ポートにデータを表示するために使用する時間単位。 例
dateGranularity = "day"
metrics
tns:reportDefinitionMetricList レポートに含めるイベントのリスト。 レポートでは、指標を
少なくとも 1 つ指定する必要があります ランクレポートとオー
バータイムレポートでは 1 つ以上の指標をサポートします。
トレンドレポートでサポートされる指標は 1 つだけです 。例
metrics = [ {id = "pageViews"},{id = "visits"} ]
elements
tns:reportDefinitionElementList オーバータイムレポートではサポートされていません。
レポートの指標データを分類 整理 するエレメントのリスト。
例えば、ブラウザー エレメント ごとにページビュー数 指標
を分類するレポートを生成できます。 例 elements = [ {id
= "trackingCode", classification = "campaigns", top
= 2, startingWith = 10} ]
locale
tns:reportDefinitionLocale レポートを実行する地理的なロケール。
sortBy
xsd:string
現在は実装されていません。
16
SiteCatalyst レポート API
tns:reportElement
レポート定義に含めるエレメントを定義する構造です。
名前
タイプ
説明
id
xsd:string
エレメント ID。レポートの説明で指定したエレメント ID と一致している必要
があります。
classification
xsd:string
リクエストされた分類の名前 該当する場合 。
name
xsd:string
エレメントの名前。
tns:reportElementList
tns:reportElement のリストです。
tns:reportMetric
レポート定義に含める指標を定義する構造です。
名前
タイプ
説明
id
xsd:string
指標 ID。レポートの説明で指定した指標 ID と一致している必要がありま
す。
name
xsd:string
指標の名前。
type
tns:reportMetricType 指標のタイプ。
tns:reportMetricList
tns:reportMetric のリストです。
tns:reportMetricType
レポート定義に指標を追加するときに使用できる指標タイプを列挙したリストです。
値
説明
number
指標は汎用の数値形式です。
currency
指標は通貨形式です。
tns:report_queue
tns:report_queue_item のリスト。
tns:report_queue_item
リクエストされたレポートに関連するキューデータを含む構造。
17
SiteCatalyst レポート API
名前
タイプ
説明
report_id
xsd:int
キューリクエストの簡潔なステータス情報。
type
xsd:string
キューリクエストの詳しいステータス情報。
queue_time
xsd:string
Report.GetReport でキューレポートのリクエストに使用される ID。
status
xsd:string
レポートのステータス。 status パラメーターは、文字列を列挙したリストです。
次の列挙値があります。
Done レポート処理が完了し、レポートをダウンロードできる状態になりまし
た。
Failed レポート処理が失敗しました。
Ready レポートは処理待機中で、まだ生成されていません。
tns:reportQueueResponse
Report.GetStatus メソッドの呼び出しに対する応答に含まれるデータを定義する構造です。
名前
タイプ
説明
status
xsd:string
キューのリクエストの簡潔なステータス。
statusMsg
xsd:string
キューのリクエストのステータスの長い説明。
reportID
xsd:int
待機済みレポートをリクエストする Report.GetReport によって使用される
ID。
tns:reportReportSuite
リクエストされたレポートに関連するレポートスイートの情報を含む構造です。
名前
タイプ
説明
id
xsd:string
レポートスイート ID。
name
xsd:string
レポートスイートの正式名称。
tns:report_status
リクエストされたレポートの現在のステータスに関するデータを含む構造。
名前
タイプ
説明
report_type
xsd:string
待機済みレポートのタイプranked 、trended または overtime 。
result_size
xsd:int
queue_time
xsd:string
条件付き 完成したデータセットのサイズ バイト数 。
元のキューの時間。
18
SiteCatalyst レポート API
名前
タイプ
status
xsd:string
説明
レポートのステータス。 status パラメーターは、文字列を列挙したリストです。
次の列挙値があります。
Done レポート処理が完了し、レポートをダウンロードできる状態になりまし
た。
Failed レポート処理が失敗しました。 失敗の原因を error_code パラメーターと
error_message パラメーターに示します。
Ready レポートは処理待機中で、まだ生成されていません。
error_code
xsd:int
レポートのエラーコード エラーが返された場合 。
error_msg
xsd:string
エラーメッセージ エラーが返された場合 。
tns:reportType
レポート定義の作成時に使用できるレポートのタイプを列挙したリストです。
値
説明
overtime
オーバータイムレポートをリクエストします。
ranked
ランクレポートをリクエストします。
trended
トレンドレポートをリクエストします。
レポート API リファレンス
レポート API を使用するには、サポートされる指標、エレメント、エラーコードを詳しく知っておく必要があり
ます。
SiteCatalyst のエレメント
SiteCatalyst で使用可能なエレメントのリストを示します。
SiteCatalyst のエレメント
エレメントとは、レポートの指標データをさらに細分化した 内訳を表す 構造です。 例えば、ページへのアクセ
スに使用された Web ブラウザー別 エレメント のページビュー 指標 レポートを生成することができます。 結果
のレポートには、Web ブラウザータイプごとのページビュー数リストが示されます。 tns:reportDefinitionElementList
データタイプを使用すると、レポート定義の中で、レポートに含めるエレメントをパラメーターとして指定する
ことができます。
注: レポートスイートによっては使用できないエレメントがあります。 特定のレポートスイートで使用可能
なエレメント ID のリストを取得するには、ReportSuite.GetAvailableElements 管理 API に含まれ
る を使用してください。
19
SiteCatalyst レポート API
エレメント
説明
accountsummary
SiteCatalyst のアカウントの概要レポートに対応します。
browser
Web ブラウザー 例Internet Explorer 7.0 、Firefox 2.0.8 。
browserHeight
ブラウザーのフレームの高さ 画素数 。
browserType
Web ブラウザーのベンダー 例 Microsoft 、Mozilla、Apple 。
browserWidth
ブラウザーのフレームの幅 画素数 。
category
カテゴリーに分かれた製品のグループ。
connectionType
サイトへのアクセスに使用されたインターネット接続タイプ。
cookiesEnabled
Web ブラウザーでのCookieの有効化の有無。
customerLoyalty
顧客忠誠度の分類。
daysBeforeFirstPurchase
初回訪問から初回購入までの日数。
daysSinceLastPurchase
前回購入からの日数。
domain
サイトへのアクセスに使用された ISP および組織。
entryPage
サイトの入口として使用されたページ。
entryPageOriginal
初めてのサイト訪問時に入口として使用されたページ。
eVar #
指定された eVar。
geoCountry
国。
geoRegion
地域。
geoCity
市区町村。
geoDMA
指定販売地域。
homePage
ユーザーが選択したホームページ。
javaEnabled
Web ブラウザーでの Java の有効化の有無。
javaScriptEnabled
Web ブラウザーでの JavaScript の有効化の有無。
javaScriptVersion
Web ブラウザーで使用されている JavaScript のバージョン。
language
Web ブラウザーの言語。
linkCustom
リンクの使用状況 ユーザーに選ばれたリンク 。
linkDownload
ダウンロードされたコンテンツへのリンク。
linkExit
顧客がサイトを離れるとき使用するサードパーティリンク。
mobileAudioSupport
モバイルデバイスによってサポートされるオーディオ形式。
mobileColorDepth
モバイルデバイスによってサポートされる同時表示色数。
mobileCookieSupport
モバイルデバイスでのCookieの有効化の有無。
mobileDeviceName
モバイルデバイス名。
20
SiteCatalyst レポート API
エレメント
説明
mobileDeviceNumberTransmit
モバイルデバイスのデバイス番号送信がオンまたはオフのどちらになっている
か。
mobileDRM
モバイルデバイスによってサポートされる Digital Rights ManagementDRM
イプForward Lock 、Combined Delivery、Separate Delivery 。
mobileImageSupport
モバイルデバイスでの画像サポートの有無。
mobileInformationServices
モバイルデバイスによってサポートされる情報サービス。
mobileJavaVM
モバイルデバイス上で動作している Java バージョン。
mobileMailDecoration
モバイルデバイスによるデコレーション アニメーション メールサポートの有無
を表すブール値。
mobileManufacturer
モバイルデバイスの製造元。
mobileMaxBookmarkUrlLength
モバイルデバイスによってサポートされるブックマーク URL の最大長 文字数 。
mobileMaxBrowserUrlLength
モバイルデバイスによってサポートされる Web ブラウザー URL の最大長 文字
数 。
mobileMaxMailUrlLength
モバイルデバイスによってサポートされる電子メール URL の最大長 文字数 。
mobileNetProtocols
モバイルデバイスによってサポートされるネットワークプロトコルGPRS 、Edge
など 。
mobileOS
モバイルデバイス上で動作しているオペレーティングシステム。
mobilePushToTalk
モバイルデバイスによる Push to TalkPTT
mobileScreenHeight
モバイルデバイスの画面の高さ 画素数 。
mobileScreenSize
モバイルデバイスの画面サイズ インチ 。
mobileScreenWidth
モバイルデバイスの画面の幅 画素数 。
mobileVideoSupport
モバイルデバイスのビデオサポートの有無。
monitorColorDepth
モバイルデバイスによってサポートされる同時表示色数。
monitorResolution
顧客の画面の解像度。
operatingSystem
顧客のオペレーティングシステム。
page
リロード、ページの深さ、ページでの滞在時間、ページへのクリック回数など、
一般的な Web ページ統計。
pageDepth
ランディングページに基づいて計算した訪問者の最大ページ深さWeb サイトへ
のクリック回数 。
pagesNotFound
訪問者が行方不明のページHTTP 404 エラー に到達した回数。
pathLength
訪問中に表示されたページの数。
product
個別製品。
prop #
指定されたプロパティ。
trackingCode
キャンペーン追跡コードの結果。
のタ
サポートの有無を表すブール値。
21
SiteCatalyst レポート API
エレメント
説明
referrer
顧客が直前に表示していたドメインまたは URL。
referrerType
リファラーのタイプ。 ハードドライブ、その他の Web サイト、検索エンジン、
SNS、入力 ブックマークなどのオプションがあります。
referringDomain
顧客をサイトに誘導したドメイン。
referringDomainOriginal
初めてのサイト訪問時に顧客を誘導したドメイン。
returnFrequency
再度訪問した顧客の数、およびそれまでの期間。
searchEngine
サイトを見つけるために使用された検索エンジン。
searchEngineKeyword
サイトを見つけるために使用された検索エンジンのキーワード。
searchEngineNatural
サイトを見つけるために使用された検索エンジン。
searchEngineNaturalKeyword
サイトを見つけるために使用された自然 無料 検索エンジンのキーワード。
searchEngineNaturalPageRank
検索エンジンの結果のランク。
searchEnginePaid
有料で結果を表示する検索エンジン。
searchEnginePaidKeyword
サイトを見つけるために使用された有料の検索エンジンキーワード。
server
同じサーバーでホストされるページ。
siteSection
サイトを構成する Web ページのグループ。
state
米国の州。
surveybase
分類されていない調査エレメント。 このエレメントは、
ReportSuite.GetClassifications で c_view = survey を指定して取得さ
れた分類と共に使用します。
timeZone
顧客のタイムゾーン。
timeVisit
顧客の滞在時間。
tntBase
分類されていない Test & Target エレメント。 このエレメントは、
ReportSuite.GetClassifications で c_view = tnt を指定して取得され
た分類と共に使用します。
topLevelDomain
発信元ドメインの拡張子.com 、.net、.gov、.edu、.org、および国の拡張子 。
videos
表示されたビデオ。
videoPlayers
ビデオの表示に使用されたビデオプレーヤー。
visitNumber
サイトへの訪問回数。
zip
顧客の郵便番号。
SiteCatalyst の指標
SiteCatalyst で使用可能な指標のリストを示します。
22
SiteCatalyst レポート API
SiteCatalyst の指標
指標とは、レポートに含めるイベントデータのタイプを指定する構造です。 レポートには、少なくとも 1 つの指
標を指定する必要があります。 ランクレポートおよびオーバータイムレポートでは、1 つのレポートに複数の指
標を指定することもできます。 トレンドレポートでは、1 つのレポートに 1 つの指標のみ指定できます。
tns:reportDefinitionMetricList データタイプを使用すると、レポート定義の中で、レポートに含める指標をパラメー
ターとして指定することができます。
注: ただし、レポートタイプによっては特定の指標が有効でないことがあります。また、指標の意味はレポー
トタイプやその他のレポートオプションに応じて異なる場合があります。例えば、インスタンス指標の意味
はリクエストされるエレメントによって異なります。また、レポートスイートによっては使用できない指標
もあります。 特定のレポートスイートで使用可能な指標 ID のリストを取得するには、
ReportSuite.GetAvailableMetrics 管理 API に含まれる を使用してください。
カテゴリ
コマース
指標
carts
説明
チェックアウトの買い物かごの指標。
totalCarts
lifetimeCarts
lifetimeTotalCarts
participationCarts
lifetimeParticipationCarts
コマース
cartAdditions
チェックアウトの買い物かごへの追加に関する指標。
totalCartAdditions
lifetimeCartAdditions
lifetimeTotalCartAdditions
participationCartAdditions
lifetimeParticipationCartAdditions
コマース
cartRemovals
チェックアウトの買い物かごからの削除に関する指標。
totalCartRemovals
lifetimeCartRemovals
lifetimeTotalCartRemovals
participationCartRemovals
lifetimeParticipationCartRemovals
コマース
cartViews
totalCartViews
チェックアウトの買い物かごの表示に関する指標。
23
SiteCatalyst レポート API
カテゴリ
指標
説明
lifetimeCartViews
lifetimeTotalCartViews
participationCartViews
lifetimeParticipationCartViews
コマース
checkouts
チェックアウトアクティビティの指標。
totalCheckout
lifetimeCheckout
lifetimeTotalCheckouts
participationCheckouts
lifetimeParticipationCheckouts
コマース
コマース
instances
orders
特定の値が取得された回数。
注文アクティビティの指標。
totalOrders
lifetimeOrders
lifetimeTotalOrders
participationOrders
lifetimeParticipationOrders
コマース
revenue
e コマースの売上高の指標。
totalRevenue
lifetimeRevenue
lifetimeTotalRevenue
participationRevenue
lifetimeParticipationRevenue
コマース
units
totalUnits
lifetimeUnits
lifetimeTotalUnits
participationUnits
lifetimeParticipationUnits
購入数の指標。
24
SiteCatalyst レポート API
カテゴリ
コマース
指標
customersNew
説明
顧客の指標。
customersReturn
customersLoyal
customersDaily
customersWeekly
customersMonthly
customersQuarterly
customersYearly
コマース
Event #
カスタムイベントの指標1-80
。
例 event2
トラ
フィック
mobileViews
モバイルデバイスの指標。
mobileVisits
mobileVisitorsDaily
トラ
フィック
pageViews
ページビューの指標。
totalPageViews
トラ
フィック
visits
サイト訪問の指標。
totalVisits
averageTimeSpentOnSite
averageVisitDepth
トラ
フィック
visitors
visitorsNew
visitorsHourly
totalVisitorsHourly
visitorsDaily
totalVisitorsDaily
visitorsWeekly
totalVisitorsWeekly
visitorsMonthly
totalVisitorsMonthly
サイト訪問者の指標。
注: 訪問者の指標は、オーバータイムレポートに対して
は無効です。
25
SiteCatalyst レポート API
カテゴリ
指標
説明
visitorsQuarterly
totalVisitorsQuarterly
visitorsYearly
totalVisitorsYearly
トラ
フィック
videoViews
ビデオ使用状況の指標。
videoVisits
videoVisitorsDaily
トラ
フィック
averagePageDepth
パスの指標。
averageTimeSpentOnPage
entries
exits
reloads
singleAccess
SiteCatalyst レポートのエラーコード
レポートの生成が正常に実行されなかった場合に SiteCatalyst によって返されるエラーコードのリストを示します。
レポートエラーコード
SiteCatalyst によるレポートの生成が失敗すると、レポート生成が失敗した理由を表すエラーコードとエラーメッ
セージが返されます。
カテゴリ
説明
5000
現在、リクエストを処理するための十分なリソースがありません。
5001
システムエラーが発生しました。
5002
レポートを作成できませんでした。
5011
無効なレポートタイプです。
5012
無効なレポート定義です。
5020
無効なレポートスイートです。
5021
無効なレポート ID です。
5022
レポート日または日付範囲が無効です。
5023
無効な指標です。
5024
無効なエレメントです。
26
SiteCatalyst レポート API
カテゴリ
説明
5025
無効な検索です。
5026
無効なセグメントです。
5027
無効なセグメント条件です。
5028
無効なイベントです。
5030
コマース指標とトラフィック指標の組み合わせが無効です。
5050
Discover サーバーに接続できません。
5051
Discover サーバーへの接続が失われました。
5052
Discover サーバーがタイムアウトになりました。
レポート API - サンプルコード
SiteCatalyst のレポート API には、次のコードサンプルが付属しています。
オーバータイムレポートのサンプル
基本的なオーバータイムレポートリクエストと、その結果の SiteCatalyst による応答を示すサンプルです。
オーバータイムレポート
警告 コードサンプルをコピー ペーストしてレポートの生成に使用しないでください。 これは、レポート API を
使用してレポートを生成する際の形式や構造のテンプレートとして参照するためのサンプルです。
// This is the object that you pass to the API call - API calls are described in Report
Definition.
reportDescription = {
reportSuiteID = "myrsid",
dateFrom = "2008-01-01",
dateTo = "2008-01-03",
dateGranularity = "day",
metrics = [
{
id = "pageViews"
},
{
id = "visits"
}
]
}
このリクエストに対しては次のような応答が返されます。
report = {
reportSuite = {
id = "myrsid",
name = "My Report Suite"
},
period = "Mon. 1 Jan. 2008- Wed.
elements = [
{
id = "datetime",
name = "Date"
}
],
3 Jan. 2008",
SiteCatalyst レポート API
27
metrics = [
{
id = "pageViews",
name = "Page Views",
type = "number"
},
{
id = "visits",
name = "Visits",
type = "number"
},
],
type = "overtime",
data = [
{
name = "Mon. 1 Jan. 2008",
year = 2008,
month = 1,
day = 1,
counts = [2,2]
},
{
name = "Tue. 2 Jan. 2008",
year = 2008,
month = 1,
day = 2,
counts = [1143,131]
},
{
name = "Wed. 3 Jan. 2008",
year = 2008,
month = 1,
day = 3,
counts = [1212,146],
}
],
totals = [2357,276]
}
ランクレポートのサンプル
基本的なランクレポートリクエストと、その結果の SiteCatalyst による応答を示すサンプルです。
ランクレポート
警告 コードサンプルをコピー ペーストしてレポートの生成に使用しないでください。 これは、レポート API を
使用してレポートを生成する際の形式や構造のテンプレートとして参照するためのサンプルです。
// This is the object that you pass to the API call - API calls are described in Table 5.1.
// Definitions and data for the parts of the object are in Report Definition.
reportDescription = {
reportSuiteID = "myrsid",
date = "2008-01",
metrics = [
{
id = "orders"
}
],
elements = [
{
id = "trackingCode",
classification = "Campaigns",
top = 2,
startingWith = 10
},
{
SiteCatalyst レポート API
id = "trackingCode",
top = 2,
}
]
}
このリクエストに対しては次のような応答が返されます。
report = {
reportSuite = {
id = "myrsid",
name = "My Report Suite",
},
period = "Jan. 2008",
elements = [
{
id = "trackingCode",
name = "Tracking Code",
classification = "Campaigns",
},
{
id = "trackingCode",
name = "Tracking Code",
}
],
metrics = [
{
id = "orders",
name = "Orders",
type = "number"
},
],
type = "ranked",
data = [
{
name = "Campaign J",
counts = [100],
breakdown = [
{
name = "Tracking Code IV",
counts = [15]
},
{
name = "Tracking Code II",
counts = [3]
},
]
},
{
name = "Campaign D",
counts = [85],
breakdown = [
{
name = "Tracking Code X",
counts = [25]
}
]
}
],
totals = [1342]
}
トレンドレポートのサンプル
基本的なトレンドレポートリクエストと、その結果の SiteCatalyst による応答を示すサンプルです。
28
SiteCatalyst レポート API
29
トレンドレポート
警告 コードサンプルをコピー ペーストしてレポートの生成に使用しないでください。 これは、レポート API を
使用してレポートを生成する際の形式や構造のテンプレートとして参照するためのサンプルです。
// This is the object that you pass to the API call - API calls are described in Table 5.1.
// Definitions and data for the parts of the object are in Report Definition.
reportDescription = {
reportSuiteID = "myrsid",
dateFrom = "2008-07-01",
dateTo = "2008-07-03",
dateGranularity = "day",
metrics = [
{
id = "pageViews"
}
],
elements = [
{
id = "page",
top = 2
}
]
}
このリクエストに対しては次のような応答が返されます。
report = {
reportSuite = {
id = "myrsid",
name = "My Report Suite"
},
period = "Sun. 1 Jul. 2008 - Tue. 3 Jul. 2008",
elements = [
{
id = "page",
name = "Page"
},
{
id = "datetime",
name = "Date",
}
],
metrics = [
{
id = "pageViews",
name = "Page Views",
type = "number"
}
],
type = "trended",
data = [
{
name = "Home Page",
url = "http://www.mysite.com/",
counts = [350],
breakdown = [
{
name = "Sun. 1 Jul. 2008",
year = 2008,
month = 7,
day = 1,
counts = [40]
},
{
name = "Mon. 2 Jul. 2008",
year = 2008,
month = 7,
day = 2,
SiteCatalyst レポート API
30
counts = [160]
},
{
name = "Tue. 3 Jul. 2008",
year = 2008,
month = 7,
day = 3,
counts = [150]
}
],
},
{
name = "Buy Page",
url = "http://www.mysite.com/buy.html",
counts = [80],
breakdown = [
{
name = "Sun. 1 Jul. 2008",
year = 2008,
month = 7,
day = 1,
counts = [5]
},
{
name = "Mon. 2 Jul. 2008",
year = 2008,
month = 7,
day = 2,
counts = [60]
},
{
name = "Tue. 3 Jul. 2008",
year = 2008,
month = 7,
day = 3,
counts = [15]
}
],
},
],
totals = [2357]
}
キーワード検索のサンプル
キーワードを含むレポートリクエストの作成と、その結果の SiteCatalyst による応答を示すサンプルです。
キーワード検索レポート
警告 コードサンプルをコピー ペーストしてレポートの生成に使用しないでください。 これは、レポート API を
使用してレポートを生成する際の形式や構造のテンプレートとして参照するためのサンプルです。
reportDescription = {
reportSuiteID = "myrsid",
date = "2008-01",
metrics = [
{
id = "pageViews"
}
],
elements = [
{
id = "page",
top = 3,
search = {
type = "OR",
SiteCatalyst レポート API
keywords = ["help","faq"]
}
}
]
}
このリクエストに対しては次のような応答が返されます。
report = {
reportSuite = {
id = "myrsid",
name = "My Report Suite"
},
period = "January 2008",
elements = [
{
id = "page",
name = "Page"
}
],
metrics = [
{
id = "pageViews",
name = "Page Views",
type = "number"
}
],
type = "ranked",
data = [
{
name = "Customer Help",
url = "http://www.mydomain.com/help.html",
counts = [12]
},
{
name = "FAQ",
url = "http://www.mydomain.com/faq.html",
counts = [5]
}
],
totals = [23962]
}
31

九州大学北海道演習林の地衣類

伝統的な広告手法（テレビ・新聞・雑誌等）は 車を買う人にとって信頼

電子プロセスの転倒

超新星命名の新システムについて 超新星研究者のグループ（SN

アスクル株式会社様 - ソフトバンク・テクノロジー

MPEG-2 AAC方式の運用に関する技術解説

春日井中央ホテル お客さまの立場で考えた、GHPによる快適な空間

“オンラインビジネス最適化”サービスで販売提携

Ver.1 2016年6月（ドイツ）