CData Python Connector for Microsoft Ads

Build 23.0.8839

Keywords

Query the available Keywords in Bing Ads.

Table Specific Information

Select

You must specify the AdGroupId column in the WHERE clause to query this table. The connector uses the Microsoft Ads API to filter the results by AdGroupId while the rest of the filter is executed client side within the connector.

For example, the following query is processed on the server.

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

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false, in which case any search criteria that refers to columns other than AdGroupId in the WHERE clause causes an error.

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.

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