Cloud

Build 25.0.9434
  • Microsoft Ads
    • はじめに
      • 接続の確立
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • ビュー
        • AccountPerformanceReport
        • Accounts
        • AdAssets
        • AdDynamicTextPerformanceReport
        • AdExtensionAssets
        • AdExtensionByAdReport
        • AdExtensionByKeywordReport
        • AdExtensionDetailReport
        • AdExtensions
        • AdGroupPerformanceReport
        • AdGroups
        • AdPerformanceReport
        • Ads
        • AgeGenderAudienceReport
        • AssetGroupAssets
        • AssetGroups
        • AudiencePerformanceReport
        • Audiences
        • BidOpportunities
        • BudgetOpportunities
        • Budgets
        • BudgetSummaryReport
        • CampaignPerformanceReport
        • Campaigns
        • ConversionPerformanceReport
        • DataExclusions
        • DestinationUrlPerformanceReport
        • DSAAutoTargetPerformanceReport
        • DSACategoryPerformanceReport
        • DSASearchQueryPerformanceReport
        • GeographicPerformanceReport
        • GoalsAndFunnelsReport
        • KeywordEstimatedBid
        • KeywordEstimatedPosition
        • KeywordHistoricalSearch
        • KeywordPerformance
        • KeywordPerformanceReport
        • Keywords
        • NegativeKeywordConflictReport
        • ProductDimensionPerformanceReport
        • ProductNegativeKeywordConflictReport
        • ProductPartitionPerformanceReport
        • ProductPartitionUnitPerformanceReport
        • ProductSearchQueryPerformanceReport
        • PublisherUsagePerformanceReport
        • SearchCampaignChangeHistoryReport
        • SearchQueryPerformanceReport
        • SeasonalityAdjustments
        • ShareOfVoiceReport
        • Tags
        • UserLocationPerformanceReport
      • ストアドプロシージャ
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • DeveloperToken
        • CustomerId
        • UseSandbox
      • Connection
        • AccountId
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • MaxRows
        • PseudoColumns
        • ReportScopes
        • Timeout
    • Third Party Copyrights

Microsoft Ads - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるMicrosoft Ads へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してMicrosoft Ads に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Microsoft Ads への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:Microsoft Ads は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのMicrosoft Ads への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Microsoft Ads への接続

接続の確立 は、CData Cloud にデータベースを作成するためのMicrosoft Ads への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してMicrosoft Ads からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、Microsoft Ads に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Microsoft Ads への接続

Microsoft Ads API に接続するには、Microsoft Ads アカウントを登録し、開発者トークンを取得し、OAuth を使って認証する必要があります。

Bing Ads アカウントの登録

Microsoft Ads アカウントにサインアップし、CustomerId およびAccountId(オプション)を取得するには、次の手順を実行してください。

  1. 次のURL からMicrosoft Ads アカウントにサインアップするか、 Bing Ads Web application あるいは、Sandbox Site からサンドボックスアカウントにサインアップします。
  2. [Settings]->[Accounts and Billing]を選択し、1つのアカウントを選択します。AccountId とCustomerId (cid) がアカウントページおよびページのURL に表示されます。

開発者トークンの取得

Microsoft Ads API を使用するには、CustomerId に加えてDeveloperToken が必要です。 開発者トークンを作成するには、Microsoft Ads のスーパー管理者ロールが必要ですが、トークンを使用するための特別な権利は必要ありません。

  1. Microsoft Ads スーパー管理者ロールを持つMicrosoft アカウントユーザーとしてBing Ads Developer Portalにログインします。
  2. [Request Token]をクリックして開発者トークンを書き留めます。これをDeveloperToken 接続プロパティに設定します。

Microsoft Ads への認証

OAuth

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

データモデル

CData Cloud は、Microsoft Ads API のエンティティをデータベースのビューおよびストアドプロシージャにモデル化します。これらは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。

次のセクションでは、使用可能なAPI オブジェクトへのSQL の実行について説明します。Cloud は、Microsoft Ads にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをインメモリで処理します。Cloud はMicrosoft Ads API を使用してサポートされているフィルタを処理します。Cloud は、他のフィルタを Cloud 内でクライアント側で処理します。

ビュー

レポートを含む、ビュー としてのCloud Microsoft Ads オブジェクト。

集計および期間に基づいてReports をクエリできます。デフォルトの期間は今年です。期間を変更するには、以下のTime Filter セクションを参照してください。

一部のレポートカラムのみを取得する場合、'Select Requirement' としてマークされたすべてのカラム、および'Metric' としてマークされているカラムのうち少なくとも1つを、有効なレポート要求を発行するために選択します。一方、すべてのカラムを取得する場合、ドライバーはデフォルトで必要最小限のカラムを要求に含めます。

Time Filter の指定

日付範囲

WHERE 句では、"Date" フィールドで演算子(=、<、>)を使用して日付範囲を指定できます。

次の定義済み日付フィールドをサポートしています。

  • Today
  • Yesterday
  • LastSevenDays
  • ThisWeek
  • LastWeek
  • LastFourWeeks
  • ThisMonth
  • LastMonth
  • LastThreeMonths
  • LastSixMonths
  • ThisYear
  • LastYear
DatePreset のデフォルト値は"ThisYear" です。

定義済みの日付範囲を検索するには、WHERE 句のDatePreset 疑似カラムを定義済みの日付フィールドのいずれかの値に設定します。

SELECT Monthly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM [ AccountPerformanceReport ] WHERE DatePreset = 'LastYear'
カスタム日付範囲を指定するには、WHERE 句にStartDate およびEndDate 疑似カラムを指定します。
SELECT Monthly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM [ AccountPerformanceReport ] WHERE StartDate = '2014-01-01' AND EndDate = '2017-09-19'
集計

Aggregation はデータを縮小してまとめる作業です。次の集計カラムのいずれかを選択して、レポートデータを集計できます。

  • Daily:レポートの各行は、トランザクションが発生した月、日、および年を示します。レポートデータは毎日集計されます。レポートには、Daily という名前のカラムが含まれ、このカラムにはyyyy-mm-dd 形式の日付が含まれます。
    SELECT Daily, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport
  • DayOfWeek:レポートの各行は、トランザクションが発生した曜日を示します。レポートデータは週7日ごとに集計されます。レポートにはDayOfWeek というカラムが含まれます。利用可能な値は1 - 7で、1が日曜日、7が土曜日を表します。

    レポートの期間が数週間に及ぶ場合、すべての週の特定の曜日のパフォーマンスデータが、1つの行に集計されます。例えば、レポート期間の3週間にわたってキャンペーンA のインプレッションが毎週月曜日(day 2)に5回発生した場合、レポートにはDayOfWeek が2に設定された行と、その行に合計15のインプレッションが含まれます。

    SELECT DayOfWeek, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport

  • Hourly:レポートの各行は、トランザクションが発生した時間を示します。レポートデータは1時間ごとに集計されます。レポートにはHourly というカラムが含まれます。利用可能な値は0 - 23です。
    SELECT Hourly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport
  • HourOfDay:レポートの各行は、トランザクションが発生した時刻を示します。レポートデータはすべての日にわたって24時間ごとに集計されます。レポートにはHourOfDay というカラムが含まれます。利用可能な値は0 - 23です。

    レポートの期間が数日に及ぶ場合、すべての日の特定の時間のパフォーマンスデータが、1つの行に集計されます。例えば、レポート期間の3日間にわたってキャンペーンA のインプレッションが7時に5回発生した場合、レポートにはHourOfDay に合計15のインプレッションが含まれます。

    SELECT HourOfDay, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport

  • Monthly:レポートの各行は、トランザクションが発生した月を示します。レポートデータは毎月集計されます。レポートには、Monthly という名前のカラムが含まれ、このカラムには月の初日がyyyy-mm-dd 形式で含まれます。
    SELECT Monthly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport
  • Weekly:レポートの各行は、トランザクションが発生した週を示します。レポートデータは毎週集計されます。レポートには、Weekly という名前のカラムが含まれ、このカラムには各週の日曜日の日付がyyyy-mm-dd 形式で含まれます。
    SELECT Weekly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport
  • Yearly:レポートの各行は、トランザクションが発生した年を示します。レポートデータは1年ごとに集計されます。レポートには、Yearly という名前のカラムが含まれ、このカラムにはyyyy 形式の年が含まれます。
    SELECT Yearly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Microsoft Ads ビュー

Name Description
AccountPerformanceReport Use this report to observe long-term account performance and trends.
Accounts Query the available Accounts in Bing Ads.
AdAssets Query the available Assets linked to Ads in Bing Ads.
AdDynamicTextPerformanceReport Use this report to identify which dynamic text strings are performing well and which strings you should consider changing.
AdExtensionAssets Query the available Assets linked to Ad Extensions in Bing Ads.
AdExtensionByAdReport Use this report to compare how well different versions of your ad extensions are performing with each ad.
AdExtensionByKeywordReport Use this report to compare how well different versions of your ad extensions are performing for each keyword.
AdExtensionDetailReport Use this report to discover the effectiveness of individual ad extension items, for example, each link of a sitelink extension.
AdExtensions Query the available Ad Extensions in Bing Ads.
AdGroupPerformanceReport Use this report to more broadly compare delivery performance statistics by ad group, campaign, or account attributes rather than at the keyword level.
AdGroups Query the available AdGroups in Bing Ads.
AdPerformanceReport Use this report to help you determine which ads lead to clicks and conversions, and which are not performing. Having underperforming ads in your account can pull down the quality of your campaigns.
Ads Query the available Ads in Bing Ads.
AgeGenderAudienceReport Use this report to discover how your campaigns and ad groups are resonating with audiences of diverse age and gender.
AssetGroupAssets Query the available Assets linked to Asset Groups in Bing Ads.
AssetGroups Query the available Asset Groups in Bing Ads.
AudiencePerformanceReport Use this report to compare delivery performance statistics by audience, ad group, campaign, or account attributes.
Audiences Query the available Audiences in Bing Ads.
BidOpportunities Query the available Bid Opportunities in Bing Ads.
BudgetOpportunities Query the available Budget Opportunities in Bing Ads.
Budgets Query the available Budgets in Bing Ads.
BudgetSummaryReport Use this report to discover how your campaign's budget is performing for the month. For example, the report shows your monthly budget, how much you have spent to date, and whether you are on target to spend your monthly budget.
CampaignPerformanceReport Use this report to view high-level performance statistics and quality attributes for each campaign or account. This is also a quick way to flag any major campaign or account problems.
Campaigns Query the available Campaigns in Bing Ads.
ConversionPerformanceReport Use this report to understand which campaigns and keywords are leading an audience to complete a purchase or other conversion action.
DataExclusions Query the available Data Exclusions in Bing Ads.
DestinationUrlPerformanceReport Use this report to identify landing pages that met audience expectations and potentially resulted in high click-through or conversion rates.
DSAAutoTargetPerformanceReport Use this report to find out which DSA auto targets are performing well and those that are not.
DSACategoryPerformanceReport Use this report to find out which DSA categories are performing well and those that are not.
DSASearchQueryPerformanceReport Use this report to find out which search terms are in demand for your DSA campaign and the performance of dynamic headlines that are being displayed.
GeographicPerformanceReport Use this report to see which locations your traffic is coming from. You can then validate whether your location targeting strategy is successful, and identify opportunities to improve. The report also identifies either the physical location of the search user or the geographical location interest based on the user's search query.
GoalsAndFunnelsReport Use this report to discover whether your audience completes each step through the land, browse, prospect, and conversion pages of your website. For example, you can use this report to determine the step that users leave the conversion funnel, so that you can improve or remove that step to increase the chance that the user will continue to the next step.
KeywordEstimatedBid Query the available Keyword Estimated Bid in Bing Ads.
KeywordEstimatedPosition Query the available EstimatedPosition in Bing Ads.
KeywordHistoricalSearch Query the available Keyword Historical Search in Bing Ads.
KeywordPerformance Query the available Keyword Performance in Bing Ads.
KeywordPerformanceReport Use this report to find out which keywords are performing well and those that are not.
Keywords Query the available Keywords in Bing Ads.
NegativeKeywordConflictReport Use this report to discover which keywords and negative keywords are in conflict, and whether the conflict is at the campaign or ad group level. Use this list to figure out which negative keywords to delete.
ProductDimensionPerformanceReport Use this report to find out which product dimensions are performing well and those that are not.
ProductNegativeKeywordConflictReport Use this report to discover which keywords and negative keywords are in conflict, and whether the conflict is at the campaign or ad group level. Use this list to figure out which negative keywords to delete.
ProductPartitionPerformanceReport You can include details in the report such as impressions, clicks, and spend that you can use to identify whether or not the product partitions are performing well.
ProductPartitionUnitPerformanceReport Use this report to find out which product partition units are performing well and those that are not.
ProductSearchQueryPerformanceReport Use this report to get insight into what your audience is searching for when your ads are shown as well as ensure that your product titles are relevant to search queries.
PublisherUsagePerformanceReport Use this report to see if any website URLs aren't performing well enough for your campaign or ad group target settings. For example, if ad impressions at those URLs yield a low click-through rate, then you might decide to exclude those websites from your campaign.
SearchCampaignChangeHistoryReport Use this report to discover when changes to an account were made, as well as which user made the changes.
SearchQueryPerformanceReport Use this report to see what your audience is searching for when your ads are shown. You can use this information to make informed additions, removals, or edits to both your keyword and negative keyword lists.
SeasonalityAdjustments Query the available Seasonality Adjustments in Bing Ads.
ShareOfVoiceReport Use this report to view impression share (%) of successful bids for each keyword, and identify opportunities to increase impression share.
Tags Query the available Tags in Bing Ads.
UserLocationPerformanceReport Use this report to see which locations your traffic is coming from. You can then validate whether your location targeting strategy is successful, and identify opportunities to improve. The report also identifies the physical location of the user and the intended geographical location of the user's search query, for example a user in Seattle searching for services in Portland.

