Audiences
Get list of audiences for the ad account.
Table Specific Information
Select
The add-in will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the add-in.
- Id supports the '=' operator.
- AdAccountId supports the '=' operator.
SELECT * FROM Audiences WHERE Id = '2542622901002' SELECT * FROM Audiences WHERE AdAccountId = '549768233165'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | Audience ID. | |
| AdAccountId | String |
AdAccounts.Id | Ad account ID. |
| Name | String | Audience name. | |
| AudienceType | String | Audience Types.
The allowed values are ACTALIKE, ENGAGEMENT, CUSTOMER_LIST, VISITOR. | |
| Description | String | Audience description. | |
| RuleCountry | String | Valid countries include: US,CA, and GB.
The allowed values are US, CA, GB. | |
| RuleCustomerListId | String | Customer list ID. For CUSTOMER_LIST audience_type. | |
| RuleEngagementDomain | String | Engagement domain. | |
| RuleEngagementType | String | Engagement type enum. Optional for ENGAGEMENT audience_type.
The allowed values are click, save, closeup, comment, like. | |
| RuleEvent | String | A Pinterest tag event. Optional for VISITOR audience_type.
The allowed values are pagevisit, signup, checkout, viewcategory, search, addtocart, watchvideo, lead, custom. | |
| RuleEventDataCurrency | String | Currency Codes from ISO 4217. | |
| RuleEventDataLeadType | String | Promotion code. | |
| RuleEventDataLineItemsProductBrand | String | Product brand. | |
| RuleEventDataLineItemsProductCategory | String | Product category. | |
| RuleEventDataLineItemsProductId | Integer | Product ID. | |
| RuleEventDataLineItemsProductName | String | Product name. | |
| RuleEventDataLineItemsProductPrice | String | Product price. | |
| RuleEventDataLineItemsProductQuantity | Integer | Product quantity. | |
| RuleEventDataLineItemsProductVariant | String | Product variant. | |
| RuleEventDataLineItemsProductVariantId | String | Product variant ID. | |
| RuleEventDataOrderId | String | Order ID. | |
| RuleEventDataOrderQuantity | Integer | Order quantity. | |
| RuleEventDataPageName | String | Page name. | |
| RuleEventDataPromoCode | String | Promotion code. | |
| RuleEventDataProperty | String | Property. | |
| RuleEventDataSearchQuery | String | Search query string. | |
| RuleEventDataValue | String | Product value. | |
| RuleEventDataVideoTitle | String | Video title. | |
| RulePercentage | Integer | Percentage should be 1-10. The targeted audience should be this % size across Pinterest. | |
| RulePinId | String | Pin Id. | |
| RulePrefill | Boolean | Optional for VISITOR audience_type. The default is true. | |
| RuleRetentionDays | Integer | Number of days a Pinterest user remains in the audience. Optional for ENGAGEMENT and VISITOR audience_type. | |
| RuleSeedId | String | Seed Id. | |
| RuleUrl | String | Url. | |
| RuleVisitorSourceId | String | The conversion tag ID, or the Pinterest tag ID, that you use on your website. For VISITOR audience_type. | |
| RuleEventSource | String | Optional for VISITOR. You can use it as a {'=': [value]}. | |
| RuleIngestionSource | String | Optional for VISITOR. You can use it as a {'=': [value]}. Supported values are: tag, mmp, file_upload, conversions_api | |
| RuleEngagerType | Integer | Optional for ENGAGEMENT. Engager type value should be 1-2. | |
| RuleCampaignId | String | Campaign Id. | |
| RuleAdId | String | Ad Id. | |
| RuleObjectiveType | String | Objective Type. | |
| RuleAdAccountId | String | Ad account ID. | |
| Size | Integer | Audience size. | |
| Status | String | Audience status.
The allowed values are READY, INITIALIZING, TOO_SMALL. | |
| Type | String | Always | |
| CreatedTime | Datetime | Creation time. Unix timestamp in seconds. | |
| UpdatedTime | Datetime | Last update time. Unix timestamp in seconds. |