AudienceSegments
Lists all Snap Audience Match segments within a specified ad account.
Select
The adapter will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the adapter.
- Id supports the following operator: =,IN
- AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the adapter will try to get the first account from the list returned by the Accounts view.
SELECT * FROM AudienceSegments WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8' SELECT * FROM AudienceSegments WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37') SELECT * FROM AudienceSegments WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd' SELECT * FROM AudienceSegments WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '8f19507f6bdd-69b96ded-4871-4750-83ba')
Insert
INSERT INTO AudienceSegments (Name, Description, SourceType, RetentionInDays, AccountId) VALUES ('all the sams in the world', 'all the sams in the world', 'FIRST_PARTY', 180, '422588db-75f3-47d1-be3b-92e296d33f68')
Update
UPDATE AudienceSegments SET Name = 'Updated name', Description = 'Updated description', RetentionInDays = 60 WHERE Id = '5689640350646272'
Delete
DELETE AudienceSegments WHERE Id = '4873877536079576'
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
ID of the audience segment. | |
AccountId | String | False |
Accounts.Id |
Ad Account ID. |
Description | String | False |
Audience Segment Description. | |
Name | String | False |
Audience Segment name. | |
CreatedAt | Datetime | False |
The creation date of the entity. | |
UpdatedAt | Datetime | False |
The date when the entity was last updated. | |
RetentionInDays | Int | False |
Number of days to retain audience members. The default value is 9999. | |
SourceType | String | False |
Data source type. The allowed values are FIRST_PARTY, ENGAGEMENT, PIXEL, MOBILE, FOOT_TRAFFIC_INSIGHTS. | |
ApproximateNumberUsers | Int | True |
Approximate number of users in the segment. | |
Status | String | True |
Status of the segment. | |
UploadStatus | String | True |
Upload status of the segment. The allowed values are NO_UPLOAD, PROCESSING, COMPLETE. | |
TargetableStatus | String | True |
Status of whether this segment can be targeted. The allowed values are NOT_READY, TOO_FEW_USERS, READY. |