CData Cloud

AccountPerformanceReport

Use this report to observe long-term account performance and trends.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Integer True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Integer True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Integer True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
CustomerId String The Bing Ads assigned identifier of a customer.
CustomerName String The customer name.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String The operating system of the device reported in the DeviceType column.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Integer True True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
AbsoluteTopImpressionSharePercent Double True The number of times your ad is shown in the top position as a percentage of the total available impressions in the market you were targeting.
Clicks Integer True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
ClickSharePercent Double True The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured.
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Integer True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
LowQualityClicks Integer True Clicks that exhibit a low likelihood of commercial intent. You are not billed for these clicks.
LowQualityClicksPercent Double True The low-quality clicks as a percentage.
LowQualityImpressions Integer True The number of impressions that result from low-quality keyword searches.
LowQualityImpressionsPercent Double True The low-quality impressions as a percentage.
LowQualityConversions Integer True The number of conversions that originate from low-quality clicks.
LowQualityConversionRate Double True The low-quality conversion rate as a percentage.
ExactMatchImpressionSharePercent Double True The estimated percentage of impressions that your account received for searches that exactly matched your keyword, out of the total available exact match impressions you were eligible to receive.
ImpressionSharePercent Double True The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankAggPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
PhoneImpressions Integer True The number of times your tracked number was shown on all devices.
PhoneCalls Integer True The number of total calls to the tracked phone number that showed with your ad.
Ptr Double True The phone-through rate (Ptr). The formula for calculating the Ptr is (PhoneCalls / PhoneImpressions) x 100.
Assists Integer True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
LowQualityGeneralClicks Integer True Clicks that are filtered by general methods, such as blacklists and activity-based detection, and that exhibit a low likelihood of commercial intent. You are not billed for these clicks.
LowQualitySophisticatedClicks Integer True Invalid clicks that use sophisticated means to appear valid. You are not billed for these clicks.
AudienceImpressionLostToBudgetPercent Double True The percentage of impression share you lost due to insufficient budget on the Microsoft Audience Network.
AudienceImpressionLostToRankPercent Double True The percentage of impression share you lost due to low rank on the Microsoft Audience Network.
AudienceImpressionSharePercent Double True The estimated percentage of impressions, out of the total available impressions you could have received on the Microsoft Audience Network.
NewCustomerConversions Integer True The total number of new customers who completed a desired action, such as making a purchase, after clicking on your ad.
NewCustomerRevenue Double True The total value of new customer conversions, calculated by summing the value of each new customer conversion.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

Accounts

Query the available Accounts in Bing Ads.

Table Specific Information

Select

Searches on this table are processed client-side by the Cloud. The following query is processed server-side:
SELECT * FROM Accounts

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The system generated identifier of the account.
Name String The name of the account.
Number String The account number.
AccountLifeCycleStatus String The status of the account.

使用できる値は次のとおりです。Draft, Active, Inactive, Pause, Pending, Suspended

PauseReason Int A flag value that indicates who paused the account. The following are the possible values: 1-The user paused the account. 2-The billing service paused the account. 4-The user and billing service paused the account.

CData Cloud

AdAssets

Query the available Assets linked to Ads in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM AdAssets
SELECT * FROM AdAssets WHERE AdGroupId = '2562405'
SELECT * FROM AdAssets WHERE AdGroupId IN ('1562405', '2562405', '3562405')
SELECT * FROM AdAssets WHERE AdType = 'ResponsiveAd'
SELECT * FROM AdAssets WHERE AdType IN ('ResponsiveAd', 'ResponsiveSearch')
SELECT * FROM AdAssets WHERE AccountId = '2562405'
SELECT * FROM AdAssets WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
AdGroupId Long The system generated identifier of the ad group.
AdId Long The unique Bing Ads identifier for the ad.
AdType String The ad type.

使用できる値は次のとおりです。ResponsiveAd, ResponsiveSearch

Id Long The ID of the asset.
AssetPerformanceLabel String This lets you know how well the asset is performing.
EditorialStatus String The editorial review status of the asset link, which indicates whether the asset is pending review, has been approved, or has been disapproved.
PinnedField String Determines whether the asset should only be used for a specific ad component, or whether you want Bing AI to optimize the layout for this asset.
Name String The asset name.
Type String The type of the asset.
Text String Text for the asset.
SubType String Represents the aspect ratio for the asset.
CropHeight Int The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
CropWidth Int The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
CropX Int Starting from the lower left corner of image asset source, this is the number of pixels to skip to the right on the x-axis before applying the CropWidth.
CropY Int Starting from the lower left corner of image asset source, this is the number of pixels to skip upwards on the y-axis before applying the CropHeight.
TargetHeight Int The target height dimension of an image asset.
TargetWidth Int The target width dimension of an image asset.
ThumbnailImageSubType String Represents the aspect ratio for this image asset.
ThumbnailImageCropHeight Int The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
ThumbnailImageCropWidth Int The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
ThumbnailImageCropX Int Starting from the lower left corner of image asset source, this is the number of pixels to skip to the right on the x-axis before applying the CropWidth.
ThumbnailImageCropY Int Starting from the lower left corner of image asset source, this is the number of pixels to skip upwards on the y-axis before applying the CropHeight.
ThumbnailImageTargetHeight Int The target height dimension of an image asset.
ThumbnailImageTargetWidth Int The target width dimension of an image asset.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

AdDynamicTextPerformanceReport

Use this report to identify which dynamic text strings are performing well and which strings you should consider changing.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
Keyword String The keyword text.
AdId Long Ad Id
AdTitle String True The ad title.
AdType String The ad type.
AdLabels String The labels applied to the ad.
DestinationUrl String True The destination URL attribute of the ad, keyword, or ad group criterion.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
Param1 String True The first dynamic substitution parameter (Param1) of a keyword or biddable ad group criterion.
Param2 String True The second dynamic substitution parameter (Param2) of a keyword or biddable ad group criterion.
Param3 String True The third dynamic substitution parameter (Param3) of a keyword or biddable ad group criterion.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
KeywordStatus String The keyword status.
TitlePart1 String The title part 1 attribute of an ad.
TitlePart2 String The title part 2 attribute of an ad.
TitlePart3 String The title part 3 attribute of an ad.
Path1 String The path 1 attribute of an ad.
Path2 String The path 2 attribute of an ad.
FinalUrl String The Final URL of the ad, keyword, or criterion.
FinalMobileUrl String The Final Mobile URL of the ad, keyword, or criterion.
FinalAppUrl String Reserved for future use.
AdDescription String The text attribute of an ad.
AdDescription2 String The second ad description that appears below the path in your ad. Ad description 2 might not appear in your ad.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

AdExtensionAssets

Query the available Assets linked to Ad Extensions in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM AdExtensionAssets
SELECT * FROM AdExtensionAssets WHERE AdExtensionId = '2562405'
SELECT * FROM AdExtensionAssets WHERE AdExtensionId IN ('1562405', '2562405', '3562405')
SELECT * FROM AdExtensionAssets WHERE AdExtensionType = 'ImageAdExtension'
SELECT * FROM AdExtensionAssets WHERE AccountId = '2562405'
SELECT * FROM AdExtensionAssets WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
AdExtensionId Long The ID of the ad extension.
AdExtensionType String The type of ad extension.

使用できる値は次のとおりです。ImageAdExtension

Id Long The ID for the asset.
Name String The asset name.
Type String The type of the asset.
SubType String Represents the aspect ratio for the asset.
CropHeight Int The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
CropWidth Int The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
CropX Int Starting from the lower left corner of image asset source, this is the number of pixels to skip to the right on the x-axis before applying the CropWidth.
CropY Int Starting from the lower left corner of image asset source, this is the number of pixels to skip upwards on the y-axis before applying the CropHeight.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

AdExtensionByAdReport

Use this report to compare how well different versions of your ad extensions are performing with each ad.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long True The Bing Ads assigned identifier of an ad group.
AdTitle String True The ad title.
AdExtensionType String True The type name that corresponds to the AdExtensionTypeId column.
AdExtensionVersion String The version attribute of an ad extension.
AdExtensionId Long The identifier of the ad extension.
AdId Long Ad Id
AccountStatus String The account status.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
CampaignStatus String The campaign status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
ClickType String Click type refers to each component of an ad that a customer can click.
TitlePart1 String The title part 1 attribute of an ad.
TitlePart2 String The title part 2 attribute of an ad.
TitlePart3 String The title part 3 attribute of an ad.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
TotalClicks Int True The number of billable and non-billable times that the ad extension was clicked.
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

AdExtensionByKeywordReport

Use this report to compare how well different versions of your ad extensions are performing for each keyword.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdExtensionType String True The Bing Ads assigned identifier of an ad extension.
AdExtensionId Long The version attribute of an ad extension.
AdExtensionVersion String The version attribute of an ad extension.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
CampaignStatus String The campaign status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
ClickType String Click type refers to each component of an ad that a customer can click.
Keyword String True The keyword text.
KeywordId String The Bing Ads assigned identifier of a keyword.
KeywordStatus String The keyword status.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
TotalClicks Int True The number of billable and non-billable times that the ad extension was clicked.
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

AdExtensionDetailReport

Use this report to discover the effectiveness of individual ad extension items, for example, each link of a sitelink extension.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdTitle String The ad title.
AdId String The Bing Ads assigned identifier of an ad.
AdExtensionType String True The Bing Ads assigned identifier of an ad extension.
AdExtensionTypeId String True The system identifier that corresponds to the AdExtensionType column. The supported identifiers are 10, 11, and 12.
AdExtensionId Long True The version attribute of an ad extension.
AdExtensionVersion String The version attribute of an ad extension.
AdExtensionPropertyValue String True The human readable ad extension property value. For this report only one property is available for each type of ad extension.
AdStatus String The ad status.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
CampaignStatus String The campaign status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

AdExtensions

Query the available Ad Extensions in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM AdExtensions
SELECT * FROM AdExtensions WHERE Id = '2562405'
SELECT * FROM AdExtensions WHERE Id IN ('1562405', '2562405', '3562405')
SELECT * FROM AdExtensions WHERE Type = 'ActionAdExtension'
SELECT * FROM AdExtensions WHERE Type IN ('ActionAdExtension', 'AppAdExtension')
SELECT * FROM AdExtensions WHERE AccountId = '2562405'
SELECT * FROM AdExtensions WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The ID of the ad extension.
Type String The type of ad extension.

使用できる値は次のとおりです。ActionAdExtension, AppAdExtension, CallAdExtension, CalloutAdExtension, DisclaimerAdExtension, FilterLinkAdExtension, FlyerAdExtension, ImageAdExtension, LocationAdExtension, LogoAdExtension, PriceAdExtension, PromotionAdExtension, ReviewAdExtension, SitelinkAdExtension, StructuredSnippetAdExtension, VideoAdExtension

