Ad Insight Data Objects
The Ad Insight service defines the following data objects.
Data Object | Description |
---|---|
AdApiError | Defines an Ad Insight Ad API error object that contains the details that explain why the service operation failed. |
AdApiFaultDetail | Defines an Ad Insight Ad API fault detail object that operations return when generic errors occur, such as an authentication error. |
AdGroupBidLandscape | Defines an object that contains a list of estimated clicks, cost, and impressions from 1 to 7 days for the ad group identifier given the suggested bid. |
AdGroupBidLandscapeInput | Defines an object that contains the requested bid landscape type for the corresponding ad group identifier. |
AdGroupEstimate | Contains a list of suggested keywords for the ad group with minimum and maximum traffic estimates. |
AdGroupEstimator | Contains a list of keyword estimators with your keyword level filter criteria for traffic estimates. |
ApiFaultDetail | Defines an Ad Insight API fault detail object that operations return when web service-specific errors occur, such as when the request message contains incomplete or invalid data. |
ApplicationFault | Defines the base object from which all Ad Insight fault detail objects derive. |
ApplyRecommendationEntity | Apply a recommendation. |
AuctionInsightEntry | Defines an auction insight entry for a domain. |
AuctionInsightKpi | Defines an auction insight key performance indicator. |
AuctionInsightResult | Defines the auction insight results from calling the GetAuctionInsightData operation. |
AuctionSegmentSearchParameter | Defines an auction segment search parameter. |
AutoApplyRecommendationsInfo | Defines the auto-apply opt-in status for specific recommendation type. |
BatchError | Defines an Ad Insight batch error object that identifies the item within the batch of items in the request message that caused the operation to fail, and describes the reason for the failure. |
BidLandscapePoint | Defines an object that contains estimates of clicks, cost, and impressions given the suggested bid. |
BidOpportunity | Defines an object that contains the suggested bid with estimated clicks and impressions opportunities. |
BroadMatchKeywordOpportunity | Defines an object that contains the marketplace impact statistics of including broad match type keyword bids. |
BroadMatchSearchQueryKPI | Defines an object that contains search query statistics of including broad match type keyword bids. |
BudgetOpportunity | Defines an object that contains the suggested budget with estimated clicks and impressions opportunities. |
BudgetPoint | Defines an object that contains a budget amount and an estimate of weekly impressions, clicks, and cost for this budget amount. |
CampaignBudgetRecommendation | Defines the CampaignBudgetRecommendation data object. |
CampaignEstimate | Contains a nested list of suggested keywords for the campaign's ad groups with minimum and maximum traffic estimates. |
CampaignEstimator | Contains campaign filter criteria and a nested list of ad group and keyword level filter criteria for traffic estimates. |
CategorySearchParameter | The keyword category search parameter that you can use as a seed for new keyword ideas. |
CompetitionSearchParameter | The competition search parameter filter that you can include when requesting keyword ideas. |
Criterion | This is the base class from which keyword planner criterion objects derive. |
DateRangeSearchParameter | The date range search parameter that you can include when requesting keyword ideas. |
DayMonthAndYear | Defines an object that you use to specify the start and end dates of a date range. |
DecimalRoundedResult | Defines a DecimalRoundedResult data object. |
DeviceCriterion | The device criterion that you can include when requesting keyword ideas or traffic estimates. |
DeviceSearchParameter | The device search parameter filter that you can include when requesting keyword ideas. |
DismissRecommendationEntity | Dismiss a recommendation. |
DomainCategory | Defines an object that contains a domain category with website coverage. |
EntityDetail | Defines an object that provides detail information for an entity for performance insights. |
EntityParameter | Defines an object that provides parameter information for an entity. |
EstimatedBidAndTraffic | Defines an object that contains estimates of clicks, average cost per click (CPC), impressions, click-through rate (CTR), and total cost for the corresponding keyword or ad group given the suggested bid. |
EstimatedPositionAndTraffic | Defines an object that contains the estimated search results position and estimated keyword statistics such as clicks, average cost per click (CPC), impressions, click-through rate (CTR), and total cost for the specified keyword given the specified bid. |
ExcludeAccountKeywordsSearchParameter | The exclude account keywords search parameter filter that you can include when requesting keyword ideas. |
Feed | Defines a Feed data object. |
HistoricalSearchCountPeriodic | Defines an object that contains the number of times that the keyword was used in a search query during the specified time period. |
IdeaTextSearchParameter | The idea text search parameter filter that you can include when requesting keyword ideas. |
ImpressionShareSearchParameter | The impression share search parameter filter that you can include when requesting keyword ideas. |
Keyword | Defines a keyword with match type. |
KeywordAndConfidence | Defines an object that contains a suggested keyword and a confidence score. |
KeywordAndMatchType | Defines an object that contains a keyword and corresponding match types. |
KeywordBidLandscape | Defines an object that contains a list of estimated clicks, cost, and impressions from 1 to 7 days for the keyword identifier given the suggested bid. |
KeywordCategory | Defines an object that contains a keyword category and a confidence score. |
KeywordCategoryResult | Defines an object that contains the keyword and a list of keyword categories that the keyword might belong to. |
KeywordDemographic | Defines an object that contains the device, age and gender of the user who entered the search query, if known. |
KeywordDemographicResult | Defines an object that contains the keyword and percentage of users by age and gender (if known) who searched for the specified keyword. |
KeywordEstimate | A suggested keyword with minimum and maximum traffic estimates. |
KeywordEstimatedBid | Defines an object that contains the keyword and the estimated bid value for each match type. |
KeywordEstimatedPosition | Defines an object that contains the keyword and the estimated position in the search results for each match type. |
KeywordEstimator | Contains a keyword estimators with your keyword level filter criteria for traffic estimates. |
KeywordHistoricalPerformance | Defines an object that contains the key performance index data for the specified keyword. |
KeywordIdea | Defines an object that contains a suggested keyword with historical statistics, like monthly search volume, competition, suggested minimum bid, and ad impression share. |
KeywordIdeaCategory | Defines an object that contains a keyword idea category. |
KeywordIdEstimatedBid | Defines an object that contains the identifier of the keyword and the suggested bid value for the keyword and match type. |
KeywordIdEstimatedPosition | Defines an object that contains the identifier of a keyword and the estimated search results position for the keyword and match type. |
KeywordKPI | Defines a key performance index object for a keyword. |
KeywordLocation | Defines an object that contains the location, network, device, and the percentage of time that a user entered a search query. |
KeywordLocationResult | Defines an object that contains the locations where users were located when they searched for the specified keyword. |
KeywordOpportunity | Defines an object that contains a suggested keyword and bid value. |
KeywordRecommendation | Defines a KeywordRecommendation data object. |
KeywordSearchCount | Defines an object that contains a list of search counts for each device and network where the keyword was included in a search query. |
KeywordSuggestion | Defines an object that contains a list of suggested keywords that may perform better than the specified keyword. |
LanguageCriterion | The language criterion that you can include when requesting keyword ideas or traffic estimates. |
LanguageSearchParameter | The language search parameter filter that you can include when requesting keyword ideas. |
LocationCriterion | The location criterion that you can include when requesting keyword ideas or traffic estimates. |
LocationSearchParameter | The location search parameter filter that you can include when requesting keyword ideas. |
NegativeKeyword | Defines a negative keyword with match type for traffic estimates. |
NetworkCriterion | The network criterion that you can include when requesting keyword ideas or traffic estimates. |
NetworkSearchParameter | The network search parameter filter that you can include when requesting keyword ideas. |
OperationError | Defines an Ad Insight operation error object that contains the details that explain why the service operation failed. |
Opportunity | This is the base class from which opportunity objects derive. |
PerformanceInsightsDetail | Defines the details for performance insights. |
PerformanceInsightsMessage | Defines the message for performance insights. |
PerformanceInsightsMessageParameter | Defines the message parameters for performance insights. |
QuerySearchParameter | The query search parameter that you can use as a seed for new keyword ideas. |
RadiusTarget | Defines a RadiusTarget data object. |
RangeResultOfDecimalRoundedResult | Defines a RangeResultOfDecimalRoundedResult data object. |
RangeResultOfdouble | Defines a RangeResultOfDouble data object. |
Recommendation | Defines the base object of Recommendation. |
RecommendationBase | Defines the RecommendationBase data object. |
RecommendationInfo | Defines the base object of RecommendationInfo. |
RemoveConflictingNegativeKeywordRecommendation | Reserved. |
ResponsiveSearchAdAssetRecommendation | Reserved. |
ResponsiveSearchAdRecommendation | Defines a ResponsiveSearchAdRecommendation data object. |
ResponsiveSearchAdsRecommendation | Defines an object that contains the responsive search ads to be suggested. |
RSARecommendationInfo | Defines an object that contains the info of responsive search ads recommendation. |
SearchCountsByAttributes | Defines an object that contains a list of keyword historical search counts for the corresponding device attribute. |
SearchParameter | This is the base class from which keyword idea search parameter objects derive. |
SearchVolumeSearchParameter | The search volume search parameter filter that you can include when requesting keyword ideas. |
SelectionOfAgeEnum | Defines a data object for the selection of age targeting. |
SelectionOfGenderEnum | Defines a data object for the selection of gender targeting. |
SelectionOflong | Defines a data object for the selection segment IDs. |
SuggestedBidSearchParameter | The suggested bid search parameter filter that you can include when requesting keyword ideas. |
SuggestedResponsiveSearchAd | Defines an object that describes the suggested responsive search ads. |
TextAssetSuggestions | Defines the text asset suggestions data object. |
TextParameter | Defines the text parameter for use with performance insights. |
TrafficEstimate | Defines an object that contains traffic estimates based on the campaign, ad group, and keyword criteria you specified when calling GetKeywordTrafficEstimates. |
UrlParameter | Defines the URL parameter for use with performance insights. |
UrlSearchParameter | The URL search parameter that you can use as a seed for new keyword ideas. |
UseBroadMatchKeywordRecommendation | Reserved. |