| account_id |
string |
Social account ID on the target ad platform. |
|
| 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 |
string |
|
[optional] |
| type |
string |
|
|
| match_rules |
\Zernio\Model\UploadedOrDerivedAudienceMatchRulesInner[] |
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 |
string |
Required for engagement audiences (LinkedIn only): what members engaged with — a video/leadgen/single-image ad campaign, a Company Page or an Event page. |
[optional] |
| trigger |
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 |
int |
Required for engagement audiences. Rolling window. |
[optional] |
| engagement_sources |
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 |
\Zernio\Model\UploadedOrDerivedAudienceCompaniesInner[] |
Required for company_list audiences (LinkedIn only): plain-text company rows for account targeting. Each row needs at least one identifier. LinkedIn recommends 1,000+ companies for a usable match rate and takes up to 48h to process the list. |
[optional] |
| pixel_id |
string |
Required for website audiences |
[optional] |
| retention_days |
int |
Required for website (max 180) and meta_engagement (max 365) audiences. |
[optional] |
| engagement_source |
string |
Required for meta_engagement audiences (Meta only): what people engaged with. `page` = a Facebook Page, `instagram` = an IG professional account, `video` = a video. The source object must be eligible for engagement audiences or Meta rejects with subcode 1713151 ("Invalid Event Name"), surfaced verbatim. |
[optional] |
| source_id |
string |
Required for meta_engagement: the Page / IG account / video id. |
[optional] |
| event |
string |
meta_engagement only. The engagement event; defaults per source (page → page_engaged, instagram → ig_business_profile_all, video → video_watched). Ignored when `rule` is provided. |
[optional] |
| source_audience_id |
string |
Required for lookalike audiences |
[optional] |
| country |
string |
2-letter code, required for lookalike audiences |
[optional] |
| ratio |
float |
Required for lookalike audiences |
[optional] |
| rule |
object |
Optional raw Meta rule, forwarded verbatim: pixel event rule for website audiences, or the engagement rule for meta_engagement (overrides the built rule, e.g. for event/canvas/lead-form sources). |
[optional] |
| customer_file_source |
string |
Data source declaration for GDPR compliance (customer_list only) |
[optional] |
| spec |
\ZernioModelTargetingSpec |
The targeting spec to store. |
|