Version Int Tracks the number of times the ad extension has been updated.
DevicePreference Long This element determines whether the preference is for the ad extension to be displayed on mobile devices or all devices.
SchedulingStartDate Date The scheduled start date.
SchedulingEndDate Date The scheduled end date.
SchedulingUseSearcherTimeZone Bool Determines whether to use the account time zone or the time zone of the search user where the ads could be delivered.
SchedulingDayTimeRanges String The list of day and time ranges.
Language String The language for the ad extension.
ActionType String The action text.
FinalUrls String The landing page URL.
FinalUrlSuffix String The suffix added to the landing page URL.
FinalMobileUrls String The mobile landing page URL.
TrackingUrlTemplate String The tracking template to use as a default for all FinalUrls and FinalMobileUrls.
UrlCustomParameters String Your custom collection of key and value parameters for URL tracking.
AppPlatform String The application platform.
AppStoreId String The application identifier provided by the app store.
DestinationUrl String The URL of the webpage to take the user to when they click.
DisplayText String The text displayed in the ad extension.
CountryCode String The country code where the phone number is registered.
IsCallOnly Bool The option to show both your phone number and website, or just your phone number, to people seeing your ads on a smartphone.
IsCallTrackingEnabled Bool Determines whether call tracking is enabled for the call ad extension.
PhoneNumber String The phone number to include in the ad.
RequireTollFreeTrackingNumber Bool You can either use your own phone number or use a Bing Ads forwarding phone number.
Text String Text value relevant to the extension.
AdExtensionHeaderType String The header that is appended with a colon and precedes the filter link values in the ad that is shown.
Texts String The text values that follow after the AdExtensionHeaderType component of the ad that is shown.
Description String Description that can be used by the advertiser, agency, or account manager to track, label, or manage extensions.
FlyerName String The flyer name.
ImageMediaIds String The identifier of the image to include in the ad.
Images String Image assets with different sizes and aspect ratios so they can flexibly display across a variety of publishers and placements.
ImageMediaUrls String The URL of the media that you already added.
StoreId Long The unique identifier of a Microsoft Merchant Center store used for product ads.
AlternativeText String Alternative description of the image media for usability. If the image could not be displayed, the alternative text is used instead.
Layouts String The list of eligible image layouts.
SourceType String The source type.
AddressCityName String The name of the city where the street address is located.
AddressCountryCode String The country where the street address is located.
AddressPostalCode String The postal or zip code.
AddressProvinceCode String A code that identifies the state or province where the street address is located.
AddressProvinceName String The name of the state or province where the street address is located.
AddressStreetAddress String The first line of the address.
AddressStreetAddress2 String The second line of the address.
CompanyName String The name of the business.
GeoCodeStatus String A status value that indicates whether the business latitude and longitude coordinates have been determined.
GeoPointLatitudeInMicroDegrees Int The latitude specified in micro degrees
GeoPointLongitudeInMicroDegrees Int The longitude specified in micro degrees
BusinessLogo Long The asset ID for the business logo.
BusinessLogoUrl String The URL of the business logo.
BusinessName String The business name.
DomainName String The domain name.
PriceExtensionType String The type of the price ad extension.
TableRows String The price table rows.
CurrencyCode String The currency code for the promotion price or discount.
DiscountModifier String The promotion discount modifier.
MoneyAmountOff Double The money off promotion value.
OrdersOverAmount Double The orders over amount value appended to the promotion target.
PercentOff Double The percent off promotion value.
PromotionCode String The promotion code appended to the promotion target.
PromotionItem String The promotion target or item.
PromotionOccasion String The promotion occasion.
PromotionStartDate Date The start date helps to inform the promotion date or dates that will be displayed in the ad.
PromotionEndDate Date The end date helps to inform the promotion date or dates that will be displayed in the ad.
IsExact Bool Determines whether the review text is an exact quote or paraphrased.
Source String The review source name.
Url String The review source Url.
Description1 String The site link description line 1.
Description2 String The site link description line 2.
Header String The header that is appended with a colon and precedes the snippet values.
Values String The snippet values that follow after the Header component of the ad that is shown.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

AdGroupPerformanceReport

Use this report to more broadly compare delivery performance statistics by ad group, campaign, or account attributes rather than at the keyword level.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
Status String The ad distribution attribute of an ad group.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
CustomerId String The Bing Ads assigned identifier of a customer.
CustomerName String The customer name.
AdGroupName String The ad group name.
AdGroupLabels String The labels applied to the ad group.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
AccountStatus String The account status.
CampaignStatus String The campaign status.
TrackingTemplate String The current tracking template for the ad group.
CustomParameters String The current custom parameters set for the ad group.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
AbsoluteTopImpressionSharePercent Double True The number of times your ad is shown in the top position as a percentage of the total available impressions in the market you were targeting.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
ClickSharePercent Double True The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured.
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
ExactMatchImpressionSharePercent Double True The estimated percentage of impressions that your account received for searches that exactly matched your keyword, out of the total available exact match impressions you were eligible to receive.
ImpressionSharePercent Double True The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankAggPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
QualityScore Int True The numeric score shows you how competitive your ads are in the marketplace by measuring how relevant your keywords and landing pages are to customers' search terms.
ExpectedCtr Int True How well your keyword competes against other keywords targeting the same traffic. Ads that are relevant to searchers' queries or other input are more likely to have a higher click-through rate. This metric tells you if a keyword is underperforming and causing a loss in impression share, so you can make keyword changes or remove ads altogether.
AdRelevance Int True How closely related your ads is to the customer's search query or other input. It tells you how relevant your ad and landing page are to potential customers.
LandingPageExperience Int True An aggregate quality assessment of all landing pages on your site. The landing page experience score measures whether your landing page is likely to provide a good experience to customers who click your ad and land on your website.
HistoricalQualityScore Int True The historic quality score of the keyword. The historic quality score for each row is the value that was calculated for quality score on that date.
HistoricalExpectedCtr Int True Historical average of expected click-through rate scores going back as far as 18 months from the current date. This score may vary from the score in the ExpectedCtr column, which is the current score and same value for each day in the time period.
HistoricalAdRelevance Int True Historical average of ad relevance scores back as far as 18 months from the current date.
HistoricalLandingPageExperience Int True Historical average of landing page experience scores back as far as 18 months from the current date.
PhoneImpressions Int True The number of times your tracked number was shown on all devices.
PhoneCalls Int True The number of total calls to the tracked phone number that showed with your ad. The formula for calculating the phone calls is ManualCalls + ClickCalls.
Ptr Double True The phone-through rate (Ptr).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
AudienceImpressionLostToBudgetPercent Double True The percentage of impression share you lost due to insufficient budget on the Microsoft Audience Network.
AudienceImpressionLostToRankPercent Double True The percentage of impression share you lost due to low rank on the Microsoft Audience Network.
AudienceImpressionSharePercent Double True The estimated percentage of impressions, out of the total available impressions you could have received on the Microsoft Audience Network.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

AdGroups

Query the available AdGroups in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM AdGroups
SELECT * FROM AdGroups WHERE CampaignId = '234505536'

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The system generated identifier of the ad group.
CampaignId Long The system generated identifier of the campaign.
Name String The name of the ad group.
AdRotationType String Determines how often you'd like the ads in your ad group to show in relation to one another. If you have multiple ads within an ad group, your ads will rotate because no more than one ad from your account can show at a time.
StartDate Date The date that the ads in the ad group can begin serving; otherwise, the service can begin serving the ads in the ad group the day that the ad group becomes active.
EndDate Date The date that the ads in the ad group will expire.
Language String The language of the ads and keywords in the ad group.
CpcBidAmount Double The default bid to use when the user's query and the ad group's keywords match by using either a broad, exact, or phrase match comparison..
AudienceAdsBidAdjustment String The percent amount by which to adjust your bid for native ads above or below the base ad group or keyword bid.
BiddingSchemeType String The bid strategy type for how you want to manage your bids.
ForwardCompatibilityMap String The list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.
Network String The search networks where you want your ads to display.
Status String The status of the ad group.
TrackingUrlTemplate String The tracking template to use as a default for all URLs in your ad group.
UrlCustomParameters String Your custom collection of key and value parameters for URL tracking.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

AdPerformanceReport

Use this report to help you determine which ads lead to clicks and conversions, and which are not performing. Having underperforming ads in your account can pull down the quality of your campaigns.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdLabels String The labels applied to the ad.
AdGroupName String The ad group name.
AdId Long The Bing Ads Ad identifier
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdTitle String The ad title.
AdDescription String The text attribute of an ad.
AdDescription2 String The second ad description that appears below the path in your ad. Ad description 2 might not appear in your ad.
AdType String The ad type.
CustomerId String The Bing Ads assigned identifier of a customer.
CustomerName String The customer name.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
AccountStatus String The account status.
CampaignStatus String The campaign status.
TrackingTemplate String The current tracking template of the ad, keyword, or criterion.
CustomParameters String The current custom parameters set of the ad, keyword, or criterion.
FinalUrl String The Final URL of the ad, keyword, or criterion.
FinalMobileUrl String The Final Mobile URL of the ad, keyword, or criterion.
FinalAppUrl String Reserved for future use.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
Headline String The shorter of two possible responsive ad headlines for Audience campaigns.
LongHeadline String The longer of two possible responsive ad headlines for Audience campaigns.
TitlePart1 String The title part 1 attribute of an ad.
TitlePart2 String The title part 2 attribute of an ad.
TitlePart3 String The title part 3 attribute of an ad.
Path1 String The path 1 attribute of an ad.
Path2 String The path 2 attribute of an ad.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
DisplayUrl String The ad display URL.
BusinessName String Depending on your responsive ad's placement, your business's name may appear in your ad. This column only applies to Audience campaigns.
DeviceOS String The operating system of the device reported in the DeviceType column. The possible values include Android, Blackberry, iOS, Other, Unknown, and Windows.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion. If the destination URL contains dynamic text substitution parameters (for example, {param1}), the report will contain the URL after substitution occurs.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match. The possible values are Broad, Exact, Phrase, and Unknown.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

Ads

Query the available Ads in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM Ads
SELECT * FROM Ads WHERE AdGroupId = '5179946006'
SELECT * FROM Ads WHERE Type = 'Text'
SELECT * FROM Ads WHERE Type IN ('ExpandedText','Text')
SELECT * FROM Ads WHERE AdGroupId = '5179946006' AND Type = 'Text'
SELECT * FROM Ads WHERE AdGroupId IN ('5179946006',''5179946007'') AND Type = 'Text'
SELECT * FROM Ads WHERE AdGroupId IN ('5179946006',''5179946007'') AND Type IN ('ExpandedText','Text')
SELECT * FROM Ads WHERE AdGroupId = '1297424037031698' AND Type = 'DynamicSearch' AND AccountId = '135093022'
SELECT * FROM Ads WHERE AccountId IN ('2562405', '141163457', '180394748')

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The unique Bing Ads identifier for the ad.
AdGroupId Long The system generated identifier of the ad group.
Type String The ad type.

使用できる値は次のとおりです。Text, Image, Product, AppInstall, ExpandedText, DynamicSearch, ResponsiveAd, ResponsiveSearch, Hotel

Title String The title of the ad. The title must contain at least one word. The ad's copy and title combined must total at least three words.
TitlePart1 String The first title part of the ad.
TitlePart2 String The second title part of the ad.
Text String The ad copy. The copy must contain at least one word. The ad's copy and title combined must total at least three words.
Domain String The URL to display in the ad.
DestinationUrl String The URL of the webpage to take the user to when they click the ad.
UrlCustomParameters String Your custom collection of key and value parameters for URL tracking.
TrackingUrlTemplate String The tracking template to use as a default for all landing page URLs.
Status String The status of the ad.
ForwardCompatibilityMap String The list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.
FinalUrls String The last or final URL where a user is ultimately taken, whether or not the click to final URL path included any redirects.
FinalMobileUrls String The mobile landing page URL.
FinalAppUrls String Reserved for future use.
EditorialStatus String The editorial review status of the ad, which indicates whether the ad is pending review, has been approved, or has been disapproved.
DevicePreference Int Determines the device preference for showing the ad.
AdFormatPreference String The Ad Format Preference is used to indicate whether or not you prefer the ad copy to be shown to users as a search or native ad. Search ads tend to be written as a call to action, whereas native ads should be written in more of an informational style.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

AgeGenderAudienceReport

Use this report to discover how your campaigns and ad groups are resonating with audiences of diverse age and gender.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String True The account name.
AccountNumber String The Microsoft Advertising assigned number of an account.
AccountId Long The Microsoft Advertising assigned identifier of an account.
AdGroupId Long The Microsoft Advertising assigned identifier of an ad group.
CampaignId Long The Microsoft Advertising assigned identifier of a campaign.
AdGroupName String True The ad group name.
CampaignName String The campaign name.
AdDistribution String The network where you want your ads to show.
Gender String True The gender (male or female) of the search users to whom the ad was delivered..
AgeGroup String True The age group of the audience who viewed the ad. The possible values are 13-17, 18-24, 25-34, 35-49, 50-64, and 65+.
Language String This is the language of the country the ad is served in.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
AllConversions Double The number of conversions. A conversion is the completion of an action by a customer after viewing your ad.
AllRevenue Decimal The revenue optionally reported by the advertiser as a result of conversions.
Assists Int The number of times an entity (an account, campaign, ad group, or keyword, for example) contributed to a conversion that is associated with a different entity.
BaseCampaignId Long The Microsoft Advertising assigned identifier of an experiment campaign. This will be the same value as the CampaignId if the campaign is not an experiment.
Impressions Long True The number of times an ad has been displayed on search results pages or other sites on the Audience Network.
Clicks Int Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network.
Conversions Int The number of conversions. A conversion is the completion of an action by a customer after viewing your ad.
ExtendedCost Decimal Cost information that is optionally provided by advertisers, including non-advertising costs, taxes, and shipping.
Revenue Decimal The revenue optionally reported by the advertiser as a result of conversions.
Spend Decimal The sum of your cost-per-click (CPC) charges for your ads and keywords. Spend helps you keep track of your budget.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

AssetGroupAssets

Query the available Assets linked to Asset Groups in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM AssetGroupAssets
SELECT * FROM AssetGroupAssets WHERE CampaignId = '2562405'
SELECT * FROM AssetGroupAssets WHERE CampaignId IN ('1562405', '2562405', '3562405')
SELECT * FROM AssetGroupAssets WHERE AccountId = '2562405'
SELECT * FROM AssetGroupAssets WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
AssetGroupId Long The asset group ID.
Id Long The ID for the asset.
AssetPerformanceLabel String This lets you know how well the asset is performing.
EditorialStatus String The editorial review status of the asset link, which indicates whether the asset is pending review, has been approved, or has been disapproved.
PinnedField String Determines whether the asset should only be used for a specific ad component, or whether you want Bing AI to optimize the layout for this asset.
Name String The asset name.
Type String The type of the asset.
Text String Text for the asset.
SubType String Represents the aspect ratio for the asset.
CropHeight Int The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
CropWidth Int The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
CropX Int Starting from the lower left corner of image asset source, this is the number of pixels to skip to the right on the x-axis before applying the CropWidth.
CropY Int Starting from the lower left corner of image asset source, this is the number of pixels to skip upwards on the y-axis before applying the CropHeight.
CampaignId Long The system generated identifier of the campaign.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

AssetGroups

Query the available Asset Groups in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM AssetGroups
SELECT * FROM AssetGroups WHERE CampaignId = '2562405'
SELECT * FROM AssetGroups WHERE CampaignId IN ('1562405', '2562405', '3562405')
SELECT * FROM AssetGroups WHERE AccountId = '2562405'
SELECT * FROM AssetGroups WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The asset group ID.
Name String The name of the asset group.
BusinessName String The name of the business.
Status String The status of the Asset group.
EditorialStatus String The editorial review status of the asset group, which indicates whether the asset group is pending review, has been approved, or has been disapproved.
CallToAction String A brief, punchy reason for customers to click your ad right now.
FinalUrls String The landing page URL.
FinalMobileUrls String The mobile landing page URL.
Path1 String The first part of the optional path that will be appended to the domain portion of your display URL.
Path2 String The second part of the optional path that will be appended to the domain portion of your display URL.
StartDate Date The date that the asset group can begin serving; otherwise, the service can begin serving ads the day that the asset group becomes active.
EndDate Date The date that the asset group will expire.
Descriptions String The descriptions that are shown below the path in your ad.
Headlines String Short headlines that appear in your ad.
LongHeadlines String Long headlines that appear in your ad.
Images String Image assets with different sizes and aspect ratios so they can flexibly display across a variety of publishers and placements.
AssetGroupSearchThemes String A list of asset group search themes.
CampaignId Long The system generated identifier of the campaign.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

AudiencePerformanceReport

Use this report to compare delivery performance statistics by audience, ad group, campaign, or account attributes.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long True The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AudienceId Long True The Bing Ads assigned identifier of the audience, for example the remarketing list ID.
AudienceName String The audienc name.
AudienceType String The audience type.
AssociationStatus String The status of the association between the ad group and remarketing list, which indicates whether ads are eligible to display. The possible values are Active, Paused, and Deleted.
BidAdjustment String This attribute reflects the current value of your ad group's audience bid adjustment, even if a different bid adjustment value was used when the ad was shown. This value is the requested percentage to increase or decrease the bid amount for the remarketing list.
TargetingSetting String This attribute reflects the current value of your ad group's audience targeting setting. The possible values are Target and bid or Bid only.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

Audiences

Query the available Audiences in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM Audiences
SELECT * FROM Audiences WHERE Type = 'RemarketingList'
SELECT * FROM Audiences WHERE AccountId = '65098547' AND Type = 'RemarketingList'

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The Bing Ads identifier of the audience.
ParentId Long The Bing Ads identifier of the account or customer.
Name String The name of the audience. The name can contain a maximum of 128 characters.
Type String The type of the audience.

使用できる値は次のとおりです。RemarketingList, Custom, InMarket, Product, SimilarRemarketingList, CombinedList, CustomerList

Description String The description of the audience. Use a description to help you remember what audience you are targeting.
MembershipDuration Int When you create an audience, you can specify how far back in time Bing Ads should look for actions that match your audience definition.
ForwardCompatibilityMap String The list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.
Scope String Scope defines what accounts can use this audience.

使用できる値は次のとおりです。Account, Customer

TagId Long The unique Bing Ads identifier of the tag.
AudienceNetworkSize Long The total number of people who are active members of this audience in the Audience network.
SearchSize Long The total number of people who are active members of this audience in the Search network.
SupportedCampaignTypes String The list of campaign types that support this audience.
CustomerShareAggregate String Contains information about CustomerAccountShares and OwnerCustomerId.
CombinationRules String Logical conditions used to determine who to add to your combined list.
AdGroupId Long The ad group identifier to associate with the impression-based remarketing list.
CampaignId Long The campaign identifier to associate with the impression-based remarketing list.
EntityType String The entity type of an impression-based remarketing list.
ProductAudienceType String Determines whether to remarket your products to general visitors, product searchers, product viewers, shopping cart abandoners, or past buyers.
RuleType String The type of the remarketing rule.
RuleNormalForm String Determines whether the rule item groups are evaluated based on conjunctive normal form (CNF) or disjunctive normal form (DNF).
RuleItemGroups String The list of rule item groups that you want applied to the remarketing list.
RuleAnotherRuleItemGroups String The list of rule item groups related to other pages the audience visited.
RuleExcludeRuleItemGroups String The list of rule item groups that you want applied as exclusions to the remarketing list.
RuleIncludeRuleItemGroups String The list of rule item groups that you want applied to the remarketing list.
RuleActionOperator String The operator that can be applied to the value of the Action element.
RuleAction String The type of user interaction you want to track. For example 'play' or 'pause'.
RuleCategoryOperator String The operator that can be applied to the value of the Category element.
RuleCategory String The category of event you want to track. For example, 'video'.
RuleLabelOperator String The operator that can be applied to the value of the Label element.
RuleLabel String The name of the element that caused the action. For example 'trailer' or 'behindthescenes'.
RuleValueOperator String The operator that can be applied to the value of the Value element.
RuleValue Int A positive integer value associated with that event. For example the value could be the duration of time that the video played.
SourceId Long The ID of the remarketing list that Bing Ads used to generate this similar audience.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

BidOpportunities

Query the available Bid Opportunities in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM BidOpportunities
SELECT * FROM BidOpportunities WHERE OpportunityType = 'FirstPage'

Columns

Name Type Select requirement Metric Aggregate Description
OpportunityKey String An identifier that uniquely identifies the opportunity.
AdGroupId Long The identifier of the ad group that owns the keyword.
CampaignId Long The identifier of the campaign for the ad group that owns the keyword.
OpportunityType String Defines the possible bid opportunity types you can request when calling GetBidOpportunities.

使用できる値は次のとおりです。FirstPage, MainLine, MainLine1

CurrentBid Double The current keyword bid amount specified for the match type in the MatchType element.
EstimatedIncreaseInClicks Double The estimated clicks opportunities corresponding to the suggested bid.
EstimatedIncreaseInCost Double The estimated increase in spend corresponding to the suggested bid.
EstimatedIncreaseInImpressions Long The estimated impressions opportunities corresponding to the suggested bid.
KeywordId Long The identifier of the keyword to which the bid opportunity applies.
MatchType String The match type to which the suggested bid value applies. The possible values are BroadMatch, ExactMatch, and PhraseMatch.
SuggestedBid Double The suggested bid based on the last 7 days of performance history for the corresponding ad group.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

BudgetOpportunities

Query the available Budget Opportunities in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM BudgetOpportunities
SELECT * FROM BudgetOpportunities WHERE CampaignId = '234505536'

Columns

Name Type Select requirement Metric Aggregate Description
OpportunityKey String An identifier that uniquely identifies the opportunity.
BudgetAmount Double A potential new budget.
BudgetPointType String The type of budget relative to a list of budget points. For example, if the budget point type is Current then this object's BudgetAmount element would be equal to the corresponding campaign's daily budget.
EstimatedWeeklyClicks Double The estimated weekly clicks for the given budget amount.
EstimatedWeeklyCost Double The estimated weekly cost for the given budget amount.
EstimatedWeeklyImpressions Double The estimated weekly impressions for the given budget amount.
BudgetType String The type of budget that the campaign uses.
CampaignId Long The identifier of the campaign to which the suggested budget applies
CurrentBudget Double The campaign's current budget.
IncreaseInClicks Double The estimated clicks opportunities corresponding to the suggested budget.
IncreaseInImpressions Double The estimated impressions opportunities corresponding to the suggested budget.
PercentageIncreaseInClicks Int The estimated percentage increase in clicks corresponding to the suggested budget.
PercentageIncreaseInImpressions Int The estimated percentage increase in impressions corresponding to the suggested budget.
RecommendedBudget Double The suggested budget based on the last 15 days of performance history for the corresponding campaign.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

Budgets

Query the available Budgets in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM Budgets
SELECT * FROM Budgets WHERE CampaignId = '431046229' AND AccountId = '65098547'

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The unique Bing Ads identifier of the budget.
CampaignId Long The system generated identifier of the campaign.
Name String The name of the budget. The name must be unique among all budgets within the account. The name can contain a maximum of 255 characters.
Amount Double The amount to spend daily across all campaigns that share the budget.
AssociationCount Int The number of Campaign objects that currently share this budget.
BudgetType String The budget type determines the pace at which the budget is spent throughout the day.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

BudgetSummaryReport

Use this report to discover how your campaign's budget is performing for the month. For example, the report shows your monthly budget, how much you have spent to date, and whether you are on target to spend your monthly budget.

Columns

Name Type Select requirement Metric Aggregate Description
AccountName String True The account name.
AccountNumber String True The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String True The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign.
Date String True The date for the downloaded report records. The date will be in the time zone of the campaign.
CurrencyCode String True The account currency type.
MonthlyBudget String The average amount of campaign budget spent during a calendar month.
DailySpend String True The average amount of campaign budget spent per day.
MonthToDateSpend String The amount of money spent to date for the month.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

CampaignPerformanceReport

Use this report to view high-level performance statistics and quality attributes for each campaign or account. This is also a quick way to flag any major campaign or account problems.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AccountStatus String The account status.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign.
CampaignLabels String The labels applied to the campaign.
CampaignStatus String The campaign status.
CampaignType String The campaign type.
CustomerId String The Bing Ads assigned identifier of a customer.
CustomerName String The customer name.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
BudgetName String The name of the budget.
BudgetStatus String The budget status. The possible values are Active and Deleted.
BudgetAssociationStatus String Indicates whether or not the campaign is currently spending from the budget mentioned in the BudgetName column. The possible values are Current and Ended.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String The operating system of the device reported in the DeviceType column.
TrackingTemplate String The current tracking template for the ad group.
CustomParameters String The current set of custom parameters for the campaign.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
AbsoluteTopImpressionSharePercent Double True The number of times your ad is shown in the top position as a percentage of the total available impressions in the market you were targeting.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
ClickSharePercent Double True The percentage of clicks that went to your ads.It is the share of the prospective customer's mindshare and buying intent you captured.
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
LowQualityClicks Int True Clicks that exhibit a low likelihood of commercial intent. You are not billed for these clicks.
LowQualityClicksPercent Double True The low-quality clicks as a percentage.
LowQualityImpressions Int True The number of impressions that result from low-quality keyword searches.
LowQualityImpressionsPercent Double True The low-quality impressions as a percentage.
LowQualityConversions Int True The number of conversions that originate from low-quality clicks.
LowQualityConversionRate Double True The low-quality conversion rate as a percentage.
ExactMatchImpressionSharePercent Double True The estimated percentage of impressions that your account received for searches that exactly matched your keyword, out of the total available exact match impressions you were eligible to receive.
ImpressionSharePercent Double True The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankAggPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
QualityScore Int True The numeric score shows you how competitive your ads are in the marketplace by measuring how relevant your keywords and landing pages are to customers' search terms.
ExpectedCtr Int True How well your keyword competes against other keywords targeting the same traffic. Ads that are relevant to searchers' queries or other input are more likely to have a higher click-through rate. This metric tells you if a keyword is underperforming and causing a loss in impression share, so you can make keyword changes or remove ads altogether.
AdRelevance Int True How closely related your ads is to the customer's search query or other input. It tells you how relevant your ad and landing page are to potential customers.
LandingPageExperience Int True An aggregate quality assessment of all landing pages on your site. The landing page experience score measures whether your landing page is likely to provide a good experience to customers who click your ad and land on your website.
HistoricalQualityScore Int True The historic quality score of the keyword. The historic quality score for each row is the value that was calculated for quality score on that date.
HistoricalExpectedCtr Int True Historical average of expected click-through rate scores going back as far as 18 months from the current date. This score may vary from the score in the ExpectedCtr column, which is the current score and same value for each day in the time period.
HistoricalAdRelevance Int True Historical average of ad relevance scores back as far as 18 months from the current date.
HistoricalLandingPageExperience Int True Historical average of landing page experience scores back as far as 18 months from the current date.
PhoneImpressions Int True The number of times your tracked number was shown on all devices.
PhoneCalls Int True The number of total calls to the tracked phone number that showed with your ad. The formula for calculating the phone calls is ManualCalls + ClickCalls.
Ptr Double True The phone-through rate (Ptr).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
LowQualityGeneralClicks Double True Clicks that are filtered by general methods, such as blacklists and activity-based detection, and that exhibit a low likelihood of commercial intent. You are not billed for these clicks.
LowQualitySophisticatedClicks Double True Invalid clicks that use sophisticated means to appear valid. You are not billed for these clicks. For more information, see Bing Ads click measurement: description of methodology.
AudienceImpressionLostToBudgetPercent Double True The percentage of impression share you lost due to insufficient budget on the Microsoft Audience Network.
AudienceImpressionLostToRankPercent Double True The percentage of impression share you lost due to low rank on the Microsoft Audience Network.
AudienceImpressionSharePercent Double True The estimated percentage of impressions, out of the total available impressions you could have received on the Microsoft Audience Network.
TopImpressionSharePercent Double True The percentage of impressions for your ad in the mainline, the top ad placements above the search results, out of the estimated number of mainline impressions you were eligible to receive.
TopImpressionRatePercent Double True The percentage of times your ad showed in the mainline, the top placement where ads appear above the search results, out of your total impressions.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

Campaigns

Query the available Campaigns in Bing Ads.

Table Specific Information

Select

The following query is processed server-side:

SELECT * FROM Campaigns

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The unique Bing Ads identifier of the campaign.
AccountId String The unique Bing Ads identifier of the account associated with this campaign.
CampaignType String The campaign type determines whether the campaign is an Audience, Dynamic Search Ads, Search, Shopping or Search & Content campaign.

使用できる値は次のとおりです。Search, Shopping, DynamicSearchAds, Audience, Hotel, PerformanceMax, App

Name String The name of the campaign. The name must be unique among all active or paused campaigns within the account.
Status String The status of the campaign.

使用できる値は次のとおりです。Active, Paused

SubType String The campaign sub type. This element is only applicable for campaigns of type Shopping, and will be nil for all other campaign types.
BiddingSchemeType String The bid strategy type for how you want to manage your bids.

使用できる値は次のとおりです。EnhancedCpc, InheritFromParent, ManualCpc, MaxClicks, MaxConversions, TargetCpa

BudgetType String The budget type determines how the budget is spent.

使用できる値は次のとおりです。DailyBudgetAccelerated, DailyBudgetStandard

DailyBudget Double The amount to spend daily on the campaign. You must set the daily budget amount if BudgetId is not set.
ExperimentId Long The system generated identifier of the Experiment.
TimeZone String The time zone where the campaign operates.
TrackingUrlTemplate String The tracking template to use as a default for all URLs in your campaign.
UrlCustomParameters String Your custom collection of key and value parameters for URL tracking.
BudgetId Long The unique Bing Ads identifier of the Budget that this campaign shares with other campaigns in the account.
AudienceAdsBidAdjustment Int The percent amount by which to adjust your bid for audience ads above or below the base ad group or keyword bid.
Languages String The languages of the ads and keywords in the campaign.

CData Cloud

ConversionPerformanceReport

Use this report to understand which campaigns and keywords are leading an audience to complete a purchase or other conversion action.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdGroupName String The ad group name.
CampaignName String The campaign name.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
KeywordStatus String The keyword status.
KeywordId Long The Bing Ads assigned identifier of a keyword.
Keyword String The keyword text.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
Spend Double True The cost per click (CPC) summed for each click.
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

DataExclusions

Query the available Data Exclusions in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM DataExclusions
SELECT * FROM DataExclusions WHERE AccountId = '2562405'
SELECT * FROM DataExclusions WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The data exclusion ID.
Name String The data exclusion name.
Description String A description for the data exclusion.
CampaignAssociations String Which campaigns to include for the data exclusion.
CampaignTypeFilter String Which campaign types to include for the data exclusion.
DeviceTypeFilter String Which devices types to include for the data exclusion.
StartDate Datetime The start date.
EndDate Datetime The end date.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

DestinationUrlPerformanceReport

Use this report to identify landing pages that met audience expectations and potentially resulted in high click-through or conversion rates.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String True The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdId Long Ad Id
DestinationUrl String True The destination URL attribute of the ad, keyword, or ad group criterion.
CustomerId String The Bing Ads assigned identifier of a customer.
CustomerName String The customer name.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
FinalUrl String The Final URL of the ad, keyword, or criterion.
FinalMobileUrl String The Final Mobile URL of the ad, keyword, or criterion.
FinalAppUrl String Reserved for future use.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
CampaignStatus String The campaign status.
TrackingTemplate String The current tracking template for the ad group.
CustomParameters String The current set of custom parameters for the campaign.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

DSAAutoTargetPerformanceReport

Use this report to find out which DSA auto targets are performing well and those that are not.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign.
CampaignStatus String The campaign status.
DynamicAdTarget String True The dynamic ad target or webpage condition that Bing matched to your website. For example the condition could be returned in the report as URL contains xyz.
DynamicAdTargetStatus String The current status of the dynamic ad target.
DynamicAdTargetId Long The Bing Ads assigned identifier of the dynamic ad target, also known in Campaign Management and Bulk API as the ad group criterion ID.
AdGroupId Long The Bing Ads assigned identifier of an account.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String The operating system of the device reported in the DeviceType column.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AdGroupName String The ad group name.
AdGroupStatus String The ad group status.
Language String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidStrategyType String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
TrackingTemplate String The current tracking template of the ad.
CustomParameters String The current custom parameters of the ad.
WebsiteCoverage String A score from 0.0 to 1.0 that indicates the percentage of pages in the requested language that belong to a particular domain out of all the pages that Bing has indexed for the same language your website's domain.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

DSACategoryPerformanceReport

Use this report to find out which DSA categories are performing well and those that are not.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdId Long The Bing Ads assigned identifier of an ad.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String The operating system of the device reported in the DeviceType column.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
CampaignStatus String The campaign status.
AdGroupName String The ad group name.
Language String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
Category0 String True The top level category that Bing matched to your website. For example if the category is US/CA/SFO, the Category0 value will be US.
Category1 String True The mid level category that Bing matched to your website. For example if the category is US/CA/SFO, the Category0 value will be US.
Category2 String True The low level category that Bing matched to your website. For example if the category is US/CA/SFO, the Category0 value will be US.
CampaignName String The campaign name.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion.
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

DSASearchQueryPerformanceReport

Use this report to find out which search terms are in demand for your DSA campaign and the performance of dynamic headlines that are being displayed.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdId Long The Bing Ads assigned identifier of an ad.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String The operating system of the device reported in the DeviceType column.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
CustomerId String The Bing Ads assigned identifier of a customer.
CustomerName String The customer name.
CampaignStatus String The campaign status.
AdGroupName String The ad group name.
Language String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
CampaignName String The campaign name.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
SearchQuery String True The search term used by your potential audience.
Headline String The Dynamic Search Ad headline that was dynamically generated by Bing Ads.
CategoryList String The list of categories that Bing matched to your website. Up to three category levels can be returned per category list item.
LandingPageTitle String The title of your webpage where the search user landed.
FeedUrl String The feed URL will appear either as
FinalUrl String The URL address of the page on your website that people reach when they click your ad from a desktop or laptop.
DynamicAdTarget String The dynamic ad target or webpage condition that Bing matched to your website. For example the condition could be returned in the report as URL contains xyz.
DynamicAdTargetId String The Bing Ads assigned identifier of the dynamic ad target, also known in Campaign Management and Bulk API as the ad group criterion ID.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion.
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

GeographicPerformanceReport

Use this report to see which locations your traffic is coming from. You can then validate whether your location targeting strategy is successful, and identify opportunities to improve. The report also identifies either the physical location of the search user or the geographical location interest based on the user's search query.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdGroupName String The ad group name.
CampaignName String The campaign name.
Language String The ad group language.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
Country String The country where the user was physically located when they clicked the ad.
State String The state where the user was physically located when they clicked the ad.
MetroArea String The metro area where the user was physically located when they clicked the ad.
City String The city where the user was physically located when they clicked the ad.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
ProximityTargetLocation String The radius target bid name. The name of the geographic radius where the user was physically located when they clicked the ad.
Radius String The radius of a radius target bid. The geographic radius where the user was physically located when they clicked the ad.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
LocationType String The location type used to deliver ads. For example to distinguish between people in versus searching for or viewing pages about the corresponding location of interest.
MostSpecificLocation String The most specific location used to deliver ads. For example if the city and country are both identified, this column will include the same value as the City column. If postal code information is available, then it will be included in the report instead of city or country.
County String The county where the user was physically located when they clicked the ad.
DeviceOS String The operating system of the device reported in the DeviceType column.
LocationId Long The Bing Ads identifier of the location where the user was physically located when they clicked the ad. For geographical location identifiers, see Geographical Location Codes.
PostalCode String The postal code where the user was physically located when they clicked the ad.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

GoalsAndFunnelsReport

Use this report to discover whether your audience completes each step through the land, browse, prospect, and conversion pages of your website. For example, you can use this report to determine the step that users leave the conversion funnel, so that you can improve or remove that step to increase the chance that the user will continue to the next step.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdGroupName String The ad group name.
CampaignName String The campaign name.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
Keyword String The keyword text.
KeywordStatus String The keyword status.
KeywordId String The Bing Ads assigned identifier of a keyword.
DeviceOS String The operating system of the device reported in the DeviceType column.
Goal String True The name of your event tracking or campaign analytics goal.
GoalId String The Bing Ads assigned identifier of a goal.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
AllConversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
AllRevenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

