CData Sync App は、Adobe Analytics データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Adobe Analytics コネクタはCData Sync アプリケーションから使用可能で、Adobe Analytics からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はAdobe Analytics API v2.0 を利用して、dimensions、metrics、users などのAdobe Analytics オブジェクトへの接続を可能にします。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Adobe Analytics に接続するには、GlobalCompanyId およびRSID を識別する必要があります。デフォルトで、Sync App は会社とレポートスイートの識別を自動で試みます。しかし、これらの値を明示的に指定することもできます。
GlobalCompanyId はオプションの接続プロパティです。空のままにすると、Sync App は自動的にGlobal Company ID の検出を試みます。 Global Company ID を見つけるには:
RSID もオプションの接続プロパティです。設定されていない場合、ドライバーが自動的に検出を試みます。すべてのレポートスイートとその識別子を表示するには、管理者 -> レポートスイートに進みます。
Adobe Analytics はOAuth 認証標準を利用しています。 OAuth 統合またはサービスアカウント統合で認証できます。
すべてのユーザーアカウントフローでAuthScheme をOAuth に設定する必要があります。
サービスアカウントには、ブラウザによるユーザー認証が不要なサイレント認証があります。
このフローでは、アプリケーションを作成する必要があります。アプリケーションの作成および認可については、カスタムOAuth アプリの作成 を参照してください。これでサービスアカウントにアクセス権があるAdobe Analytics データに接続できます。
この方法で認証するには、AuthScheme をOAuthClient に設定します。
接続するには次のプロパティを設定します。
接続すると、Sync App はサービスアカウントでのOAuth フローを完了します。
このセクションでは、Adobe Analytics Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Sync App は、ビューおよびストアドプロシージャを使用してAdobe Analytics オブジェクトを使いやすいSQL データベースとしてモデル化します。これらは、スキーマファイルで定義されます。スキーマファイルは、データの構造と構成を定義する、シンプルで読みやすいテキストファイルです。
ビュー セクションには読み取り専用SQL テーブルの一覧が記載されています。これらには、Adobe Analytics アカウントでのアクセスを想定したサンプルが含まれています。
以下のビューはアプリケーションに含まれます。
| ビュー | 説明 |
| CalculatedMetrics | Retrieve a list of all calculated metrics defined within your Adobe Analytics environment, including custom formulas built on top of standard metrics. |
| CollectionSuites | Return the list of data collection suites configured in Adobe Analytics, which represent logical groupings of tracking data within a report suite. |
| Dimensions | List all available dimensions that can be used to segment and break down Adobe Analytics data, such as page name, device type, or campaign. |
| KeyMetrics | Display high-level engagement metrics like page views and visits for a specified time range (defaults to the past 30 days). |
| LastTouchChannel | Identify the last marketing channel attributed to each visitor during their session, based on Adobe's last-touch attribution model. |
| LastTouchChannelDetail | View detailed attributes of the last-touch marketing channel, such as referring domain, tracking code, or campaign ID. |
| Metrics | Retrieve all available standard and custom metrics that measure user behavior and site performance in Adobe Analytics. |
| Orders | Summarize the total number of purchase events recorded across all tracked orders within a specified time period (defaults to 30 days). |
| PageOccurrences | Display the number of times a page was involved in a tracked interaction or persisted as a dimension value within the selected reporting window. |
| Pages | Identify pages on your site ranked by popularity, based on views and interactions during a selected reporting period (defaults to 30 days). |
| PageViews | Show the total number of page views recorded, helping you understand overall traffic volume over a specified date range. |
| Products | Return order counts grouped by product name or SKU, allowing analysis of top-performing items sold within the last 30 days. |
| Revenue | Aggregate the total revenue generated from all completed orders within the reporting period (defaults to 30 days). |
| Segments | Retrieve the list of predefined and custom segments available in your Adobe Analytics account, including shared and curated segments. |
| SiteSections | Identify the most trafficked or highest-converting sections of your site, based on page grouping and content hierarchy. |
| TrackingCode | View which marketing or campaign tracking codes drove the most traffic to your site over a given period. |
| Units | Show the total number of individual product units purchased across all orders in the selected reporting window. |
| UniversalReport | Run a unified report that includes all configured dimensions and metrics for a broad view of user behavior and performance. |
| Users | List the users who have access to Adobe Analytics, including login details, roles, and account status. |
| Visitors | Display the total number of unique individuals who accessed your site during the reporting period (defaults to the past 30 days). |
| Visits | Show the number of individual sessions recorded during the specified date range, regardless of visitor identity. |
ストアドプロシージャ は、標準的なCRUD 操作を超える機能を持つSQL スクリプトです。これらは、Adobe Analytics API の追加機能を利用可能にします。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| CalculatedMetrics | Retrieve a list of all calculated metrics defined within your Adobe Analytics environment, including custom formulas built on top of standard metrics. |
| CollectionSuites | Return the list of data collection suites configured in Adobe Analytics, which represent logical groupings of tracking data within a report suite. |
| Dimensions | List all available dimensions that can be used to segment and break down Adobe Analytics data, such as page name, device type, or campaign. |
| KeyMetrics | Display high-level engagement metrics like page views and visits for a specified time range (defaults to the past 30 days). |
| LastTouchChannel | Identify the last marketing channel attributed to each visitor during their session, based on Adobe's last-touch attribution model. |
| LastTouchChannelDetail | View detailed attributes of the last-touch marketing channel, such as referring domain, tracking code, or campaign ID. |
| Metrics | Retrieve all available standard and custom metrics that measure user behavior and site performance in Adobe Analytics. |
| Orders | Summarize the total number of purchase events recorded across all tracked orders within a specified time period (defaults to 30 days). |
| PageOccurrences | Display the number of times a page was involved in a tracked interaction or persisted as a dimension value within the selected reporting window. |
| Pages | Identify pages on your site ranked by popularity, based on views and interactions during a selected reporting period (defaults to 30 days). |
| PageViews | Show the total number of page views recorded, helping you understand overall traffic volume over a specified date range. |
| Products | Return order counts grouped by product name or SKU, allowing analysis of top-performing items sold within the last 30 days. |
| Revenue | Aggregate the total revenue generated from all completed orders within the reporting period (defaults to 30 days). |
| Segments | Retrieve the list of predefined and custom segments available in your Adobe Analytics account, including shared and curated segments. |
| SiteSections | Identify the most trafficked or highest-converting sections of your site, based on page grouping and content hierarchy. |
| TrackingCode | View which marketing or campaign tracking codes drove the most traffic to your site over a given period. |
| Units | Show the total number of individual product units purchased across all orders in the selected reporting window. |
| UniversalReport | Run a unified report that includes all configured dimensions and metrics for a broad view of user behavior and performance. |
| Users | List the users who have access to Adobe Analytics, including login details, roles, and account status. |
| Visitors | Display the total number of unique individuals who accessed your site during the reporting period (defaults to the past 30 days). |
| Visits | Show the number of individual sessions recorded during the specified date range, regardless of visitor identity. |
Retrieve a list of all calculated metrics defined within your Adobe Analytics environment, including custom formulas built on top of standard metrics.
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Id [KEY] | String | System-assigned unique ID used to reference the calculated metric in API calls, queries, or configuration files. | ||||
| Name | String | Descriptive label for the calculated metric, used in dashboards, reports, and metric selectors. | ||||
| ReportSuiteName | String | Name of the Adobe Analytics report suite in which the calculated metric is defined. | ||||
| Description | String | Clarifies the metric's purpose, formula logic, and how it contributes to business analysis. | ||||
| Created | Datetime | Timestamp of when the calculated metric was first created within Adobe Analytics. | ||||
| Modified | Datetime | Timestamp of the last modification to the metric's configuration, logic, or metadata. | ||||
| Type | String | Data type used to format the calculated metric's output. Common values: int, decimal, percentage, currency. | ||||
| OwnerId | String | ID of the Adobe Analytics user who originally created the calculated metric. | ||||
| OwnerName | String | Full name of the user listed as the creator and owner of the metric. | ||||
| Category | String | User-defined tag or folder used to categorize the calculated metric for easier management. | ||||
| SiteTitle | String | Title of the website or digital asset linked to the report suite where this metric is used. | ||||
| Polarity | String | Indicates whether a higher value for the metric is favorable or unfavorable. Valid values: positive, negative. | ||||
| Precision | Integer | Controls the number of digits displayed after the decimal point for the metric in reports. | ||||
| Template | String | Template ID used to generate this metric from a predefined calculation blueprint. Applies only when IncludeType = templates. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| IncludeType | String | Determines which types of calculated metrics to return. Options: all (all company metrics), shared (metrics shared with the user), and templates (metric templates only). |
Return the list of data collection suites configured in Adobe Analytics, which represent logical groupings of tracking data within a report suite.
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Rsid [KEY] | String | Unique identifier of the collection suite. | ||||
| Name | String | The name of the collection suite. | ||||
| ParentRsid | String | Unique identifier of the parent of this collection suite. | ||||
| Currency | String | Default currency used in this collection suite. | ||||
| Type | String | The type of the collection suite. For example, report suite. | ||||
| Timezone | String | The timezone of the collection suite. |
List all available dimensions that can be used to segment and break down Adobe Analytics data, such as page name, device type, or campaign.
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Id [KEY] | String | Unique identifier of the dimension. | ||||
| RSID | String | Unique identifier of the report suite the dimension is in. | ||||
| Title | String | The title of the dimension. | ||||
| Name | String | The name of the dimension. | ||||
| Type | String | The type of the dimension. For example string, int, enum etc. | ||||
| Description | String | A description of the dimension. | ||||
| Category | String | The category of the dimension. | ||||
| Pathable | Boolean | Whether or not the dimension is pathable. | ||||
| Segmentable | Boolean | Whether or not the dimension is segmentable. | ||||
| ReportType | String | The type of the reports in which this dimension is valid. | ||||
| Support | String | The type of the reports in which this dimension is supported. |
Display high-level engagement metrics like page views and visits for a specified time range (defaults to the past 30 days).
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [KeyMetrics] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Date | Date | True | True | The day the given metrics occurred. | ||
| PageViews | Int | True | True | The number of times a given dimension item was set or persisted on a page. It is one of the most common and basic metrics in reports. | ||
| Visits | Int | True | True | The number of sessions across all visitors on the site. | ||
| UniqueVisitors | Int | True | True | The number of unique individuals who have visited the site during a specified time period. This can help you understand the overall reach of the site. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
Identify the last marketing channel attributed to each visitor during their session, based on Adobe's last-touch attribution model.
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [LastTouchChannel] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| LastTouchChannel | String | True | True | The most recent marketing channel attributed to a visitor before a conversion or key interaction, based on Adobe Analytics attribution rules. | ||
| UniqueVisitors | Int | True | True | The count of distinct users who visited the site during the selected date range, based on browser cookies or visitor IDs. | ||
| StartDate | String | The start date for the reporting period used to filter and return relevant data. | ||||
| EndDate | String | The end date for the reporting period used to filter and return relevant data. | ||||
| SegmentId | String | The ID of a user-defined or system-defined segment used to limit the report data to specific audience criteria. |
View detailed attributes of the last-touch marketing channel, such as referring domain, tracking code, or campaign ID.
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [LastTouchChannelDetail] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| LastTouchChannelDetail | String | True | True | Specific subcategory or granular value of the last marketing channel attributed to a visitor before a conversion or significant interaction. | ||
| UniqueVisitors | Int | True | True | The number of distinct users who accessed the site during the defined reporting period, based on visitor identification mechanisms. | ||
| StartDate | String | The starting date of the reporting window used to filter data. | ||||
| EndDate | String | The ending date of the reporting window used to filter data. | ||||
| SegmentId | String | The unique identifier of a segment used to restrict the dataset to a specific audience or behavior group. |
Retrieve all available standard and custom metrics that measure user behavior and site performance in Adobe Analytics.
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Id [KEY] | String | Unique identifier of the metric. | ||||
| RSID | String | Unique identifier of the report suite the metric is in. | ||||
| Title | String | The title of the metric. | ||||
| Name | String | The name of the metric. | ||||
| Type | String | The type of the metric, for example int, percent, currency etc. | ||||
| Description | String | A description for the metric. | ||||
| Category | String | The category of the metric. | ||||
| Calculated | Boolean | Whether or not this metric is calculated metric. | ||||
| Segmentable | Boolean | Whether or not this metric is segmentable. | ||||
| Polarity | String | Takes two value: positive and negative. Determines if it's positive or not if the metric increases. | ||||
| Precision | Integer | The precision of the metric. |
Summarize the total number of purchase events recorded across all tracked orders within a specified time period (defaults to 30 days).
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [Orders] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Date | Date | True | True | The day the given metric occurred. | ||
| Orders | Int | True | True | The total number of purchase events made on your site. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to an order. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
Display the number of times a page was involved in a tracked interaction or persisted as a dimension value within the selected reporting window.
This predefined report view is based on the 'Next Page' and 'Previous Page' Adobe Analytics template. If no segment filter is specified, this view returns a report containing only the Page dimension and the Occurrences metric. To generate a 'Next Page' or 'Previous Page' report, you must specify the corresponding segment using the SegmentId column in the WHERE clause.
By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
An example query would be:
SELECT * FROM [PageOccurrences] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Page | String | True | True | The names of pages on your site. | ||
| Occurrences | Double | True | True | The number of hits where a given dimension was set or persisted. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
Identify pages on your site ranked by popularity, based on views and interactions during a selected reporting period (defaults to 30 days).
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [Pages] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Page | String | True | True | The names of pages on your site. | ||
| PageViews | Int | True | True | Shows the number of times a given dimension item was set or persisted on a page. It is one of the most common and basic metrics in reports. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
Show the total number of page views recorded, helping you understand overall traffic volume over a specified date range.
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [PageViews] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Date | Date | True | True | The day the given metric occurred. | ||
| PageViews | Int | True | True | Shows the number of times a given dimension item was set or persisted on a page. It is one of the most common and basic metrics in reports. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
Return order counts grouped by product name or SKU, allowing analysis of top-performing items sold within the last 30 days.
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [Products] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Product | String | True | True | The name of the product in the hit. | ||
| Orders | Int | True | True | The total number of purchase events made on your site. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to an order. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
Aggregate the total revenue generated from all completed orders within the reporting period (defaults to 30 days).
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [Revenue] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Date | Date | True | True | The day the given metric occurred. | ||
| Revenue | Decimal | True | True | The monetary amount of products purchased within all orders. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to revenue. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
Retrieve the list of predefined and custom segments available in your Adobe Analytics account, including shared and curated segments.
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Id [KEY] | String | Unique identifier of the segment. | ||||
| Name | String | The name of the segment. | ||||
| ReportSuiteName | String | The name of the report suite the segment was created in. | ||||
| Description | String | A description for the segment. | ||||
| Created | Datetime | The datetime the segment was created. | ||||
| Modified | Datetime | The datetime the segment was last modified. | ||||
| OwnerId | String | The unique identifier of the user that created the segment. | ||||
| OwnerName | String | The name of the user that created the segment. | ||||
| Version | String | The version of the segment. | ||||
| Type | String | A comma-separated list of segment types. Allowed values are: shared,templates,curatedItem . | ||||
| SiteTitle | String | The title of the site. |
Identify the most trafficked or highest-converting sections of your site, based on page grouping and content hierarchy.
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [SiteSections] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| SiteSection | String | True | True | The names of site sections on your site. | ||
| Visits | Int | True | True | The number of sessions across all visitors on the site. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
View which marketing or campaign tracking codes drove the most traffic to your site over a given period.
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [TrackingCode] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| TrackingCode | String | True | True | The names of tracking codes on your site. | ||
| Visits | Int | True | True | The number of sessions across all visitors on the site. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
Show the total number of individual product units purchased across all orders in the selected reporting window.
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [Units] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Date | Date | True | True | The day the given metric occurred. | ||
| Units | Int | True | True | The total number of products purchased within all orders. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to the number of products purchased. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
Run a unified report that includes all configured dimensions and metrics for a broad view of user behavior and performance.
This view includes every available dimension and metric. To create a valid custom Adobe Analytics report, ensure your SELECT query includes at least one metric column along with any desired subset of dimension columns from the list.
To define the reporting period, specify the StartDate and EndDate in your WHERE clause. If no dates are specified, the report defaults to a period starting from two years ago up to today. If only a StartDate is provided, the EndDate defaults to today, and if only an EndDate is provided, the StartDate defaults to two years ago from the specified EndDate.
You can also filter the report to a specific segment by including the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT [Time Spent on Page - Bucketed], [Browser], [Browser Height - Bucketed], [Browser Type], [Average Page Depth], [Average Time Spent on Site (seconds)], [Bot Occurrences], [Bot Page Views], [Bounce Rate] FROM [UniversalReport] WHERE [StartDate] = '2023-01-01' AND [EndDate] = '2023-01-31' AND [SegmentId] = 's300012345_1234567890'
This approach enables you to generate a tailored report by choosing the specific columns and applying the necessary date range and segment filters directly in your query.
Date is the default dimension for this report as well, so the query:
SELECT * FROM [UniversalReport]
will become:
SELECT Date, {all the metrics here} FROM [UniversalReport]
Occurrences is the default metric for this report if no valid metric is specified in the query, so the query:
SELECT Date FROM [UniversalReport]
will become:
SELECT Date, Occurrences FROM [UniversalReport]
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Date | Date | True | True | The 'Date' dimension. | ||
| Occurrences | Int | True | True | The number of hits where a given dimension was set or persisted. | ||
| Time Spent on Page - Bucketed | String | True | The amount of time a visitor spends on the page. The amount of time is categorized into different time ranges or | |||
| Bot Name | String | True | Shows the names of the bots detected or custom bot rules supplied. | |||
| Browser | String | True | Shows the name and version of the browser used to access the site. | |||
| Browser Height - Granular | String | True | Categorizes site visitors based on the height of their browser window. | |||
| Browser Height - Bucketed | String | True | Shows the height of the browser window, classified in groups of 100 pixels. | |||
| Browser Type | String | True | Shows the name of browser providers used to access the site (such as Google and Apple). | |||
| Browser Width - Granular | String | True | Shows the width of the browser window, classified in groups of 100 pixels. | |||
| Browser Width - Bucketed | String | True | Shows the width of the browser window, classified in groups of 100 pixels. This can help you optimize content for viewing. | |||
| Tracking Code | String | True | The 'Tracking Code' dimension. | |||
| Category | String | True | The product category of the hit. If your implementation uses the 'products' variable, this can help you see metrics about the product category, such as top sellers or most viewed. | |||
| ClickMap Action (Legacy) | String | True | Identifies the type of click that a visitor made on a specific element of a web page. | |||
| ClickMap Action Type (Legacy) | String | True | The 'ClickMap Action Type (Legacy)' dimension. | |||
| ClickMap Context (Legacy) | String | True | The 'ClickMap Context (Legacy)' dimension. | |||
| ClickMap Context Type (Legacy) | String | True | The 'ClickMap Context Type (Legacy)' dimension. | |||
| ClickMap Source ID (Legacy) | String | True | The 'ClickMap Source ID (Legacy)' dimension. | |||
| ClickMap Tag (Legacy) | String | True | The 'ClickMap Tag (Legacy)' dimension. | |||
| Code Version | String | True | The 'Code Version' dimension. | |||
| Color Depth | String | True | The number of colors that a screen supports. | |||
| Connection Type | String | True | The method used by a visitor to connect to the internet, such as a wired or wireless connection. This can help you know how to optimize site content based on visitors' connection speeds. | |||
| Cookie Support | String | True | Whether a visitor's browser supports cookies for a given hit. This can help you determine the ratio of visitors who use browsers that support cookies, and those who intentionally disable them. | |||
| Currency | String | True | The 'Currency' dimension. | |||
| Currency Factor | String | True | The 'Currency Factor' dimension. | |||
| Currency Rate | String | True | The 'Currency Rate' dimension. | |||
| Custom Hit Time UTC | String | True | The 'Custom Hit Time UTC' dimension. | |||
| Customer Loyalty | String | True | The degree to which visitors consistently engage with and return to the site over time. This can help you understand how the site affects purchasing behavior. | |||
| Customer Perspective | String | True | The 'Customer Perspective' dimension. | |||
| Custom Link | String | True | Shows the names of custom links on your site. This can help you understand the types of links visitors most often click. | |||
| Custom Visitor ID | String | True | The 'Custom Visitor ID' dimension. | |||
| Daily Unique Customers | String | True | The number of unique visitors per day. | |||
| Hour | String | True | The hour that a given metric occurred (rounded down). This can help you see metrics over time in trended reports. | |||
| Minute | String | True | The minute that a given metric occurred (rounded down). This can help you see metrics over time in trended reports. | |||
| Month | String | True | The month that a given metric occurred. This can help you see metrics over time in trended reports. | |||
| Quarter | String | True | The quarter that a given metric occurred. This can help you see metrics over time in trended reports. | |||
| Week | String | True | The week that a given metric occurred. This can help you see metrics over time in trended reports. | |||
| Year | String | True | The year that a given metric occurred. | |||
| Days Before First Purchase | String | True | The number of days between a user's first visit to a website and their first purchase. | |||
| Days Since Last Purchase | String | True | The number of days between a visitor's current visit and their most recent purchase. This can help you understand visitor behavior after making a purchase on the site. | |||
| Days Since Last Visit | String | True | The number of days between a visitor's current visit and their most recent visit. This can help you understand visitor behavior after visiting the site. | |||
| Domains | String | True | Access points that visitors use to access the internet. | |||
| Download Link | String | True | The names of download links on the site. This can help you understand things like which files are downloaded most frequently and whether visitors download different file types if offered. | |||
| Duplicate Purchase | String | True | The 'Duplicate Purchase' dimension. | |||
| Entry Page | String | True | The names of pages on your site. This can help you understand which pages on your site perform the best. This is one of the most commonly used dimensions. | |||
| Visit Start Page | String | True | The 'Visit Start Page' dimension. | |||
| Entry Page Original | String | True | The first page viewed by a visitor when they enter the site. | |||
| Entry Custom Insight 1 | String | True | The 'Entry Custom Insight 1' dimension. | |||
| Entry Custom Insight 2 | String | True | The 'Entry Custom Insight 2' dimension. | |||
| Entry Custom Insight 3 | String | True | The 'Entry Custom Insight 3' dimension. | |||
| Entry Custom Insight 4 | String | True | The 'Entry Custom Insight 4' dimension. | |||
| Entry Custom Insight 5 | String | True | The 'Entry Custom Insight 5' dimension. | |||
| Entry Server | String | True | The 'Entry Server' dimension. | |||
| Entry Site Section | String | True | Lists the names of site sections on your site. For large sites, it is helpful to group pages into sections. This dimension is useful to see the top-viewed or top-performing site sections. | |||
| Internal Campaign | String | True | The 'Internal Campaign' dimension. | |||
| Internal Search Terms | String | True | The 'Internal Search Terms' dimension. | |||
| Exit Link | String | True | The names of links that leads visitors away from the site. This can help you understand which links are most popular that point to domains outside of your site. | |||
| Exit Page | String | True | The names of pages on your site. This can help you understand which pages on your site perform the best. This is one of the most commonly used dimensions. | |||
| Exit Server | String | True | The 'Exit Server' dimension. | |||
| Exit Site Section | String | True | Lists the names of site sections on your site. For large sites, it is helpful to group pages into sections. This dimension is useful to see the top-viewed or top-performing site sections. | |||
| Domain | String | True | The 'Domain' dimension. | |||
| First Touch Channel | String | True | The first marketing channel a visitor matches with during their engagement period. This can help you understand which marketing channels drive initial traffic to the site. | |||
| First Touch Channel Detail | String | True | The first marketing channel a visitor matches with during their engagement period. This can help you understand what contributed to the hit matching a marketing channel. | |||
| Cities | String | True | The geographic location of a visitor at the city level. | |||
| Geo Segmentation Cities | String | True | The 'Geo Segmentation Cities' dimension. | |||
| Countries | String | True | The geographic location of a visitor at the country level. | |||
| US DMA | String | True | The geographic location of a visitor at the Designated Market Area (DMA) level. | |||
| Geo Latitude | String | True | The 'Geo Latitude' dimension. | |||
| Geo Longitude | String | True | The 'Geo Longitude' dimension. | |||
| Regions | String | True | The geographic location of a visitor at the region level. | |||
| Geo Zip | String | True | The 'Geo Zip' dimension. | |||
| Hit Datetime | String | True | The date and time of a visitor's interaction with the site. | |||
| Hit Date Time Offset | String | True | The 'Hit Date Time Offset' dimension. | |||
| Hit Depth | String | True | How far into a visit a given hit is. This can help you understand how long it takes for visitors to perform actions on the site. | |||
| Hit Time UTC | String | True | The 'Hit Time UTC' dimension. | |||
| First Hit Time UTC | String | True | The 'First Hit Time UTC' dimension. | |||
| Hit Type | String | True | Shows whether a mobile app was in the foreground or background when the hit was sent to Adobe data collection servers. | |||
| Home Page | String | True | The 'Home Page' dimension. | |||
| IP Address | String | True | The 'IP Address' dimension. | |||
| IP Address 2 | String | True | The 'IP Address 2' dimension. | |||
| Java Enabled | String | True | Determines if a visitor's browser at the time of a visit has Java enabled. This is helpful if you want to introduce Java-based functionality on the site but you aren't sure how many visitors already have Java enabled. | |||
| Javascript Support | String | True | The 'Javascript Support' dimension. | |||
| Javascript Version | String | True | The 'Javascript Version' dimension. | |||
| Language | String | True | A visitor's preferred language as defined in the browser. This can aid in localization efforts by helping you understand the languages most preferred by visitors. | |||
| Last Touch Channel | String | True | The most recent marketing channel a visitor matches with during that visitor's engagement period. This can help you understand which marketing channels drive traffic to your site that result in conversions. | |||
| Last Touch Channel Detail | String | True | Details about the most recent marketing channel a visitor matches with during that visitor's engagement period. This can help you understand what contributed to the hit matching a marketing channel. | |||
| Latitude | String | True | The 'Latitude' dimension. | |||
| Visitor State | String | True | The 'Visitor State' dimension. | |||
| Longitude | String | True | The 'Longitude' dimension. | |||
| Marketing Channel | String | True | The most recent marketing channel a visitor matches with during that visitor's engagement period. This can help you understand which marketing channels drive traffic to your site that result in conversions. This functions identically to the 'Last Touch Channel.' | |||
| Marketing Channel Detail | String | True | Details about the most recent marketing channel a visitor matches with during that visitor's engagement period. This can help you understand what contributed to the hit matching a marketing channel. This functions identically to the 'Last Touch Channel Detail.' | |||
| Experience Cloud Visitor ID | String | True | The 'Experience Cloud Visitor ID' dimension. | |||
| Mobile Audio Support | String | True | The file formats the device can play. | |||
| Mobile Max Bookmark Length | String | True | The maximum number of bytes that the mobile device supports in bookmarked URLs. Recent devices typically do not have a limit. | |||
| Mobile Carrier | String | True | The telecommunications company that provides cellular network connectivity to a mobile device. | |||
| Mobile Color Depth | String | True | The color depth of the mobile device, in bits. | |||
| Mobile Cookie Support | String | True | The ability of a mobile device to store and manage browser cookies. | |||
| Mobile Device | String | True | The model of the mobile device used to access the site. | |||
| Mobile Device Number | String | True | Shows if the mobile device transmits its number. | |||
| Mobile Device Type | String | True | The type of mobile device used to access the site (such as phone, tablet, or television). | |||
| Mobile DRM | String | True | The type of DRM the mobile device supports. | |||
| Mobile Max Email Length | String | True | The maximum number of bytes that the mobile device supports in an email. Recent devices typically do not have a limit. | |||
| Mobile Image Support | String | True | The ability of mobile devices that access the site to display and render images on the site. | |||
| Mobile Information Services | String | True | The types of news services supported by the device. Recent devices typically do not report this information. | |||
| Mobile Java VM | String | True | The versions of Java that the device supports. | |||
| Mobile Mail Decoration | String | True | Determines if the device supports Decomail, a feature once popular on Japanese devices. | |||
| Mobile Manufacturer | String | True | The manufacturer of the mobile device used to access the site (such as Apple or Samsung). | |||
| Mobile Net Protocols | String | True | The communication protocols used by mobile devices to access the site (such as Edge, GPRS, UMTS, and LTE). | |||
| Mobile Operating System (deprecated) | String | True | This dimension is deprecated. Use 'Operating system' instead. | |||
| Mobile Push To Talk | String | True | Determines if the device supports PTT (Push to talk), which allows the mobile device to behave similar to a two-way radio. Recent devices typically do not report this feature. | |||
| Mobile Screen Height | String | True | The height of the screen, in pixels. | |||
| Mobile Screen Size | String | True | The full dimensions of the mobile device, in pixels. | |||
| Mobile Screen Width | String | True | The width of the screen, in pixels. | |||
| Mobile Max Browser URL Length | String | True | The maximum number of characters that can be included in the site URL when accessed from a mobile browser. | |||
| Mobile Video Support | String | True | The video file formats and codecs that the mobile device supports. | |||
| Monitor Resolution | String | True | The height and width of the active display in pixels. This can help you prioritize content to make it visible to users without scrolling. | |||
| Monthly Unique Customers | String | True | The number of unique visitors per month. | |||
| New Visit | String | True | The 'New Visit' dimension. | |||
| Next Page | String | True | The 'Next Page' dimension. | |||
| Operating Systems | String | True | Provides data on the various desktop and mobile operating systems used by visitors to the site (includes operating system versions). This can help you understand which operating systems are most common if you have features that are supported only on certain operating systems. | |||
| Operating System Types | String | True | Provides data on the various desktop and mobile operating systems used by visitors to the site, regardless of the operating system version. This can help you understand which operating systems are most common if you have features that are supported only on certain operating systems. | |||
| Tracking Opt-out Reason | String | True | This dimension acts as a preview to show you data that would be excluded if you enabled Privacy Settings. This can help you determine if your implementation would be negatively impacted if you enabled Privacy Settings under Report Suite Settings. | |||
| Page | String | True | The names of pages on your site. This can help you understand which pages on your site perform the best. This is one of the most commonly used dimensions. | |||
| Page Event (Link Tracking) | String | True | The 'Page Event (Link Tracking)' dimension. | |||
| Page Event Media (Link Tracking) | String | True | The 'Page Event Media (Link Tracking)' dimension. | |||
| Page Event Var1 (Link Tracking) | String | True | The 'Page Event Var1 (Link Tracking)' dimension. | |||
| Page Event Var2 (Link Tracking) | String | True | The 'Page Event Var2 (Link Tracking)' dimension. | |||
| Page Event Var3 (Link Tracking) | String | True | The 'Page Event Var3 (Link Tracking)' dimension. | |||
| Page Name No URL | String | True | The 'Page Name No URL' dimension. | |||
| Pages Not Found | String | True | Shows URLs that contained an error. This can help you lower the number of errors that visitor get on your site. | |||
| Time Spent on Page - Granular | String | True | The amount of time a visitor spends on the page. This can help you understand how long visitors interact with a given metric on the site. | |||
| Page Type Error | String | True | The 'Page Type Error' dimension. | |||
| Page URL | String | True | The URLs on the site. | |||
| Original Entry Page URL | String | True | The 'Original Entry Page URL' dimension. | |||
| Visit Start Page URL | String | True | The 'Visit Start Page URL' dimension. | |||
| Paid Search | String | True | Compares any metric between paid search and natural search. All other hits outside search engines are omitted. This can help you understand how your paid search efforts compare with organic search. | |||
| Partner Plugins lea | String | True | The 'Partner Plugins lea' dimension. | |||
| Visit Depth | String | True | The 'Visit Depth' dimension. | |||
| Persistent Cookie Support | String | True | Shows if the hit used a visitor identifier that originated from a persistent source. The most common persistent source is from a cookie, but it can also use mobile headers and other sources. | |||
| Plugin Support | String | True | The 'Plugin Support' dimension. | |||
| Pre Loaded | String | True | The 'Pre Loaded' dimension. | |||
| Previous Page | String | True | The 'Previous Page' dimension. | |||
| Product | String | True | Shows the name of the product in the hit. If your implementation uses the products variable, it can help you understand metrics about your products, such as top sellers or most viewed. | |||
| Custom Insight 1 | String | True | The 'Custom Insight 1' dimension. | |||
| Custom Insight 2 | String | True | The 'Custom Insight 2' dimension. | |||
| Custom Insight 3 | String | True | The 'Custom Insight 3' dimension. | |||
| Custom Insight 4 | String | True | The 'Custom Insight 4' dimension. | |||
| Custom Insight 5 | String | True | The 'Custom Insight 5' dimension. | |||
| Purchase ID | String | True | The 'Purchase ID' dimension. | |||
| Quarterly Unique Customers | String | True | The number of unique visitors per quarter. | |||
| Referrer | String | True | The website or source that a visitor used to arrive at the site. This can help you understand which specific URLs drive the most traffic to your site. | |||
| Original Referrer | String | True | The 'Original Referrer' dimension. | |||
| Referrer Type | String | True | The generic channels that a visitor used to arrive at the site (such as a search engine or another website). | |||
| Original Referrer Type | String | True | The 'Original Referrer Type' dimension. | |||
| Referrer Type (Visit) | String | True | The 'Referrer Type (Visit)' dimension. | |||
| Referrer (Visit) | String | True | The 'Referrer (Visit)' dimension. | |||
| Referring Domain | String | True | The domain of the website that a visitor used to arrive at the site. This can help you understand which third-party sites drive the most traffic to yours. | |||
| Original Referring Domain | String | True | The 'Original Referring Domain' dimension. | |||
| Referring Domain (Visit) | String | True | The 'Referring Domain (Visit)' dimension. | |||
| Return Frequency | String | True | Shows the time between visits from returning visitors. When a visitor returns to your site, it looks at the previous visit's timing and categorizes the current hit accordingly. This can help you gauge your site's appeal and track the impact of your content and promotions over time. | |||
| Report Suite ID | String | True | The 'Report Suite ID' dimension. | |||
| Search Engine | String | True | The search engine used to arrive at the site through a paid or natural (unpaid) search link. | |||
| Search Keyword | String | True | The words or phrases used when entering the site through a paid or natural (unpaid) search link. | |||
| Search Keyword (Visit) | String | True | The 'Search Keyword (Visit)' dimension. | |||
| Search Engine - Natural | String | True | The search engine used when entering the site through an natural (unpaid) search link. | |||
| Search Keyword - Natural | String | True | The words or phrases used when entering the site through a natural (unpaid) search link. | |||
| All Search Page Rank | String | True | The page of search results a visitor clicked through to your site. For example, if your site appears on the second page of a search engine's search results, the dimension item for this variable is | |||
| Search Engine - Paid | String | True | The search engine used when entering the site through a paid search link. | |||
| Search Keyword - Paid | String | True | The words or phrases used when entering the site through a paid search link. | |||
| Search Engine (Visit) | String | True | The 'Search Engine (Visit)' dimension. | |||
| Server | String | True | The 'Server' dimension. | |||
| Service | String | True | The 'Service' dimension. | |||
| Single Page Visits | String | True | Occurrences when visitors leave the site after viewing only a single page. | |||
| Site Section | String | True | Lists the names of site sections on your site. For large sites, it is helpful to group pages into sections. This dimension is useful to see the top-viewed or top-performing site sections. | |||
| Time Spent per Visit - Granular | String | True | The 'Time Spent per Visit - Granular' dimension. | |||
| SSL Hit | String | True | The 'SSL Hit' dimension. | |||
| Start New Visit | String | True | The 'Start New Visit' dimension. | |||
| US States | String | True | The 'US States' dimension. | |||
| AM/PM | String | True | The time of day (whether AM or PM) when a visitor accessed the site. | |||
| Day of Month | String | True | The number or percentage of visitors who access the site, categorized by month. | |||
| Day of Week | String | True | The 'Day of Week' dimension. | |||
| Day of Year | String | True | The numeric day of any given year. This allows you to view data by day, without having to use static dates as dimension items. | |||
| Hour of Day | String | True | The numeric hour of any given day. This allows you to view data by relative time of day, without having to use static hours as dimension items. | |||
| Month of Year | String | True | The month of any given year. This allows you to view data by the month of the year, without having to use a static date as dimension items. | |||
| Quarter of Year | String | True | The quarter of any given year. This allows you to view data by quarter of the year, without having to use static dates as dimension items. | |||
| Weekday/Weekend | String | True | The number or percentage of visitors who access the site, categorized by weekday and weekend. | |||
| Time Prior to Event | String | True | Reports the amount of time that passed between the first hit of the visit and the desired metric. This dimension is useful to determine the amount of time it takes to hit a success event, such as a form submission or a purchase. | |||
| Time Spent per Visit - Bucketed | String | True | Categorizes the length of time that visitors spend on the site during a single visit into different time ranges or | |||
| Time Zone | String | True | The time zone in which visitors are located when they interact with the site. This can help you understand user behavior and engagement patterns across different geographic regions. | |||
| Timezone | String | True | The 'Timezone' dimension. | |||
| Target Integration | String | True | The 'Target Integration' dimension. | |||
| Target Integration Action | String | True | The 'Target Integration Action' dimension. | |||
| Top Level Domain | String | True | The last part of a website's domain name after the final dot, such as '.com', '.org, or '.edu'. This can help you understand how visitors are accessing the site and which top-level domains are driving the most traffic. | |||
| Transaction ID | String | True | The 'Transaction ID' dimension. | |||
| Truncated Hit | String | True | The 'Truncated Hit' dimension. | |||
| User Agent Color | String | True | The 'User Agent Color' dimension. | |||
| User Agent Operating System | String | True | The 'User Agent Operating System' dimension. | |||
| User Agent Pixels | String | True | The 'User Agent Pixels' dimension. | |||
| User Agent | String | True | The 'User Agent' dimension. | |||
| User ID | String | True | The 'User ID' dimension. | |||
| New Engagement | String | True | The 'New Engagement' dimension. | |||
| New Visitor ID | String | True | The 'New Visitor ID' dimension. | |||
| Visitor ID Type | String | True | The 'Visitor ID Type' dimension. | |||
| Visit Number | String | True | The number of times a visitor accessed the site within a defined time period. This can help you understand how engaged a visitor is when returning to your site. | |||
| Visitor ID | String | True | A unique, persistent identifier assigned to each individual visitor who accesses the site. This identifier enables Adobe Analytics to track and analyze visitor behavior over time, even if the visitor is using multiple devices or browsers. | |||
| Visit Page Number | String | True | A sequential number that represents the order in which a specific page was viewed by a visitor during a given visit to the site. This can help you understand the path that visitors take as they navigate through the site, and can be used to analyze visitor behavior and engagement. | |||
| Visit Start Time UTC | String | True | The 'Visit Start Time UTC' dimension. | |||
| Weekly Unique Customers | String | True | The number of unique visitors per week. | |||
| Yearly Unique Customers | String | True | The number of unique visitors per year. | |||
| Zip Code | String | True | Categorizes site visitors based on their zip code or postal code. This can help you understand the success of local advertising or see where in the world your site performs best. | |||
| Average Page Depth | Int | True | The 'Average Page Depth' metric. | |||
| Average Time Spent on Page (seconds) | Int | True | The average amount of time visitors spend on a page. | |||
| Average Time Spent on Site (seconds) | Int | True | The total amount of time visitors interact with a specific dimension item, per sequence with a dimension item. | |||
| Average Visit Depth | Int | True | The average number of pages viewed during a single visit to the site. This can help you understand how engaged visitors are with content on the site. | |||
| Bot Occurrences | Int | True | The number of hits where a bot traffic was detected. The Bot Occurrences metric should only be used with the Bot Name, Page, or standard time dimensions (such as Day, Week, etc). If this metric is used with any other Analytics dimension, no data will result because it is unassociated with normal customer-based data in Analytics. Data processing for Bot Occurrences began between February 26 and March 10, 2023, any reporting window prior to this date will not have data. This is an Adobe provided component. | |||
| Bot Page Views | Int | True | Shows the number of times a bot was set or persisted on a page. The Bot Page Views metric should only be used with the Bot Name, Page, or standard time dimensions (such as Day, Week, etc). If this metric is used with any other Analytics dimension, no data will result because it is unassociated with normal customer-based data in Analytics. Data processing for Bot Page Views began between February 26 and March 10, 2023, any reporting window prior to this date will not have data. This is an Adobe provided component. | |||
| Bounce Rate | String | True | The ratio of visits that contained exactly one hit compared to the number of visits on that page. This can help you to understand which dimension items have the highest bounce rate, or to see an aggregated total bounce rate of your site over time. | |||
| Bounces | Int | True | The number of times a visitor leaves the site after viewing only one page. This can help you understand the top entry pages that cause visitors to bounce, or to see how bounces trend over time. | |||
| Campaign Click-throughs | Int | True | The 'Campaign Click-throughs' metric. | |||
| Cart Additions | Int | True | The number of times a visitor added something to their cart. This can help you understand at what part of the conversion funnel that customers show enough interest in a product to add it to their cart. | |||
| Cart Removals | Int | True | The number of times a visitor removes an item from their online shopping cart during a session. This can help you understand which factors might be preventing users from completing a purchase. | |||
| Carts | Int | True | The number of times visitors to the site added items to their online shopping carts. | |||
| Cart Views | Int | True | The number of times a visitor viewed their shopping cart. This can help you understand at what part of the conversion funnel that customers view the contents in their cart. | |||
| Checkouts | Int | True | The number of times visitors to the site initiated the checkout process to purchase a product or service. | |||
| Custom Link Instances | Int | True | The 'Custom Link Instances' metric. | |||
| Download Link Instances | Int | True | The number of times visitors click on download links on the site. This can help you understand how effective certain links are. | |||
| Entries | Int | True | The number of times visitors to the site first land on a given page to start their session. | |||
| Internal Campaign Instances | Int | True | The 'Internal Campaign Instances' metric. | |||
| Internal Search Terms Instances | Int | True | The 'Internal Search Terms Instances' metric. | |||
| Custom Conversion 3 Instances | Int | True | The 'Custom Conversion 3 Instances' metric. | |||
| eVar4 Instances | Int | True | Instances of metrics tied to the eVar4 dimension. | |||
| Registrations | Int | True | The 'Registrations' metric. | |||
| Email Registrations | Int | True | The 'Email Registrations' metric. | |||
| Subscriptions | Int | True | The 'Subscriptions' metric. | |||
| Page Views | Int | True | The 'Page Views' metric. | |||
| Ad Impressions | Int | True | The 'Ad Impressions' metric. | |||
| Ad Clicks | Int | True | The 'Ad Clicks' metric. | |||
| Exit Link Instances | Int | True | The number of times visitors clicked a specific link before leaving your website. This can help you understand which links are causing users to leave and potentially identify opportunities for optimization. | |||
| Exits | Int | True | The number of times a given dimension item is captured as the last value in a visit. This can help you understand the last thing visitors see before leaving your site, allowing you to optimize the experience a visitor gets before they leave. | |||
| Total Seconds Spent | Int | True | The amount of time visitors spend viewing a specific item on the site, such as a product or piece of content. This can help you understand how interested visitors are in specific products. | |||
| Total Seconds Spent | Int | True | The 'Total Seconds Spent' metric. | |||
| Marketing Channel Instances | Int | True | The 'Marketing Channel Instances' metric. | |||
| Mobile Views | Int | True | The 'Mobile Views' metric. | |||
| New Engagements | Int | True | the number of times a visitor matches a marketing channel for the first time in that visitor's engagement period. This can compare any dimension with a visitor matching a marketing channel processing rule for the first time. | |||
| Orders | Int | True | The total number of purchase events made on your site. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to an order. | |||
| Orders per Visit | Decimal | True | The ratio of orders that visitors made over the total number of visits to your site. This can help you understand conversion rate for your site. | |||
| Page Events | Int | True | Specific user interactions or actions that occur on the site, such as clicks, form submissions, video plays, downloads, and other custom events. | |||
| Pages Not Found | Int | True | Shows URLs that contained an error. This can help you lower the number of errors that visitor get on your site. | |||
| Page Views | Int | True | Shows the number of times a given dimension item was set or persisted on a page. It is one of the most common and basic metrics in reports. | |||
| Average Page Views per Visit | Decimal | True | The 'Average Page Views per Visit' metric. | |||
| Product Views | Int | True | The number of times any product was viewed. This can help you see your top-viewed products, or how total product views trend over time. | |||
| Referrer Instances | Int | True | The 'Referrer Instances' metric. | |||
| Reloads | Int | True | The number of times a dimension item was present during a reload. A visitor refreshing their browser is the most common way to trigger a reload. | |||
| Revenue | Decimal | True | The monetary amount of products purchased within all orders. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to revenue. | |||
| Searches | Int | True | The number of hits that match Adobe's external search detection. This can help you understand how non-search dimensions contributed to search engine traffic. | |||
| Single Page Visits | Int | True | Occurrences when visitors leave the site after viewing only a single page. | |||
| Single Access | Int | True | The 'Single Access' metric. | |||
| Time Spent per Visit (seconds) | Int | True | The average amount of time that visitors interact with a given dimension item during each visit. | |||
| Time Spent per Visitor (seconds) | Int | True | The average amount of time that visitors interact with a given dimension item during a visitor's entire lifetime. | |||
| Units | Int | True | The total number of products purchased within all orders. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to the number of products purchased. | |||
| Unique Visitors | Int | True | The number of unique individuals who have visited the site during a specified time period. This can help you understand the overall reach of the site. | |||
| Daily Unique Visitors | Int | True | The number of unique visitors to the site during each day in a given time period. | |||
| Hourly Unique Visitors | Int | True | The number of unique visitors to the site during each hour of the day. This can help you understand the time of day when the site is busiest to help optimize marketing campaigns and website content. | |||
| Visitors with Experience Cloud ID | Int | True | The number of unique visitors to the site based on their Marketing Cloud Visitor ID. | |||
| Monthly Unique Visitors | Int | True | The number of unique visitors to the site during each month in a given time period. | |||
| Quarterly Unique Visitors | Int | True | The number of unique visitors to the site during each quarter in a given time period. | |||
| Weekly Unique Visitors | Int | True | The number of unique visitors to the site during each week in a given time period. | |||
| Yearly Unique Visitors | Int | True | The number of unique visitors to the site during each year in a given time period. | |||
| Visits | Int | True | The number of sessions across all visitors on the site. | |||
| Visits - All Visitors | Int | True | The 'Visits - All Visitors' metric. | |||
| Visits | Int | True | The 'Visits' metric. | |||
| Test CM | Decimal | True | ennio testing | |||
| CalculatedMetricTest | Decimal | True | The 'CalculatedMetricTest' metric. | |||
| Revenue / Visitor | Decimal | True | The average amount of revenue generated by each individual visitor to the site. | |||
| Orders / Visitor | Decimal | True | The average number of orders or transactions generated by each individual visitor to the site. | |||
| Revenue / Visits | Decimal | True | The average amount of revenue generated by a single visit to the site. | |||
| Revenue / Order | Decimal | True | The average amount of revenue generated by each completed transaction or order on the site. | |||
| Orders / Visits | Decimal | True | The percentage of visits to the site that result in a completed transaction. | |||
| Page Views / Visits | Decimal | True | The average number of pages a user views during a single visit to the site. | |||
| Visits / Visitor | Decimal | True | The average number of visits a unique visitor makes to the site. | |||
| Reloads / Pageviews | Decimal | True | The percentage of page views that resulted in a reload or refresh of the page. | |||
| Weighted Bounce Rate | String | True | if(visits > percentile(visits),bouncerate,0) | |||
| Order Assists | Decimal | True | The number of times a channel or source contributed to a customer's journey towards making a purchase, but did not result in the final purchase. | |||
| Exit Rate | String | True | The percentage of visitors who leave the site after viewing a particular page. | |||
| Entry Rate | String | True | The percentage of visitors who entered the site on a given page, compared to the total number of sessions on the site. | |||
| Average Time on Site | String | True | The average amount of time a visitor spends on the site before leaving or navigating away. | |||
| Time Spent/User (State) | String | True | The length of time that the average visitor spends in a particular State while on the site. | |||
| Action Time In App / Users | String | True | The average amount of time visitors spend performing a specific action or task on the site. | |||
| Average Place Dwell Time | String | True | The average length of time that visitors spend on a specific section or area of a web page before moving on to another section or leaving the site. | |||
| Engagement Rate (Messages) | String | True | The percentage of visitors who send a message or initiate a conversation using the site's messaging features, such as live chat or chatbots. | |||
| States Per Launch | Decimal | True | The number of web page states or screens that a visitor views during a single session. | |||
| Launches/User | Decimal | True | The number of times a user launches a specific application or feature on the site. | |||
| Crash Rate (Mobile) | String | True | The percentage of app sessions that end in a crash or in an abnormal termination of the app. | |||
| Average Session Length (Mobile) | String | True | cm_mobile_avg_session_length_defaultmetric_localized_description_key | |||
| Users (Mobile) | Decimal | True | The total number of users of a mobile app. | |||
| App Users | Decimal | True | The total number of users of a mobile app. | |||
| State Views | Decimal | True | The number of views to the different states or screens of the app. | |||
| Actions | Decimal | True | The total number of actions taken in the app. | |||
| Acquisition Link Clicks | Decimal | True | The number of times people click a link that is designed to drive traffic to the site. | |||
| Page Velocity | Decimal | True | The number of additional page views and engagement that a piece of content generates. | |||
| Conversion Rate | String | True | The percentage of visitors who took a desired action, such as made a purchase. | |||
| Compression | String | True | The process of reducing the file size of a web page or website to improve page load times and website performance. | |||
| Devices/person | Decimal | True | The average number of devices used by a single person to access the site. | |||
| Experience Cloud ID coverage | String | True | The percentage of visitors who have an Experience Cloud ID. | |||
| In-App Message Engagement Rate | String | True | The percentage of visitors who interact with a specific in-app message, such as a push notification or banner. | |||
| Content Velocity | Decimal | True | The speed at which new content is created and published on the site and how quickly it generates user engagement. | |||
| Adobe Advertising Avg. Quality Score | Decimal | True | Evaluates the quality and relevance of the site's landing pages in the context of data from Adobe Advertising. | |||
| Adobe Advertising Avg. Position | Decimal | True | Measures the average ranking of the site's pages or ads in search engine results (using data from Adobe Advertising) when people search for specific terms relevant to your business. | |||
| Adobe Advertising ROAS | Decimal | True | Return on Advertising Spend (ROAS) measures the effectiveness and profitability of an advertising campaign (using data from Adobe Advertising). | |||
| Adobe Advertising CPC | Decimal | True | Cost Per Click (CPC) measures the cost of a digital advertising campaign (using data from Adobe Advertising). | |||
| Adobe Advertising CTR | String | True | Click-Through Rate (CTR) measures the effectiveness of digital advertising campaigns or site content in generating clicks (using data from Adobe Advertising). | |||
| Adobe Advertising Cost w Cents | Decimal | True | The total cost of a digital advertising campaign, expressed in cents (using data from Adobe Advertising). | |||
| Ad Completion Rate | String | True | The percentage of visitors who complete an ad on the site after starting it. | |||
| Ad Time Spent Rate | String | True | The amount of time viewers spend watching a video ad (displayed as a percentage of the ad's total length). | |||
| Avg. Ad Time Spent | String | True | The average amount of time that viewers spend watching a video ad on the site (HH:MM:SS). | |||
| Avg. Ads per Media Stream | Decimal | True | The average number of ads that appear during a single media stream or video on the site. | |||
| Avg. Chapter Time Spent | String | True | The average amount of time viewers spend watching a specific chapter or section of a video on the site (HH:MM:SS). | |||
| Avg. Chapters per Media Stream | Decimal | True | The average number of chapters or sections that appear during a single media stream or video on the site. | |||
| Avg. Content Time Spent | String | True | The average amount of time visitors spend engaging with a particular piece of content on the site (HH:MM:SS). | |||
| Avg. Media Time Spent | String | True | The average amount of time visitors spend engaging with a particular media element on the site, such as a video or audio clip, after the stream initiates. (HH:MM:SS). | |||
| Chapter Completion Rate | String | True | The percentage of viewers who watch a particular chapter or section of a video to its conclusion after starting it. | |||
| Content Buffer Duration Rate | String | True | The percentage of time a video or audio clip is paused for buffering during playback on the site. | |||
| Content Completion Rate | String | True | The percentage of time a video or audio clip is completed after starting. | |||
| Content Pause Duration Rate | String | True | The percentage of time a video or audio clip is paused for buffering during playback on the site. | |||
| Content Time to Start Rate | String | True | The amount of time it takes for a video or audio clip to start playing after a user clicks the play button. | |||
| Drops before Start Rate | String | True | The percentage of visitors who click the play button on a video or audio clip but abandon it before the content starts playing. | |||
| Media Completion Rate | String | True | The percentage of visitors who complete a video on the site after starting it. | |||
| ITP 2.1 Unique Visitors / Unique Visitors | String | True | The percentage of unique visitors using a browser affected by ITP 2.1 cookie limitations. In other words, customers not using a CNAME implementation. (This applies to customers setting cookies via client-side JavaScript.) | |||
| Unique Visitors / Unique Visitors returning after 7 days | String | True | The percentage of unique visitors who are returning after a period of 7 or more days. | |||
| Page Views / Unique Visitor | Decimal | True | The average number of pages viewed for each unique visitor to the site. | |||
| Visits / Visitors | Decimal | True | The average number of visits a unique visitor makes to the site. | |||
| Estimated Unique Visitors (ITP 2.1) | Decimal | True | For ITP visitors (users on Safari browsers) divide Unique Visitors by 2 or less. This assumes you are setting cookies using client-side JavaScript (not using a CNAME implementation). Implementations that set cookies using client-side JavaScript were impacted starting with ITP 2.1. See: https://webkit.org/blog/8613/intelligent-tracking-prevention-2-1/ | |||
| Page Views / Estimated Unique Visitors (ITP 2.1) | Decimal | True | The average number of pages viewed for Estimated Unique Visitors (ITP 2.1). | |||
| Bots Page View Ratio | Decimal | True | The average number of Bot Page Views/Page Views. | |||
| Average Visits Per Order | String | True | The average number of visits for each order made. | |||
| Average Products Per Order | String | True | The average number of products included in each order. | |||
| Average Carts Per Order | String | True | The average number of carts included in each order. | |||
| Average Checkouts Per Order | String | True | The average number of checkouts associated with each order. | |||
| Average Revenue Per Product | Decimal | True | The average amount of revenue generated by each product. | |||
| Average Revenue Per Cart | Decimal | True | The average amount of revenue generated for each shopping cart. | |||
| Average Revenue Per Checkout | Decimal | True | The average amount of revenue generated for each checkout. | |||
| Average Revenue Per Order | Decimal | True | The average amount of revenue generated for each order. | |||
| Average Revenue Per Unit | Decimal | True | The average amount of revenue generated for each unit sold. | |||
| Average Units Per Product | Decimal | True | The average number of units included in each product. | |||
| Average Units Per Cart | Decimal | True | The average number of units included in each shopping cart. | |||
| Average Units Per Checkout | Decimal | True | The average number of units included with each checkout. | |||
| Average Units Per Order | Decimal | True | The average number of units included with each order. | |||
| Average Orders Per Product | Decimal | True | The average number of orders for each product. | |||
| Average Orders Per Cart | Decimal | True | The average number of orders included with each shopping cart. | |||
| Average Orders Per Checkout | Decimal | True | The average number of orders included with each checkout. | |||
| Average Revenue Per Visit | Decimal | True | The average amount of revenue generated for each visit. | |||
| Average Orders Per Visit | Decimal | True | The average number of orders generated with each visit. | |||
| Average Click-Throughs Per Order | String | True | The average number of click-throughs (clicks on ads or links) that are required before a single order is made. | |||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
List the users who have access to Adobe Analytics, including login details, roles, and account status.
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| LoginId [KEY] | String | Unique identifier of the user. | ||||
| ImsUserId | String | The IMS User Id. This is used only for internal users such as authors, reviewers, administrators, developers, etc. | ||||
| CompanyId | String | Unique identifier of the company. | ||||
| CreateDate | Timestamp | The date when user was created. | ||||
| Disabled | Boolean | Whether or not this user's account is disabled. | ||||
| String | The email of the user. | |||||
| FirstName | String | The first name of the user. | ||||
| LastName | String | The last name of the user. | ||||
| FullName | String | The full name of the user. | ||||
| LastAccess | Timestamp | When the user accessed his account for the last time. | ||||
| LastLogin | Timestamp | When the user logged in for the last time. | ||||
| Login | String | Login name. | ||||
| PhoneNumber | String | The phone number of the user. | ||||
| Title | String | The user's title. |
Display the total number of unique individuals who accessed your site during the reporting period (defaults to the past 30 days).
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [Visitors] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Date | Date | True | True | The day the given metric occurred. | ||
| UniqueVisitors | Int | True | True | The number of unique individuals who have visited the site during a specified time period. This can help you understand the overall reach of the site. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
Show the number of individual sessions recorded during the specified date range, regardless of visitor identity.
This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.
You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:
SELECT * FROM [Visits] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Date | Date | True | True | The day the given metric occurred. | ||
| Visits | Int | True | True | The number of sessions across all visitors on the site. | ||
| StartDate | String | Specifies the beginning of the reporting period. | ||||
| EndDate | String | Specifies the end of the reporting period. | ||||
| SegmentId | String | Specifies the ID of a predefined or custom segment to filter the report data. |
ストアドプロシージャはファンクションライクなインターフェースで、Adobe Analytics の単純なSELECT 処理にとどまらずSync App の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにAdobe Analytics から関連するレスポンスデータを返します。
| Name | Description |
| CreateReport | Generates a custom analytics report by specifying desired dimensions, metrics, segments, and time range. |
Generates a custom analytics report by specifying desired dimensions, metrics, segments, and time range.
Use the CreateReport stored procedure to generate a custom static report. This procedure provides a way to generate new view definitions with a custom combination of dimensions and metrics. Calling it creates a new schema file that you can query like any other view.
You must set the Location connection property to the folder containing the new script files in order to access them.
You can retrieve metric and dimension Ids by querying the Metrics and Dimensions views. For example:
SELECT Id, Name FROM Dimensions SELECT Id, Name FROM Metrics
To include calculated metrics in your report, you can retrieve the metric Id by running the following query:
SELECT Id, Name FROM CalculatedMetrics
To use a new schema along with the default schemas, set the Location property to the db subfolder in the installation folder. Then you can make any of the following calls:
EXEC CreateReport DimensionIds = 'variables/geocountry, variables/geocity', MetricIds = 'metrics/pageviews, metrics/visits', TableName = 'MyCustomReport' EXEC CreateReport DimensionIds = 'variables/geocountry, variables/geocity', MetricIds = 'metrics/pageviews, metrics/visits', TableName = 'MyCustomReport', DefaultDateRage = '2025-01-01/2025-01-30' EXEC CreateReport DimensionIds = 'variables/geocountry, variables/geocity', MetricIds = 'metrics/pageviews, metrics/visits', TableName = 'MyCustomReport', DefaultDateRage = '2025-01-01/2025-01-30', DefaultSegmentId = 's3642_649ae61b5a255650b8391f9d'Note that dimensions and metrics must have their respective Ids specified in the DimensionIds and MetricIds inputs.
| Name | Type | Required | Description |
| TableName | String | True | The name for the new table. |
| Description | String | False | An optional description for the table. |
| WriteToFile | String | False | Specifies whether to write the contents of this stored procedure to a file. The default value is true. Set to false to return file data through FileStream or FileData. |
| DimensionIds | String | True | A comma-separated list of dimension Ids. |
| MetricIds | String | True | A comma-separated list of metric Ids. |
| AllowOverride | String | False | When WriteToFile is set to true and a file with the same name already exists, this parameter specifies whether the file should be overwritten.
デフォルト値はfalseです。 |
| DefaultDateRage | String | False | The date range that is used as the default when executing the created report. If the date range is not specified, a range of 2 years is applied up to the date the report is executed. This value can be overridden when executing the report by specifying the StartDate and EndDate parameters. The accepted format is StartDate/EndDate (for example, 2023-01-01/2023-12-31). |
| DefaultSegment | String | False | An optional default segment to add to the report. Only one value is allowed. |
| Name | Type | Description |
| FileData | String | The generated schema file as a base64 string if WriteToFile is set to false; null otherwise. |
| Success | String | Specifies whether the schema was created successfully. |
| SchemaFile | String | The generated schema file path if WriteToFile is set to true; null otherwise. |
Initiate the OAuth 2.0 flow and return a valid access token for use in Adobe Analytics API queries.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
使用できる値は次のとおりです。APP, WEB デフォルト値はAPPです。 |
| Scopes | String | False | A comma-separated list of permissions to request from the user. Please check the AdobeAnalytics API for a list of available permissions.
デフォルト値はopenid,AdobeID,read_organizations,additional_info.job_function,additional_info.projectedProductContextです。 |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the AdobeAnalytics app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | False | The verifier returned from AdobeAnalytics after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the AdobeAnalytics authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with AdobeAnalytics. |
| OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of AdobeAnalytics. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Return the URL where users can grant your application access to their Adobe Analytics data. Primarily used in web app integrations.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the AdobeAnalytics app settings. |
| Scopes | String | False | A comma-separated list of scopes to request from the user. Please check the AdobeAnalytics API documentation for a list of available permissions.
デフォルト値はopenid,AdobeID,read_organizations,additional_info.job_function,additional_info.projectedProductContextです。 |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the AdobeAnalytics authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Since Adobe Analytics does not support refresh tokens, this procedure re-initiates the OAuth flow by calling GetOAuthAccessToken.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | False | Set this to some test value. It won't make a difference since this procedure will start the OAuth flow from start.
デフォルト値はtestです。 |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from AdobeAnalytics. This can be used in subsequent calls to other operations for this particular service. |
| ExpiresIn | String | The remaining lifetime on the access token. |
レポートはビューとして表示されます。ビューは変更できないテーブルです。レポートビューには4種類あります。
ただし、従来のデータベースビューとは異なり、特定のテーブルですべての指標とディメンションを選択することはあまり役に立ちません。Date はすべてのレポートのデフォルトディメンションです。そのため、次のクエリ:
SELECT * FROM MyReportは以下のようになります:
SELECT Date, {all the metrics here} FROM MyReport
ただし、クエリに抽出条件がある場合、デフォルトのディメンションは抽出条件で使用されるディメンションになります。例:
SELECT * FROM MyReport WHERE Country = 'England'は以下のようになります:
SELECT Country, {all the metrics here} FROM MyReport WHERE Country = 'England'
さらに、Adobe Analytics API はREST API 呼び出しごとにデータをリクエストできるディメンションの数を1つに制限しています。
つまり、プロバイダーが複数のディメンションを持つレポートを生成する唯一の方法は、ディメンションを分割することです。
クエリの例を見てみましょう。
SELECT Country, City, Visits FROM MyReport
... WHERE Dimension = 'Value'
... WHERE Dimension LIKE '%value%'
... WHERE Dimension1 LIKE '%value' AND Dimension2 = 'Value2'
... WHERE Dimension LIKE 'value%'
... WHERE Dimension1 = 'Value1' AND Dimension2 = 'Value2'
... WHERE Dimension = 'Value1' OR Dimension = 'Value2' OR Dimension = 'Value3'
... WHERE Dimension IN ('Value1', 'Value2', 'Value3', 'Value4')
... WHERE (Dimension1 = 'value1' OR Dimension1 = 'Value2') AND (Dimension2 = 'value3' OR Dimension2 = 'value4')
CData では、できるだけ多くのフィルタを使用することを強く推奨します。そうしないと、多くのディメンションを持つクエリに時間がかかる可能性があります。
クエリのレポートビューを作成するには、CreateReport ストアドプロシージャを使用できます。ストアドプロシージャを使用すると、ディメンションと指標を独自に組み合わせて、簡単に新しいビュー定義を生成できます。このストアドプロシージャを呼び出すと、新しいスキーマファイルが作成されます。このファイルは、他のビューと同様にクエリすることができます。
このストアドプロシージャは、入力として、ビュー名、指標名のカンマ区切りリスト、指標Id のカンマ区切りリスト、ディメンション名のカンマ区切りリスト、ディメンションId のカンマ区切りリスト、および出力フォルダを受け取ります。
新しいスクリプトファイルにアクセスするには、Location 接続プロパティを、このファイルを含むフォルダに設定する必要があります(出力フォルダの代わりにLocation を設定できます)。
以下に示すように、Metrics および Dimensions ビューをクエリして、指標とディメンションの ID を取得します。
SELECT Id, Name FROM Dimensions SELECT Id, Name FROM Metrics
例えば、デフォルトスキーマとともに新しいスキーマを使用するには、Location プロパティをインストールフォルダ内のdb サブフォルダに設定し、次の呼び出しを行います。
EXEC CreateReport Dimensions = 'Country, City', Metrics = 'PageViews, Visits', TableName = 'MyCustomReport'
| プロパティ | 説明 |
| AuthScheme | Specifies the authentication scheme the provider uses to connect. |
| GlobalCompanyId | Specifies the Global Company ID tied to your Adobe Analytics account. |
| RSID | Specifies the Report Suite ID (RSID) associated with the Adobe Analytics data you want to query. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| IncludeSummaryData | Specifies whether to include summary records in the data returned from custom reports. |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| Pagesize | provider がAdobe Analytics にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| SkipEmptyRows | Specifies whether the provider skips empty rows in the output when querying report data. |
| SupportEnhancedBreakDown | Specifies whether the provider uses a breadth-first strategy to retrieve rows for all combinations of dimensions in a multi-level report. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを指定します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | Specifies the authentication scheme the provider uses to connect. |
| GlobalCompanyId | Specifies the Global Company ID tied to your Adobe Analytics account. |
| RSID | Specifies the Report Suite ID (RSID) associated with the Adobe Analytics data you want to query. |
Specifies the authentication scheme the provider uses to connect.
Specifies the Global Company ID tied to your Adobe Analytics account.
The Global Company ID is a unique identifier assigned to your Adobe Analytics organization. This value distinguishes your organization from others in Adobe’s system and is required for making authenticated API requests. If this property is not set, the provider attempts to detect the first available company ID tied to your account automatically.
Specifies the Report Suite ID (RSID) associated with the Adobe Analytics data you want to query.
The Report Suite ID identifies the specific set of Adobe Analytics data you want to access.
You can find your RSID on the Adobe Analytics platform by navigating to Admin > Report Suites.
If this property is not set, the Sync App attempts to detect the first available RSID tied to your account automatically.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。)
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes:
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。
スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。
InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。
InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint(hex 値はスペースまたはコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がAdobe Analytics への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がAdobe Analytics への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がAdobe Analytics にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
サポートされる認証の種類:
NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Note:Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。
ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。
この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;
デフォルトでは、すべてのモジュールの操作がログに含まれます。
モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP
サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res
Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。
使用可能なモジュールとサブモジュールは次のとおりです。
| モジュール名 | モジュールの説明 | サブモジュール |
| INFO | 一般情報。接続文字列、製品バージョン(ビルド番号)、および初期接続メッセージが含まれます。 |
|
| EXEC | クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。 |
|
| HTTP | HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス(POST メッセージを含む)、および Kerberos 関連のメッセージが含まれます。 |
|
| WSDL | WSDL/XSD ファイルの生成に関するメッセージ。 | — |
| SSL | SSL 証明書メッセージ。 |
|
| AUTH | 認証関連の失敗/成功メッセージ。 |
|
| SQL | SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。 |
|
| META | メタデータキャッシュとスキーマメッセージ。 |
|
| FUNC | SQL 関数の実行に関連する情報。 |
|
| TCP | TCP トランスポートレイヤーメッセージでの送受信生バイト。 |
|
| FTP | File Transfer Protocol に関するメッセージ。 |
|
| SFTP | Secure File Transfer Protocol に関するメッセージ。 |
|
| POP | Post Office Protocol 経由で転送されるデータに関するメッセージ。 |
|
| SMTP | Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。 |
|
| CORE | 他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。 | — |
| DEMN | SQL リモーティングに関連するメッセージ。 | — |
| CLJB | 一括データアップロード(クラウドジョブ)に関するメッセージ。 |
|
| SRCE | 他のモジュールに属さない、製品が生成するその他のメッセージ。 | — |
| TRANCE | 低レベルの製品操作に関する高度なメッセージ。 | — |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\AdobeAnalytics Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| IncludeSummaryData | Specifies whether to include summary records in the data returned from custom reports. |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| Pagesize | provider がAdobe Analytics にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| SkipEmptyRows | Specifies whether the provider skips empty rows in the output when querying report data. |
| SupportEnhancedBreakDown | Specifies whether the provider uses a breadth-first strategy to retrieve rows for all combinations of dimensions in a multi-level report. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを指定します。 |
Specifies whether to include summary records in the data returned from custom reports.
This property determines whether the Sync App includes summary records in the output of custom reports.
If this property is set to true, the Sync App includes aggregate values such as totals and averages that summarize the main report data.
If this property is set to false, the Sync App excludes summary records and only includes raw report rows.
Use this property when summary-level insights are relevant to your analysis or reporting needs.
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Note:特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
| プロパティ | 説明 |
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT=True | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
provider がAdobe Analytics にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
クエリを処理する際、Adobe Analytics でクエリされたデータすべてを一度にリクエストする代わりに、Sync App はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。
この接続プロパティは、Sync App がページごとにリクエストする結果の最大数を決定します。
Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にSync App がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
Specifies whether the provider skips empty rows in the output when querying report data.
This property determines whether the Sync App skips empty rows in the output when querying report data.
If this property is set to true, the Sync App omits rows that do not contain any measurable data.
If this property is set to false, all rows are included in the report output, including those without data.
Use this property when you want to exclude meaningless or placeholder rows from your report results.
Specifies whether the provider uses a breadth-first strategy to retrieve rows for all combinations of dimensions in a multi-level report.
This property determines how the Sync App retrieves dimension combinations in reports that involve multiple breakdown levels.
If this property is set to true, the Sync App uses a breadth-first approach to include more dimension records per request. Each breakdown level is queried in a wide, flat structure, which is useful when analyzing reports across multiple dimensions. When this property is enabled, the Sync App does not support returning summary data rows. This mode may also result in additional empty rows. To suppress them, enable the SkipEmptyRows property.
If this property is set to false, the Sync App uses a depth-first breakdown strategy. Each record in the root breakdown is queried separately, which is more efficient for single-dimension analysis.
This property only applies to reports created using the CreateReport stored procedure.
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。
次に例を示します。
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonUserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。
詳しくは、ユーザー定義ビュー を参照してください。
テーブルとカラムに簡略名を使用するかどうかを指定します。
Adobe Analytics テーブルでは、標準的なデータベースでは通常許可されない特殊文字を名前に含めることができます。このプロパティを使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。
UseSimpleNames をTrue に設定すると、返されるカラム名をシンプルにします。 表示されるカラム名において、アルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。
Notes:
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.