account | object or array of object or MicrosoftAdsAccountItem or string or integer | Yes | - | Microsoft Ads account to estimate bids for. |
keyword_ids | string or array of string | No | - | Existing keyword IDs as an array, JSON array, or comma/newline-separated text. Supply either keyword_ids or keywords, not both. Microsoft accepts up to 1000 per request and uses the keywords’ existing ad-group context. |
keywords | string or array of KeywordAndMatchType | No | - | Keyword text and match types as a native array or JSON string, e.g. [{“KeywordText”:“plumbing”,“MatchTypes”:[“Exact”,“Phrase”]}]. Use instead of keyword_ids. Microsoft accepts up to 1000 keywords. |
target_position | enum (FirstPage, MainLine, MainLine1) | No | FirstPage | Target position: FirstPage (first-page bid estimate, default), MainLine (top-of-page positions 2-4), or MainLine1 (first position). Estimates are not a guarantee of placement. |
campaign_id | integer or string | No | - | Text estimates only: campaign context. Required by Microsoft when ad_group_id is supplied. |
ad_group_id | integer or string | No | - | Text estimates only: ad-group context to improve estimate accuracy. |
location_ids | string or array of string | No | - | Text estimates only: Microsoft location IDs as an array or comma/newline-separated text. Use microsoft_ads_search_locations to find IDs. Omitted: Microsoft uses the ad group/campaign locations, or US (190) if neither is supplied. |
language | string | No | - | Text estimates only: language name, e.g. English (not EN). Omitted: inherits ad group/campaign language, otherwise English. |
currency | string | No | - | Text estimates only: currency code, e.g. USD. Omitted: uses account currency. Returned estimates include CurrencyCode. |
entity_level_bid | enum (Keyword, AdGroup, AllEntities) | No | - | Text estimates only: Keyword (default), AdGroup, or AllEntities to include both keyword and ad-group estimates. |