KeywordEstimatedBid

Query the available Keyword Estimated Bid in Bing Ads.

Table Specific Information

Select

You must set the KeywordText and MatchType columns in the WHERE clause to query this table. Set the MatchType column to one of the following values in the WHERE clause: Exact, Phrase, Broad, Content, or Aggregate.

The Cloud will use the Microsoft Ads API to filter the results by KeywordText and MatchType while the rest of the filter is executed client side within the Cloud.

For example, the following query is processed server-side.

SELECT * FROM KeywordEstimatedBid WHERE KeywordText = 'SAP R/3 Developers' AND MatchType = 'Exact'

Filtering by accountid

You can filter by accountid using the IN condition. For example,

SELECT * FROM KeywordEstimatedBid 
WHERE KeywordText IN ('Text', 'Gmail') 
AND MatchType = 'Exact' 
AND AccountId IN ('141163452', '2562405', '141163453', '141163454', '141163455', '141163456', '141163457')

Columns

Name Type Select requirement Metric Aggregate Description
KeywordText String The keyword text.
MatchType String The keyword match type used to determine the estimates. Can be one of Exact, Phrase, Broad, Aggregate.
CurrencyCode String The monetary unit of the cost values, such as AverageCPC.
CampaignId Long The system generated identifier of the campaign.
AdGroupId Long The system generated identifier of the ad group.
MinClicksPerWeek Double The estimated minimum number of clicks per week.
MaxClicksPerWeek Double The estimated maximum number of clicks per week.
AverageCPC Double The estimated average CPC.
MinImpressionsPerWeek Long The estimated minimum number of impressions per week.
MaxImpressionsPerWeek Long The estimated maximum number of impressions per week.
ClickThroughRate Double The estimated CTR.
MinTotalCostPerWeek Double The estimated minimum cost per week.
MaxTotalCostPerWeek Double The estimated maximum cost per week.
EstimatedMinBid Double The position in the search results given the specified bid.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

KeywordEstimatedPosition

Query the available EstimatedPosition in Bing Ads.

Table Specific Information

Select

You must specify the Keywords and MatchType columns in the WHERE clause to query this table. Set MatchType to one of the following values: Exact, Phrase, Broad, Content and Aggregate. You can search on multiple keywords by setting the Keywords column value to a comma-separated list in the WHERE clause.

The Cloud will use the Microsoft Ads API to filter the results by KeywordText and MatchType while the rest of the filter is executed client side within the Cloud. For example, the following query is processed server-side.

SELECT * FROM KeywordEstimatedPosition WHERE Keywords = 'SAP development,PowerShell Excel' AND MatchType = 'Exact'
SELECT * FROM KeywordEstimatedPosition WHERE Keywords = 'ssh transfer' AND MatchType = 'Exact' AND AccountId = '135093022' AND MaxBid = 50

Filtering by accountid

You can filter by accountid using the IN condition. For example,

SELECT * FROM KeywordEstimatedBid 
WHERE KeywordText IN ('Text', 'Gmail') 
AND MatchType = 'Exact' 
AND AccountId IN ('141163452', '2562405', '141163453', '141163454', '141163455', '141163456', '141163457')

Columns

Name Type Select requirement Metric Aggregate Description
Keywords String List of Keywords. Use to filter the table.
MaxBid Long The maximum bid value to use to determine the estimated position in the search results.
MatchType String The keyword match type used to determine the estimates. Can be one of Exact, Phrase, Broad, Aggregate.
CurrencyCode String The monetary unit of the cost values, such as AverageCPC.
CampaignId Long The system generated identifier of the campaign.
AdGroupId Long The system generated identifier of the ad group.
Keyword String The keyword.
MinClicksPerWeek Double The estimated minimum number of clicks per week.
MaxClicksPerWeek Double The estimated maximum number of clicks per week.
AverageCPC Double The estimated average CPC.
MinImpressionsPerWeek Long The estimated minimum number of impressions per week.
MaxImpressionsPerWeek Long The estimated maximum number of impressions per week.
ClickThroughRate Double The estimated CTR.
MinTotalCostPerWeek Double The estimated minimum cost per week.
MaxTotalCostPerWeek Double The estimated maximum cost per week.
EstimatedAdPosition Double The position in the search results given the specified bid.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

KeywordHistoricalSearch

Query the available Keyword Historical Search in Bing Ads.

Table Specific Information

Select

You must specify the Keywords, Language, StartDate, and EndDate columns to query this table. You can search on multiple keywords by setting the Keywords column value to a comma-separated list in the WHERE clause.

The Cloud will use the Microsoft Ads API to filter the results by Keywords, Language, StartDate, and EndDate while the rest of the filter is executed client side within the Cloud. For example,

SELECT * FROM KeywordHistoricalSearch WHERE Keywords = 'SAP development' AND Language = 'English' AND StartDate = '2014-01-01' AND EndDate = '2017-01-01'

Filtering by accountid

You can filter by accountid using the IN condition. For example,

SELECT * FROM KeywordEstimatedBid 
WHERE KeywordText IN ('Text', 'Gmail') 
AND MatchType = 'Exact' 
AND AccountId IN ('141163452', '2562405', '141163453', '141163454', '141163455', '141163456', '141163457')

Columns

Name Type Select requirement Metric Aggregate Description
Keywords String List of Keywords. Use to filter the table.
Language String The language in which the keywords are written.
StartDate Date The start date of the date range that identifies the data that you want to use to determine the historical search count.
EndDate Date The end date of the date range that identifies the data that you want to use to determine the historical search count.
Keyword String The keyword.
SearchCount Long The number of times that the keyword was used in a search query on the specified device type during the time period. The count aggregates data from all specified countries.
SearchDate Date The time period in which the count was captured.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

KeywordPerformance

Query the available Keyword Performance in Bing Ads.

Table Specific Information

Select

You must specify the Keywords, Language, and PublisherCountry columns in the WHERE clause to query this table. If not set, MatchType will match all possible values: Exact, Phrase, Broad, Content, Aggregate.

The Cloud will use the Microsoft Ads API to filter the results by Keywords, MatchType, Language, and PublisherCountry while the rest of the filter is executed client side within the Cloud. For example, the preceding query is processed on the server.

SELECT * FROM KeywordPerformance WHERE Keywords = 'SAP development,PowerShell Excel' AND Language = 'English' AND PublisherCountry = 'US' AND MatchType = 'Exact'

Filtering by accountid

You can filter by accountid using the IN condition. For example,

SELECT * FROM KeywordEstimatedBid 
WHERE KeywordText IN ('Text', 'Gmail') 
AND MatchType = 'Exact' 
AND AccountId IN ('141163452', '2562405', '141163453', '141163454', '141163455', '141163456', '141163457')

Columns

Name Type Select requirement Metric Aggregate Description
Keywords String List of Keywords. Use to filter the table.
AdPosition String The position in the search results in which the ad appeared.
MatchType String The match type that you specified in the request.

使用できる値は次のとおりです。Exact, Aggregate, Broad, Phrase

Language String The language in which the keywords are written.
PublisherCountry String The country code of the country/region to use as the source of the demographics data. The country/region that you specify must support the language specified in the Language element.
Device String The device of the user who entered the search query. Default value is 'Computers'.

使用できる値は次のとおりです。Computers, NonSmartphones, Smartphones, Tablets

Keyword String The keyword.
Clicks Int The number of clicks that the keyword and match type generated during the specified time interval.
Impressions Long The number of impressions that the keyword and match type generated during the specified time interval.
AverageCPC Double The average cost per click (CPC). The average CPC is calculated by dividing the cost of all clicks by the number of clicks.
ClickThroughRate Double The click-through rate (CTR) as a percentage. The CTR is calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100.
TotalCost Double The cost of using the specified keyword and match type during the specified time interval.
AverageBid Double The average bid of the keyword.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

KeywordPerformanceReport

Use this report to find out which keywords are performing well and those that are not.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
Keyword String The keyword text.
KeywordId Long The Bing Ads assigned identifier of a keyword.
KeywordLabels String The labels applied to the keyword.
AdId Long Ad Id
AdType String The ad type.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
CurrentMaxCpc String The maximum cost per click bid that was in effect at the time the report was generated. It is not a moving historical bid throughout the report time period.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
FinalUrl String The Final URL of the ad, keyword, or criterion.
FinalMobileUrl String The Final Mobile URL of the ad, keyword, or criterion.
FinalAppUrl String Reserved for future use.
FirstPageBid Decimal Based on your campaign performance and marketplace dynamics, this estimate is the bid amount that Bing Ads calculates for your ad to be placed on the first page in the search results.
Mainline1Bid Decimal Based on your campaign performance and marketplace dynamics, this estimate is the bid amount that Bing Ads calculates will place your ad at the top of search results.
MainlineBid Decimal Based on your campaign performance and marketplace dynamics, this estimate is the bid amount that Bing Ads calculates for your ad to be placed on the first page in the search results.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
BidStrategyType String The bid strategy type. Possible values include EnhancedCpc, ManualCpc, MaxClicks, MaxConversions, and TargetCpa. If the InheritFromParent strategy type is used, the report will include the inherited bid strategy type e.g., one of the supported values listed above.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
CampaignStatus String The campaign status.
TrackingTemplate String The current tracking template for the ad group.
CustomParameters String The current set of custom parameters for the campaign.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
KeywordStatus String The keyword status.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
QualityScore Int True The numeric score shows you how competitive your ads are in the marketplace by measuring how relevant your keywords and landing pages are to customers' search terms. If available, the quality score can range from a low of 1 to a high of 10.
ExpectedCtr Int True How well your keyword competes against other keywords targeting the same traffic. A score of 3 is Above Average; a score of 2 is Average; and a score of 1 is considered Below Average.
AdRelevance Int True How closely related your ads is to the search query or other input. It tells you how relevant your ad and landing page are to potential customers. A score of 3 is Above Average; a score of 2 is Average; and a score of 1 is considered Below Average.
LandingPageExperience Int True An aggregate quality assessment of all landing pages on your site. The landing page experience score measures whether your landing page is likely to provide a good experience to customers who click your ad and land on your website. A score of 3 is Above Average; a score of 2 is Average; and a score of 1 is considered Below Average.
QualityImpact Double True The numeric score that indicates the possible increase in the number of impressions that the keyword could receive if the corresponding QualityScore column would rise above underperforming: 0 (not available), 1 (low impact), 2 (medium impact), or 3 (high impact).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

Keywords

Query the available Keywords in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM Keywords
SELECT * FROM Keywords WHERE AdGroupId = '5179946000'
SELECT * FROM Keywords WHERE AdGroupId = '1311717627185807' AND AccountId = '135096904'

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The system-generated identifier of the keyword.
AdGroupId Long The system generated identifier of the ad group.
Text String The keyword text. The text can contain a maximum of 100 characters. You should specify the keyword in the locale of the Language value that you specified for the ad group to which the keyword belongs.
Status String The keyword's status. By default, the status is set to Active.
BidAmount Double The bid to use when the user's search term and the keyword match.
DestinationUrl String The URL of the webpage to take the user to when they click the ad. The keyword's destination URL is used if specified; otherwise, the ad's destination URL is used.
BiddingSchemeType String The bid strategy type for how you want to manage your bids.
MatchType String The type of match to compare the keyword and the user's search term.
TrackingUrlTemplate String The tracking template to use as a default for all FinalUrls and FinalMobileUrls.
UrlCustomParameters String Your custom collection of key and value parameters for URL tracking.
ForwardCompatibilityMap String The list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.
FinalUrls String The landing page URL. The keyword's final URL is used if specified; otherwise, the ad's final URL is used.
FinalMobileUrls String The mobile landing page URL. The keyword's final mobile URL is used if specified; otherwise, the ad's final mobile URL is used.
FinalAppUrls String Reserved for future use.
EditorialStatus String The editorial review status of the keyword, which indicates whether the keyword is pending review, has been approved, or has been disapproved.
Param1 String The string to use as the substitution value in an ad if the ad's title, text, display URL, or destination URL contains the {Param1} dynamic substitution string
Param2 String The string to use as the substitution value in an ad if the ad's title, text, display URL, or destination URL contains the {Param2} dynamic substitution string
Param3 String The string to use as the substitution value in an ad if the ad's title, text, display URL, or destination URL contains the {Param3} dynamic substitution string
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

