CData Python Connector for Microsoft Ads

Build 24.0.9060

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 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 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 Integer True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
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).
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 Integer 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 Integer 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 Integer 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

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

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.

The allowed values are 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.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060