# UploadedOrDerivedAudience
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_id** | **String** | |
**ad_account_id** | **String** | Platform ad account ID. Must start with act_ for Meta; bare platform id for others (Google customer id, X/TikTok/LinkedIn/Pinterest account id). |
**name** | **String** | |
**description** | Option<**String**> | | [optional]
**r#type** | **Type** | (enum: customer_list, company_list, engagement, meta_engagement, tiktok_engagement, pinterest_engagement, website, website_retargeting, lookalike) |
**match_rules** | Option<[**Vec<models::UploadedOrDerivedAudienceMatchRulesInner>**](UploadedOrDerivedAudienceMatchRulesInner.md)> | Required for website_retargeting audiences (LinkedIn only). Each rule is a URL pattern; a member who visits any matching page enters the segment. Needs the LinkedIn Insight Tag installed on the customer's site; the segment only starts filling once the tag reports visits. The response's `platformAudienceId` is the LinkedIn adSegment id, valid for downstream use. These segments appear in GET /v1/ads/audiences with `type: website_retargeting` once LinkedIn has finished building them. | [optional]
**source_type** | Option<**SourceType**> | Required for engagement audiences (LinkedIn only): what members engaged with: a video/leadgen/single-image ad campaign, a Company Page or an Event page. (enum: VIDEO_ADS, LEAD_GEN_FORMS, ORGANIZATION_PAGES, EVENT_PAGES, SINGLE_IMAGE_ADS) | [optional]
**trigger** | Option<**String**> | Required for engagement audiences. The action, validated by LinkedIn against `sourceType`. Common values: VIDEO_ADS FIRST_QUARTILE / MIDPOINT / THIRD_QUARTILE / FULL_COMPLETE; LEAD_GEN_FORMS VIEW_FORM / LEAD_FORM_SUBMIT; ORGANIZATION_PAGES VIEW / CTA_CLICK; EVENT_PAGES RSVPED / VIDEO_VIEWED / ENGAGEMENT / CLICK. | [optional]
**lookback_days** | Option<**LookbackDays**> | Required for engagement audiences. Rolling window. (enum: 30, 60, 90, 180, 365) | [optional]
**engagement_sources** | Option<**Vec<String>**> | Required for engagement audiences. Campaign URNs for the ad source types, organization URNs for pages and events. LinkedIn creates one rule per source, all sharing the same trigger and lookbackDays. | [optional]
**companies** | Option<[**Vec<models::UploadedOrDerivedAudienceCompaniesInner>**](UploadedOrDerivedAudienceCompaniesInner.md)> | Required for company_list audiences (LinkedIn only): plain-text company rows for account targeting. Each row needs at least one identifier. Not hashed, LinkedIn matches these against its own company graph. LinkedIn recommends 1,000+ companies for a usable match rate and takes up to 48h to process the list. Replace the list later with POST /v1/ads/audiences/{audienceId}/companies. | [optional]
**pixel_id** | Option<**String**> | website: the Meta pixel, TikTok pixel or Pinterest tag id. Required on those three, rejected on Google. | [optional]
**retention_days** | Option<**i32**> | Required for website (Meta max 180, TikTok 7/14/30/60/90/180, Pinterest and Google max 540), meta_engagement (max 365) and tiktok_engagement (7/14/30/60/90/180; organic and live video and most business-account events only 7/14/30). | [optional]
**engagement_source** | Option<**EngagementSource**> | Required for meta_engagement audiences (Meta only): what people engaged with. `page` = a Facebook Page, `instagram` = an IG professional account, `video` = a video. (enum: page, instagram, video) | [optional]
**source_id** | Option<**String**> | Required for meta_engagement: the Page / IG account / video id. | [optional]
**event** | Option<**String**> | meta_engagement: the engagement event; defaults per source (page → page_engaged, instagram → ig_business_profile_all, video → video_watched). Ignored when `rule` is provided. website on TikTok: the pixel event (default `PAGE BROWSE`). website on Pinterest: the tag event (`pagevisit`, `signup`, `checkout`, `viewcategory`, `search`, `addtocart`, `watchvideo`, `lead`, `custom` or a partner-defined event). tiktok_engagement (required): the TikTok engagement event, validated per `source` (TikTok's filter values, spaces included): - ads: `CLICK`, `IMPRESSION`, `PLAY 2S`, `PLAY 6S`, `PLAY 25`, `PLAY 50`, `PLAY 75`, `PLAY OVER`, and the `ENGAGEMENT APP PROFILE` / `ENGAGEMENT TIKTOK INSTANT` / `ENGAGEMENT COLLECTION ADS` `CLICK` and `IMPRESSION` events. - organic_video: `ORGANIC VIDEO PLAY 2S`, `ORGANIC VIDEO PLAY 6S`, `ORGANIC VIDEO PLAY OVER`, `ORGANIC VIDEO ENGAGEMENT`. - live_video: `LIVE VIDEO VIEW`, `LIVE VIDEO ENGAGEMENT`. - business_account: `BUSINESS ACCOUNT PROFILE FOLLOW`, `BUSINESS ACCOUNT PROFILE VISIT`, `BUSINESS ACCOUNT ENGAGEMENT`, `BUSINESS ACCOUNT PLAY 2S`, `BUSINESS ACCOUNT PLAY 6S`, `BUSINESS ACCOUNT PLAY OVER` and the rest of TikTok's business-account events. An unknown value is a 400 that lists the valid ones. | [optional]
**source_audience_id** | Option<**String**> | Required for lookalike audiences | [optional]
**country** | Option<**String**> | 2-letter code, required for lookalike audiences | [optional]
**ratio** | Option<**f64**> | lookalike on Meta (0.01-0.20) and Pinterest (0.01-0.10, whole percents). Rejected on TikTok and Google. | [optional]
**size** | Option<**Size**> | lookalike on TikTok and Google: audience breadth. Rejected on Meta and Pinterest. (enum: narrow, balanced, broad) | [optional]
**source** | Option<**Source**> | Required for tiktok_engagement: what people engaged with. (enum: ads, organic_video, live_video, business_account) | [optional]
**source_ids** | Option<**Vec<String>**> | tiktok_engagement: ad group / campaign ids for `ads`, video ids for `organic_video` and `live_video` (max 10). Required except for `business_account`. | [optional]
**identity_id** | Option<**String**> | tiktok_engagement: the TikTok identity that owns the videos or business account. Required for organic_video, live_video and business_account. | [optional]
**identity_type** | Option<**IdentityType**> | tiktok_engagement: type of `identityId`. (enum: TT_USER, BC_AUTH_TT) | [optional]
**identity_authorized_bc_id** | Option<**String**> | tiktok_engagement: required when identityType is BC_AUTH_TT. | [optional]
**engager_type** | Option<**EngagerType**> | pinterest_engagement: Pinterest's `engager_type`, passed through when set. (enum: 1, 2) | [optional]
**engagement_type** | Option<**EngagementType**> | pinterest_engagement: limit to one engagement action. (enum: click, save, closeup, comment, like) | [optional]
**engagement_domains** | Option<**Vec<String>**> | pinterest_engagement: people who engaged with Pins from these domains. The domain must be claimed on the Pinterest account or Pinterest rejects it. | [optional]
**campaign_ids** | Option<**Vec<String>**> | pinterest_engagement: people who engaged with these campaigns' ads. | [optional]
**ad_ids** | Option<**Vec<String>**> | pinterest_engagement: people who engaged with these ads. | [optional]
**pin_ids** | Option<**Vec<String>**> | pinterest_engagement: people who engaged with these Pins. At least one of engagementDomains, campaignIds, adIds or pinIds is required. | [optional]
**url_contains** | Option<**String**> | website on Meta, TikTok and Google. Narrows the audience from all visitors to visitors of URLs containing this substring. Ignored when `rule` is supplied. A 400 on Pinterest, which only matches exact URLs. | [optional]
**rule** | Option<**serde_json::Value**> | Meta only (a 400 elsewhere). Optional raw Meta rule, replacing the one we build. Omit it for all visitors of `pixelId`, or use `urlContains` for the common page-match case. For `website` this is Meta's Flexible Audience Rule and is VALIDATED before we call Meta: every entry in `inclusions.rules` (and `exclusions.rules`) must carry `event_sources`, `retention_seconds` AND `filter`. Meta rejects a rule missing any of the three with code 100 / subcode 1713098 (\"Invalid rule JSON format\"), so a bad shape is a 400 here instead. The pre-2018 flat shapes (`{url: ...}`, `{event: ...}`) are not accepted by Meta at all (subcode 1870029). Example, visitors of /checkout in the last 30 days: `{\"inclusions\":{\"operator\":\"or\",\"rules\":[{\"event_sources\":[{\"id\":\"<pixelId>\",\"type\":\"pixel\"}],\"retention_seconds\":2592000,\"filter\":{\"operator\":\"and\",\"filters\":[{\"field\":\"url\",\"operator\":\"i_contains\",\"value\":\"/checkout\"}]}}]}}` Note Meta DERIVES `retention_days` from `retention_seconds` and stores `event_sources[].id` as a number, so a rule read back will not be byte-identical to the one you sent. For `meta_engagement` the rule is forwarded verbatim and NOT validated: that type has two dialects (the `video` source uses a legacy flat array), so no single schema covers both. | [optional]
**customer_file_source** | Option<**String**> | Data source declaration for GDPR compliance (customer_list only) | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)