account | DynamicAccount | Yes | - | Select the Snapchat Ads account to create the audience in. |
audience_name | string | Yes | - | Name of the audience segment. Max 375 characters. |
description | string | No | - | Optional description of the audience. |
audience_type | string or SelectableOption | No | {'value': 'CUSTOMER_LIST', 'label': 'Customer List'} | CUSTOMER_LIST (default) creates an empty Customer List segment (source_type FIRST_PARTY); add hashed users with snapchat_ads_add_users_to_audience afterwards. LOOKALIKE creates a lookalike segment modeled on an existing seed segment. MOBILE_APP_EVENTS: people who triggered events in your app (needs snap_app_id and events). WEBSITE_EVENTS: people who triggered Snap Pixel events (needs pixel_id and events). AD_ENGAGEMENT: people who engaged with your ads (needs engagement_specs). Event and engagement audiences fill automatically and are excluded or included in ad squad targeting segments. |
retention_in_days | integer | No | - | How long users stay in the segment, in days, up to 395. Default: 180, or 395 for AD_ENGAGEMENT. |
events | array of enum (APP_INSTALL, PURCHASE, SAVE, START_CHECKOUT, ADD_CART, VIEW_CONTENT, ADD_BILLING, SIGN_UP, …) | No | - | MOBILE_APP_EVENTS and WEBSITE_EVENTS only: events that put someone in the audience; anyone who triggered ANY of them within retention_in_days joins. For example [‘ADD_CART’, ‘START_CHECKOUT’] or [‘PURCHASE’]. |
snap_app_id | string | No | - | MOBILE_APP_EVENTS only: the Snap App ID connected to the ad account (sent as mobile_metadata.mobile_snapkit_id). Existing MOBILE audiences in snapchat_ads_list_audiences show it under mobile_metadata. |
pixel_id | string or SelectItem | No | - | WEBSITE_EVENTS only: the Snap Pixel of the ad account, from snapchat_ads_list_pixels. |
engagement_specs | array of EngagementSpec | No | - | AD_ENGAGEMENT only: engagements that put someone in the audience; matching ANY spec is enough. For example [{“engagement_type”: “SNAP_ADS_SWIPE_UP”, “source_type”: “CAMPAIGN”, “source_id”: “<campaign id>”}]. |
seed_segment_id | string or SelectItem | No | - | LOOKALIKE only: the existing segment to model the lookalike on (sent as creation_spec.seed_segment_id). The seed must be targetable (READY). |
lookalike_country | string | No | - | LOOKALIKE only: ISO-2 country code the lookalike expands into (sent as creation_spec.country), for example US. |
lookalike_type | string or SelectableOption | No | {'value': 'BALANCE', 'label': 'Balance'} | LOOKALIKE only: BALANCE (default, mix of similarity and reach), SIMILARITY (closest to the seed), or REACH (largest audience). Sent as creation_spec.type. |