keywords | array of string | No | - | CustomSegment only: keyword phrases as an array, JSON array, or comma/newline-separated text, e.g. [“NIST compliance”, “CMMC certification”]. Microsoft supports 1–1,000 phrases, each up to 100 characters. Uses Bulk Text internally. On update this replaces the entire keyword list; omission preserves it. Do not combine with custom_segment_catalog_list. Semicolons cannot be used inside a phrase. |
custom_segment_catalog_list | array or string | No | - | CustomSegment only: native CustomSegmentCatalogList array or JSON string, e.g. [{“CatalogId”:123}]. Use existing Microsoft catalog definitions; CatalogName is not assumed to represent arbitrary keyword text. Use keywords for keyword-based segments. Updates replace this definition; omission preserves it. |
account | object or array of object or MicrosoftAdsAccountItem or string or integer | Yes | - | Microsoft Ads account to create the audience in. |
name | string | Yes | - | Audience name, unique within the account. |
audience_type | enum (RemarketingList, CustomerList, Product, CombinedList, CustomSegment, ImpressionBasedRemarketingList) | Yes | - | Type of audience. RemarketingList targets site visitors and needs a UET tag. CustomerList is filled afterwards with microsoft_ads_upload_customer_list. Microsoft will not create in-market, DMP-based CustomAudience or similar audiences through the API; those come from Microsoft or from the web interface. CustomSegment supports keyword phrases or native catalog definitions. |
description | string | No | - | Optional note about the audience. |
scope | enum (Account, Customer) | No | - | Account keeps the audience to this account, Customer shares it across every account under the customer. |
membership_duration | integer | No | - | How many days someone stays in the audience. 1 to 180 for most types, up to 390 for a customer list, and -1 on a customer list means never expire. |
tag_id | integer or string | No | - | UET tag feeding the audience. Required for RemarketingList and Product audiences. microsoft_ads_list_uet_tags returns these. |
rule | object or string | No | - | RemarketingList only, and required: Microsoft rejects a remarketing list without one. JSON in Microsoft’s RemarketingRule shape, for example {“Type”: “PageVisitors”, “RuleItemGroups”: [{“Items”: [{“Type”: “String”, “Operand”: “Url”, “Operator”: “Contains”, “Value”: “example.com/pricing”}]}]}. The item Type is String or Number, not the page or URL being matched. Operand is Url or ReferrerUrl. Items inside a group are ANDed and the groups are ORed. |
product_audience_type | enum (GeneralVisitors, ProductSearchers, ProductViewers, ShoppingCartAbandoners, PastBuyers) | No | - | Product audiences only: which shopper behaviour to target. |
combination_rules | array or string | No | - | CombinedList only: the include and exclude rules combining other audiences, as JSON. |