NegativeKeywordConflictReport

Use this report to discover which keywords and negative keywords are in conflict, and whether the conflict is at the campaign or ad group level. Use this list to figure out which negative keywords to delete.

Columns

Name Type Select requirement Metric Aggregate Description
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountStatus String The account status.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdGroupName String The ad group name.
AdGroupStatus String The ad group status.
CampaignId Long The Bing Ads assigned identifier of a campaign.
CampaignName String The campaign name.
CampaignStatus String The campaign status.
Keyword String True The keyword text.
KeywordId Long The Bing Ads assigned identifier of a keyword.
KeywordStatus String The keyword status.
NegativeKeyword String True The negative keyword text.
ConflictLevel String The entity level where the keyword and negative keyword conflict occurs. The possible values are AdGroup and Campaign.
ConflictType String The type of negative keyword conflict encountered.The possible values are Possibly intentional conflict and True conflict.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies.
NegativeKeywordListId Long The Bing Ads assigned identifier of a negative keyword list.
NegativeKeywordList String The name of the negative keyword list.
NegativeKeywordId Long The Bing Ads assigned identifier of a negative keyword.
NegativeKeywordMatchType String The type of match to compare the negative keyword and the user's search term. The possible values for a negative keyword are Exact and Phrase.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

ProductDimensionPerformanceReport

Use this report to find out which product dimensions are performing well and those that are not.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AdGroupName String The ad group name.
AdGroupId String The Bing Ads assigned identifier of an ad group.
AdId String The Bing Ads assigned identifier of an ad.
CampaignName String The campaign name.
CurrencyCode String The account currency type.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
MerchantProductId String True The report will include a column that contains the unique identifier provided by a merchant for each product offer.
Title String The product item name. For example the title of a book, DVD, or game.
Condition String The condition of a product item.
Brand String The product item's manufacturer, brand, or publisher.
CustomLabel0 String The value of the Custom_label_0 field in your Bing Merchant Center catalog.
CustomLabel1 String The value of the Custom_label_1 field in your Bing Merchant Center catalog.
CustomLabel2 String The value of the Custom_label_2 field in your Bing Merchant Center catalog.
CustomLabel3 String The value of the Custom_label_3 field in your Bing Merchant Center catalog.
CustomLabel4 String The value of the Custom_label_4 field in your Bing Merchant Center catalog.
ProductType1 String The first level value of the Product_type field in your Bing Merchant Center catalog.
ProductType2 String The second level value of the Product_type field in your Bing Merchant Center catalog.
ProductType3 String The third level value of the Product_type field in your Bing Merchant Center catalog.
ProductType4 String The fourth level value of the Product_type field in your Bing Merchant Center catalog.
ProductType5 String The fifth level value of the Product_type field in your Bing Merchant Center catalog.
ProductCategory1 String The first level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory2 String The second level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory3 String The third level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory4 String The fourth level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory5 String The fifth level value of the Product_category field in your Bing Merchant Center catalog.
AccountStatus String The account status.
AssistedClicks String Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for.
AssistedImpressions String The number of times an ad that is being co-bid by your manufacturer partners has been displayed on search results pages or other sites on the Bing Network.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
CampaignId String The Bing Ads assigned identifier of a campaign.
Network String The current network setting of an ad group.
Price String The different price for products in your catalog.
SellerName String The report will include a column that contains the merchant or store name that offers the product.
OfferLanguage String The report will include a column that contains the language for the product offer.
CountryOfSale String The report will include a column that contains the country of sale for the product catalog.
AdStatus String The ad status.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AdDistribution String The ad distribution attribute of an ad group.
ClickTypeId Long The click type ID.
StoreId Long The unique identifier for the Bing Merchant Center store.
BidStrategyType String The bid strategy type. Possible values include EnhancedCpc and ManualCpc. If the InheritFromParent strategy type is used, the report will include the inherited bid strategy type e.g. one of the supported values listed above.
ClickType String Click type refers to each component of an ad that a customer can click.
LocalStoreCode String An alphanumeric identifier defined by the merchant to uniquely identify each local store.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
AbsoluteTopImpressionSharePercent Double True The number of times your ad is shown in the top position as a percentage of the total available impressions in the market you were targeting.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
ClickSharePercent Double True The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured.
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
Conversions Int True The cost per click (CPC) summed for each click.
ConversionRate Double True The cost per click (CPC) summed for each click.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
ImpressionSharePercent Double True The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
BenchmarkBid Double True Shows you how much other advertisers are bidding on average on similar products as your current target.
BenchmarkCtr Double True Shows you how other product ads for similar products are performing on average based on how often people who see the ad end up clicking on it.
TotalClicksOnAdElements Int True The number of clicks when this ad element was present in the ad copy, whether this or another ad element was clicked on.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

ProductNegativeKeywordConflictReport

Use this report to discover which keywords and negative keywords are in conflict, and whether the conflict is at the campaign or ad group level. Use this list to figure out which negative keywords to delete.

Columns

Name Type Select requirement Metric Aggregate Description
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AccountStatus String The account status.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign.
CampaignStatus String The campaign status.
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdGroupStatus String The ad group status.
ConflictLevel String The entity level where the keyword and negative keyword conflict occurs. The possible values are AdGroup and Campaign.
NegativeKeywordListId Long The Bing Ads assigned identifier of a negative keyword list.
NegativeKeyword String True The negative keyword text.
NegativeKeywordId Long The Bing Ads assigned identifier of a negative keyword.
NegativeKeywordMatchType String The type of match to compare the negative keyword and the user's search term. The possible values for a negative keyword are Exact and Phrase.
Title String The type of match to compare the negative keyword and the user's search term. The possible values for a negative keyword are Exact and Phrase.
MerchantProductId String True The report will include a column that contains the unique identifier provided by a merchant for each product offer.
AdGroupCriterionId Long The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign.
ProductGroup String True The forward slash ('/') delimited list of product conditions, reported as Operand=

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

ProductPartitionPerformanceReport

You can include details in the report such as impressions, clicks, and spend that you can use to identify whether or not the product partitions are performing well.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdId Long The Bing Ads assigned identifier of an ad.
AssistedClicks String Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for.
AssistedImpressions String The number of times an ad that is being co-bid by your manufacturer partners has been displayed on search results pages or other sites on the Bing Network.
CampaignName String The campaign name.
CurrencyCode String The account currency type.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
CampaignId Long The Bing Ads assigned identifier of a campaign.
Network String The current network setting of an ad group.
OfferLanguage String The report will include a column that contains the language for the product offer.
CountryOfSale String The report will include a column that contains the country of sale for the product catalog.
AdStatus String The ad status.
PartitionType String True The product partition type.
ProductGroup String True The forward slash ('/') delimited list of product conditions, reported as Operand=
AdGroupCriterionId Long The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign.
CurrentMaxCpc String The maximum cost per click bid that was in effect at the time the report was generated. It is not a moving historical bid throughout the report time period.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
TrackingTemplate String The current tracking template of the criterion.
CustomParameters String The current custom parameter set of the criterion.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AdDistribution String The ad distribution attribute of an ad group.
ClickType String Click type refers to each component of an ad that a customer can click.
BidStrategyType String The bid strategy type. Possible values include EnhancedCpc and ManualCpc. If the InheritFromParent strategy type is used, the report will include the inherited bid strategy type e.g. one of the supported values listed above.
LocalStoreCode String An alphanumeric identifier defined by the merchant to uniquely identify each local store.
ClickTypeId Long The click type ID.
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
AbsoluteTopImpressionSharePercent Double True The number of times your ad is shown in the top position as a percentage of the total available impressions in the market you were targeting.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
ClickSharePercent Double True The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured.
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
Conversions Int True The cost per click (CPC) summed for each click.
ConversionRate Double True The cost per click (CPC) summed for each click.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
ImpressionSharePercent Double True The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
BenchmarkBid Double True Shows you how much other advertisers are bidding on average on similar products as your current target.
BenchmarkCtr Double True Shows you how other product ads for similar products are performing on average based on how often people who see the ad end up clicking on it.
TotalClicksOnAdElements Int True The number of clicks when this ad element was present in the ad copy, whether this or another ad element was clicked on.
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double True The revenue per assist.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

ProductPartitionUnitPerformanceReport

Use this report to find out which product partition units are performing well and those that are not.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdId Long The Bing Ads assigned identifier of an ad.
CampaignName String The campaign name.
CurrencyCode String The account currency type.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
AccountStatus String The account status.
AssistedClicks String Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for.
AssistedImpressions String The number of times an ad that is being co-bid by your manufacturer partners has been displayed on search results pages or other sites on the Bing Network.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
CampaignId Long The Bing Ads assigned identifier of a campaign.
Network String The current network setting of an ad group.
AdStatus String The ad status.
ProductGroup String True The forward slash ('/') delimited list of product conditions, reported as Operand=
AdGroupCriterionId Long True The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign.
CurrentMaxCpc String The maximum cost per click bid that was in effect at the time the report was generated. It is not a moving historical bid throughout the report time period.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
TrackingTemplate String The current tracking template of the criterion.
CustomParameters String The current custom parameter set of the criterion.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidStrategyType String The bid strategy type. Possible values include EnhancedCpc and ManualCpc. If the InheritFromParent strategy type is used, the report will include the inherited bid strategy type e.g. one of the supported values listed above.
LocalStoreCode String An alphanumeric identifier defined by the merchant to uniquely identify each local store.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
Conversions Int True The cost per click (CPC) summed for each click.
ConversionRate Double True The cost per click (CPC) summed for each click.
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double True The revenue per assist.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

ProductSearchQueryPerformanceReport

Use this report to get insight into what your audience is searching for when your ads are shown as well as ensure that your product titles are relevant to search queries.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String True The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AccountNumber String The Bing Ads assigned number of an account.
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdId Long The Bing Ads assigned identifier of an ad.
AccountId Long The Bing Ads assigned identifier of an ad.
AssistedClicks String Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for.
AssistedImpressions String The number of times an ad that is being co-bid by your manufacturer partners has been displayed on search results pages or other sites on the Bing Network.
CampaignName String True The campaign name.
CustomerId String The Bing Ads assigned identifier of a customer.
CustomerName String The customer name.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
CampaignId Long True The Bing Ads assigned identifier of a campaign.
Network String The current network setting of an ad group.
PartitionType String The product partition type.
ProductGroup String The forward slash ('/') delimited list of product conditions, reported as Operand=
AdGroupCriterionId Long The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
ClickType String Click type refers to each component of an ad that a customer can click.
ClickTypeId Long The click type ID.
MerchantProductId Long True The click type ID.
SearchQuery String True The click type ID.
Title String The click type ID.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
Conversions Int True The cost per click (CPC) summed for each click.
ConversionRate Double True The cost per click (CPC) summed for each click.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
TotalClicksOnAdElements Int True The number of clicks when this ad element was present in the ad copy, whether this or another ad element was clicked on.
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double True The revenue per assist.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

PublisherUsagePerformanceReport

Use this report to see if any website URLs aren't performing well enough for your campaign or ad group target settings. For example, if ad impressions at those URLs yield a low click-through rate, then you might decide to exclude those websites from your campaign.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String True The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
CampaignStatus String The campaign status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
PublisherUrl String True The URL of the website that displayed the ad.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

SearchCampaignChangeHistoryReport

Use this report to discover when changes to an account were made, as well as which user made the changes.

Columns

Name Type Select requirement Metric Aggregate Description
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdGroupName String The ad group name.
CampaignName String The campaign name.
EntityId String The Bing Ads system identifier of the entity that was updated.
EntityName String The name of the entity that was updated.
DateTime String True The campaign name.
AdTitle String The ad title.
AdDescription String The campaign name.
DisplayUrl String The campaign name.
Keyword String The campaign name.
ItemChanged String The campaign name.
AttributeChanged String The campaign name.
ChangedBy String The username of the user that made the change to settings within the account. If the system made the change, the value will be Administrator.
HowChanged String The campaign name.
OldValue String The campaign name.
NewValue String The campaign name.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

SearchQueryPerformanceReport

