JSON object defining targeted audience users. Example rule formats per audience type:
CUSTOMER_LIST: { "customer_list_id": "<customer list ID>"}
ACTALIKE: { "seed_id": ["<audience ID>"], "country": "US", "percentage": "10" }
(Valid countries include: "US", "CA", and "GB". Percentage should be 1-10.
The targeted audience should be this % size across Pinterest.)
VISITOR: { "visitor_source_id": ["<conversion tag ID>"], "retention_days": "180", "event_source": {"=": ["web", "mobile"]}, "ingestion_source": {"=": ["tag"]}}
(Retention days should be 1-540. Retention applies to specific customers.)
ENGAGEMENT: {"engagement_domain": ["www.entomi.com"], "engager_type": 1}
For more details on engagement audiences, see <a href="https://developers.pinterest.com/docs/redoc/adtech_ads_v4/#section/November-2021\" target="_blank">November 2021 changelog.
| Name | Type | Description | Notes |
|---|---|---|---|
| country | str | Valid countries include: "US", "CA", and "GB". | [optional] |
| customer_list_id | str | Customer list ID. For CUSTOMER_LIST `audience_type`. | [optional] |
| engagement_domain | [str] | The audience account's verified domain. Required for ENGAGEMENT `audience_type`. | [optional] |
| engagement_type | str | Engagement type enum. Optional for ENGAGEMENT `audience_type`. Supported values are `click`, `save`, `closeup`, `comment` and `like`. All engagements are included if this field is not set. | [optional] |
| event | str | A Pinterest tag event. Optional for VISITOR `audience_type`. Possible values are `pagevisit`, `signup`, `checkout`, `viewcategory`, `search`, `addtocart`, `watchvideo`, `lead`, and `custom`. This field also accepts a partner-defined Pinterest tag event. | [optional] |
| event_data | PinterestTagEventData | [optional] | |
| percentage | int | Percentage should be 1-10. The targeted audience should be this % size across Pinterest. | [optional] |
| pin_id | [str] | IDs of engaged organic pins. Optional for ENGAGEMENT `audience_type`. For example, "pin_id:": ["34567"] | [optional] |
| prefill | bool | Optional for VISITOR `audience_type`. If `true`, the specified rule on existing engagement data is applied to pre-populate the audience. If `false`, the audience is empty at creation time. The default is `true`. | [optional] |
| retention_days | int | Number of days a Pinterest user remains in the audience. Optional for ENGAGEMENT and VISITOR `audience_type`. Accepted range is 1-540. Defaults to 180 if not specified. | [optional] |
| seed_id | [str] | Audience ID(s). For ACTALIKE `audience_type`. | [optional] |
| url | [str] | Optional for ENGAGEMENT or VISITOR `audience_type`. For ENGAGEMENT, it is the engaged pin's URL. For VISITOR, you can use it as a string or a {operator: value} object for filtering visitors based on conversion tag event URLs. Supported operators are [ =, !=, contains, not_contains].<br>Example 1: "url": "http://www.myonlinestore123.com/view_item/shoe\"<br>Example 2: "url": {"contains": "/view_item/shoe"} | [optional] |
| visitor_source_id | str | The conversion tag ID, or the Pinterest tag ID, that you use on your website. For VISITOR `audience_type`. | [optional] |
| event_source | {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Optional for VISITOR. You can use it as a {'=': [value]}. Supported values are: web, mobile, offline | [optional] |
| ingestion_source | {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Optional for VISITOR. You can use it as a {'=': [value]}. Supported values are: tag, mmp, file_upload, conversions_api | [optional] |
| engager_type | int | Optional for ENGAGEMENT. Engager type value should be 1-2. | [optional] |
| campaign_id | [str] | Campaign ID for engagement audience filter. | [optional] |
| ad_id | [str] | Ad ID for engagement audience filter. | [optional] |
| objective_type | [ObjectiveType] | Objective for engagement audience filter. | [optional] |
| ad_account_id | str | Ad account ID. | [optional] |
| any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |