account | object or array of object or MicrosoftAdsAccountItem or string or integer | Yes | - | Select the Microsoft Ads account, ask user for it if not provided |
update_type | string or SelectableOption | Yes | - | Choose whether to create a single sitelink or multiple sitelinks at once. Available options: ‘single’ (Single Sitelink), ‘bulk’ (Multiple Sitelinks) |
level | string or SelectableOption | No | - | Choose where to attach the sitelink. Required for ‘single’ mode. Available options: ‘ACCOUNT’, ‘CAMPAIGN’, ‘AD_GROUP’ |
campaign_ids | array of string or SelectItem | No | - | Select one or more campaigns to attach the sitelink (CAMPAIGN level) |
ad_group_ids | array of string or SelectItem | No | - | Select one or more ad groups to attach the sitelink (AD_GROUP level) |
link_text | string | No | - | The clickable text for the sitelink (max 25 characters with a description, otherwise max 35) |
final_url | string | No | - | Landing page URL for the sitelink (e.g., https://example.com) |
description1 | string | No | - | First description line (optional, max 35 characters). If set, description2 is required. |
description2 | string | No | - | Second description line (optional, max 35 characters). If set, description1 is required. |
start_date | integer or string | No | - | Start date for when the sitelink can begin serving (Unix timestamp or YYYY-MM-DD format) |
end_date | integer or string | No | - | End date for when the sitelink stops serving (Unix timestamp or YYYY-MM-DD format) |
structured_data | array (also accepts a comma-separated string) | No | - | Use only when update_type is ‘bulk’. CSV/JSON data with required columns: ‘level’ (ACCOUNT/CAMPAIGN/AD_GROUP), ‘link_text’, ‘final_url’. Optional columns: ‘description1’, ‘description2’ (must be provided together), ‘start_date’, ‘end_date’ (YYYY-MM-DD or Unix timestamp). For CAMPAIGN level add ‘campaign_ids’ (comma-separated for multiple), for AD_GROUP level add ‘ad_group_ids’ (comma-separated for multiple). |