Use this report to see what your audience is searching for when your ads are shown. You can use this information to make informed additions, removals, or edits to both your keyword and negative keyword lists.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdId Long Ad Id
AdType String The ad type.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
AdGroupCriterionId Long The Bing Ads assigned identifier of an ad group criterion.
AdStatus String The ad status.
CampaignStatus String The campaign status.
CampaignType String The type of campaign. Possible values include Search, Shopping, and Dynamic search.
CustomerId String The Bing Ads assigned identifier of a customer.
CustomerName String The customer name.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
SearchQuery String True The search term used by your potential audience.
Keyword String The keyword text.
KeywordId Long The Bing Ads assigned identifier of a keyword.
KeywordStatus String The keyword status.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

SeasonalityAdjustments

Query the available Seasonality Adjustments in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM SeasonalityAdjustments
SELECT * FROM SeasonalityAdjustments WHERE AccountId = '2562405'
SELECT * FROM SeasonalityAdjustments WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The seasonality adjustment ID.
Name String The name of the seasonality adjustment.
Description String A description for the seasonality adjustment.
AdjustmentPercentage Double The percentage of the conversion rate adjustment.
CampaignAssociations String Make the seasonality adjustment to these campaigns.
CampaignTypeFilter String Make the seasonality adjustment to these campaign types.
DeviceTypeFilter String Make the seasonality adjustment to these device types.
StartDate Datetime The start date.
EndDate Datetime The end date.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

ShareOfVoiceReport

Use this report to view impression share (%) of successful bids for each keyword, and identify opportunities to increase impression share.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
CampaignStatus String The campaign status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
Network String The current network setting of an ad group.
BidStrategyType String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
KeywordId String True The Bing Ads assigned identifier of a keyword.
Keyword String The keyword text.
KeywordStatus String The keyword status.
KeywordLabels String The labels applied to the keyword.
AdRelevance String How closely related your ads is to the customer's search query or other input. It tells you how relevant your ad and landing page are to potential customers.
LandingPageExperience String An aggregate quality assessment of all landing pages on your site. The landing page experience score measures whether your landing page is likely to provide a good experience to customers who click your ad and land on your website.
ExpectedCtr String How well your keyword competes against other keywords targeting the same traffic. Ads that are relevant to searchers' queries or other input are more likely to have a higher click-through rate.
Impressions Int True True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
ExactMatchImpressionSharePercent Double True The estimated percentage of impressions that your account received for searches that exactly matched your keyword, out of the total available exact match impressions you were eligible to receive.
ImpressionSharePercent Double True True The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankAggPercent Double True The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
CurrentMaxCpc Double True The maximum cost per click bid that was in effect at the time the report was generated. It is not a moving historical bid throughout the report time period.
QualityScore Int True The numeric score shows you how competitive your ads are in the marketplace by measuring how relevant your keywords and landing pages are to customers' search terms.
ClickSharePercent Double True The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

Tags

Query the available Tags in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM Tags
SELECT * FROM Tags WHERE AccountId = '135096904'

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The unique Bing Ads identifier of the UET tag.
Name String The UET tag name.
Description String Text to help you identify the UET tag. We recommend that you set this to the related website page name or URL.
TrackingNoScript String If your website doesn't support JavaScript, you can use this Non-JavaScript representation of the UET tag. If you use Non-JavaScript, you can't track custom events or variable revenue.
TrackingScript String The tracking script that you can add to your website to allow Bing Ads to collect actions people take on your website.
TrackingStatus String The system-determined status values of a UET tag, for example the system sets the status to Unverified if the UET tag has not yet been verified.

使用できる値は次のとおりです。Unverified, Active, Inactive

CustomerShareAggregate String Contains information about CustomerAccountShares and OwnerCustomerId.
AccountId Long The Bing Ads assigned identifier of an account.

CData Cloud

UserLocationPerformanceReport

Use this report to see which locations your traffic is coming from. You can then validate whether your location targeting strategy is successful, and identify opportunities to improve. The report also identifies the physical location of the user and the intended geographical location of the user's search query, for example a user in Seattle searching for services in Portland.

Columns

Name Type Select requirement Metric Aggregate Description
Summary String True The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String True Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily Date True Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly Date True Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly Date True Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly Int True Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay Int True Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek Int True Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String True The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdGroupName String The ad group name.
CampaignName String The campaign name.
Language String The ad group language.
Country String The country where the user was physically located when they clicked the ad.
State String The state where the user was physically located when they clicked the ad.
MetroArea String The metro area where the user was physically located when they clicked the ad.
City String The city where the user was physically located when they clicked the ad.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
ProximityTargetLocation String The radius target bid name. The name of the geographic radius where the user was physically located when they clicked the ad.
Radius String The radius of a radius target bid. The geographic radius where the user was physically located when they clicked the ad.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
County String The county where the user was physically located when they clicked the ad.
DeviceOS String The operating system of the device reported in the DeviceType column.
LocationId Long The Bing Ads identifier of the location where the user was physically located when they clicked the ad. For geographical location identifiers, see Geographical Location Codes.
PostalCode String The postal code where the user was physically located when they clicked the ad.
QueryIntentCountry String The name of a country if the user's geographical intent can be determined. The country is set if the user's intent is related to a country, and not necessarily if they are physically located in the county.
QueryIntentState String The name of a state if the user's geographical intent can be determined. The state is set if the user's intent is a state or sub geography of the state, and not necessarily if they are physically located in the state.
QueryIntentCity String The name of a city if the user's geographical intent can be determined. The city is set if the user's intent is a city, and not necessarily if they are physically located in the city.
QueryIntentDMA String The postal code where the user was physically located when they clicked the ad.
QueryIntentCounty String The name of a county if the user's geographical intent can be determined. The county is set if the user's intent is related to a county, and not necessarily if they are physically located in the county.
QueryIntentPostalCode String The name of a postal code if the user's geographical intent can be determined. The postal code is set if the user's intent is a postal code, and not necessarily if they are physically located in the postal code.
QueryIntentLocationId String The location identifier if the user's geographical intent can be determined.
Goal String The goal name.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int True Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double True The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double True The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double True The cost per click (CPC) summed for each click.
AveragePosition Double True The average position of the ad on a webpage.
Assists Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Int True The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
CostPerConversion Double True The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
ConversionRate Double True The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
Revenue Double True The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double True The return on ad spend (ROAS).
CostPerAssist Double True The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double True The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double True The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

使用できる値は次のとおりです。Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Microsoft Ads の単純なSELECT 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMicrosoft Ads から関連するレスポンスデータを返します。

CData Cloud - Microsoft Ads ストアドプロシージャ

Name Description

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Microsoft Ads のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、AdGroups テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='AdGroups' 

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのMicrosoft Ads プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、AdGroups テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='AdGroups' 
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
DeveloperTokenDeveloperToken of the currently authenticated user.
CustomerIdCustomerId of the currently authenticated user.
UseSandboxA boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.

Connection


プロパティ説明
AccountIdThe id of the account that you want to get data for.

Azure Authentication


プロパティ説明
AzureTenantデータにアクセスするために使用されているMicrosoft Ads テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。
AzureEnvironment接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ReportScopesAllows you to narrow or broaden the scope of access when getting data from Reporting service views.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
DeveloperTokenDeveloperToken of the currently authenticated user.
CustomerIdCustomerId of the currently authenticated user.
UseSandboxA boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.
CData Cloud

DeveloperToken

DeveloperToken of the currently authenticated user.

データ型

string

デフォルト値

""

解説

DeveloperToken of the currently authenticated user.

Get a Developer Token

To use the Microsoft Ads APIs, you must have a DeveloperToken in addition to the CustomerId and AccountId. You must have the Super Admin role in Microsoft Ads to create a developer token, though you do not need special permissions to use the token. BBD37VB98 may be used for sandbox accounts.

  1. Log in at the Bing Ads Developer Portal as a Microsoft Account user with the Microsoft Ads Super Admin role.
  2. Click the Request Token button and take note of your developer token. You will set it in the DeveloperToken connection property.

CData Cloud

CustomerId

CustomerId of the currently authenticated user.

データ型

string

デフォルト値

""

解説

CustomerId of the currently authenticated user. In Microsoft Ads it is the Manager Account ID.

You can find this value in the Microsoft Ads Web application, under Settings -> Manager account settings -> Manager account ID.

CData Cloud

UseSandbox

A boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.

データ型

bool

デフォルト値

false

解説

If you are using a production account, this property can be left blank. If you are using a developer test account, set this to 'TRUE'.

CData Cloud

Connection

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。


プロパティ説明
AccountIdThe id of the account that you want to get data for.
CData Cloud

AccountId

The id of the account that you want to get data for.

データ型

string

デフォルト値

""

解説

If it is not specified the driver will use the first AccountId it finds from querying the API.

You can find a value either by querying the Accounts table or by going to the Microsoft Ads Web application, under Settings -> Account settings -> Account ID.

CData Cloud

Azure Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。


プロパティ説明
AzureTenantデータにアクセスするために使用されているMicrosoft Ads テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。
AzureEnvironment接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。
CData Cloud

AzureTenant

データにアクセスするために使用されているMicrosoft Ads テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。

データ型

string

デフォルト値

"common"

解説

テナントとは、Microsoft Entra ID(旧称:Azure AD)を通じて管理される、組織のユーザーやリソースのためのデジタルコンテナです。 各テナントには一意のディレクトリID が関連付けられており、多くの場合、カスタムドメイン(例:microsoft.com やcontoso.onmicrosoft.com)も関連付けられています。

Microsoft Entra 管理センターでディレクトリ(テナント)ID を確認するには、Microsoft Entra ID -> プロパティに移動し、「ディレクトリ(テナント)ID」と表示されている値をコピーします。

このプロパティは以下の場合に必要です。

  • AuthScheme がAzureServicePrincipal またはAzureServicePrincipalCert に設定されている場合
  • AuthScheme がAzureAD で、ユーザーアカウントが複数のテナントに属している場合

テナントの値は、2つの形式のいずれかで指定できます。

  • ドメイン名(例:contoso.onmicrosoft.com)
  • GUID 形式のディレクトリ(テナント)ID(例:c9d7b8e4-1234-4f90-bc1a-2a28e0f9e9e0)

テナントを明示的に指定することで、認証リクエストが正しいディレクトリにルーティングされるようになります。これは、ユーザーが複数のテナントに所属している場合や、サービスプリンシパルベースの認証を使用する場合に特に重要です。

この値が必要な場面で省略されると、認証に失敗したり、誤ったテナントに接続されたりする可能性があります。その結果、認可されていないまたはリソースが見つからないといったエラーが発生する可能性があります。

CData Cloud

AzureEnvironment

接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

データ型

string

デフォルト値

"GLOBAL"

解説

Azure アカウントがGlobal ネットワークとは異なるネットワーク(China、USGOVT、USGOVTDOD など)の一部である場合は、必要です。

CData Cloud

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

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:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ReportScopesAllows you to narrow or broaden the scope of access when getting data from Reporting service views.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

ReportScopes

Allows you to narrow or broaden the scope of access when getting data from Reporting service views.

データ型

string

デフォルト値

""

解説

For example, the AccountPerformanceReport, CampaignPerformanceReport, AdGroupPerformanceReport, and other views with Report in the name are part of the Report Service.

You can specify the scope so that you include specific Accounts, Campaigns or AdGroups.

  • Accounts should be specified in this format: AccountId, AccountId, AccountId;
  • Campaigns should be specified in this comma-separated format: CampaignId:AccountId, CampaignId:AccountId;
  • AdGroups should be specified in this format (again, comma-separated): AdGroupId:CampaignId:AccountId, AdGroupId:CampaignId:AccountId, AdGroupId:CampaignId:AccountId;

Here are a few examples:

  • ReportScopes='Accounts=1494730,969378; Campaigns=234401540:18503857,1730399:96740690; AdGroups=1958:9607:1655,0973:192782:1655;';
  • ReportScopes='AdGroups=1958:9607:1655, 0973:192782:1655;';
  • ReportScopes='Campaigns=234401540:18503857, 1730399:96740690;';
  • ReportScopes='Accounts=1494730,969378;';

By default this connection property will be empty. In that case the driver uses the first AccountId that it finds from querying the API.

You can specify up to 1000 Accounts, 300 Campaigns and 300 AdGroups.

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

Third Party Copyrights

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.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434