Cmdlets for Snapchat Ads

Build 24.0.8963

AudienceInsights

Lists all audience insights based on the targeting options.

Select

The cmdlet 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 cmdlet.

  • AccountId supports the following operator: =
  • DimensionCategory supports the following operator: =
The following queries are processed server side:
    SELECT * FROM AudienceInsights WHERE AccountId = '40b748fb-d16f-4b2a-8d63-a3547d01ba57' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'
    SELECT * FROM AudienceInsights WHERE AccountId = '40b748fb-d16f-4b2a-8d63-a3547d01ba57' AND DimensionCategory = 'demo' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'

Note: AccountId, BaseSpecCountryCode and TargetingSpecCountryCode are required. OR logical operator and NOT clause are supported server side. Targeting options must be grouped based on the dimension category.

Targeting Option Dimension Category
AgeGroup demographics
MinAge demographics
MaxAge demographics
Gender demographics
Language demographics
AdvancedDemographics demographics
DeviceConnectionType devices
DeviceOSType devices
DeviceOSVersionMin devices
DeviceOSVersionMax devices
DeviceCarrierId devices
DeviceMake devices
CountryCode geos
RegionId geos
MetroId geos
ZipCode geos
LocationCategoryId locations
LocationProximity locations
LocationProximityUnit locations
Latitude locations
Longitude locations
Radius locations
Unit locations
SegmentId segments
InterestCategoryId interests

Example Targeting Specs

United States, Male+Female, All Age Ranges

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'

United States, Male, Age Groups 21-34

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'AND TargetingSpecAgeGroup IN ('21-24', '25-34') AND TargetingSpecGender = 'MALE'

Canada, Female, 13-20, iOS

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'ca' AND TargetingSpecMinAge = '13' AND TargetingSpecMaxAge = '20' AND TargetingSpecGender = 'FEMALE' AND TargetingSpecDeviceOSType = 'iOS'

UK, Male+Female, Age 25, WIFI Only

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'uk' AND TargetingSpecMinAge = '25' AND TargetingSpecMaxAge = '25' AND TargetingSpecDeviceConnectionType = 'WIFI'

United States - All States Except Arizona or Texas, M+F, All Ages

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND (TargetingSpecCountryCode = 'us' AND NOT(TargetingSpecCountryCode = 'us' AND TargetingSpecRegionId IN (3, 44)))

United States, Female, 18-34, 'Fashion & Style Gurus' OR 'Film & TV Fans'

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecGender = 'FEMALE' AND TargetingSpecAgeGroup IN ('18-20', '21-24', '25-34') AND TargetingSpecInterestCategoryId IN ('SLC_7', 'SLC_8')

United States, All genders/ages, 'Comedy Fans'

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecInterestCategoryId = 'SLC_36'

United States, Male, 18-20, member of SAM segment ID '12345'

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecGender = 'MALE' AND TargetingSpecAgeGroup = '18-20' AND TargetingSpecSegmentId = '12345'

United States, Male, 18-20, NOT a member of SAM segment ID '98765'

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecGender = 'MALE' AND TargetingSpecAgeGroup = '18-20' AND NOT TargetingSpecSegmentId = '98765'

United States, AT&T

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecDeviceCarrierId = 'US_ATT'

United States, 21-24, (College Graduates OR Married People), Apparel Shoppers

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecInterestCategoryId = 'DLXS_1' AND TargetingSpecAdvancedDemographics IN ('DLXD_100', 'DLXD_300') AND TargetingSpecAgeGroup = '21-24' AND TargetingSpecRegulatedContent = false

United States, metros New York or Los Angeles only

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecMetroId IN ('501', '803')

USA, Female, Spanish speaking, 13-17, iOS version 10.3.2

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecAgeGroup = '13-17' AND TargetingSpecGender = 'FEMALE' AND TargetingSpecLanguage = 'es' AND TargetingSpecDeviceOSType = 'ios' AND TargetingSpecDeviceOSVersionMin = '9.0' AND TargetingSpecDeviceOSVersionMax = '10.3.2'

Zipcode Targeting

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecZipCode IN ('90291', '90026')

Device Make: All iPhone 7 plus and iPhone 6s Plus users

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecDeviceMake IN ('Apple/iPhone 7 Plus/', 'Apple/iPhone 6s Plus/')

Location Categories: Targeting Sports Arenas, Fitness Centers

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecLocationCategoryId IN ('LOI_15004', 'LOI_15002') AND TargetingSpecLocationProximityUnit = 'MILES' AND TargetingSpecLocationProximity = 1

Location Point Radius: Targeting 500 meter radius around Nordstrom locations in Seattle/Bellevue

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND ((TargetingSpecLatitude = 47.612447 AND TargetingSpecLongitude = -122.336751 AND TargetingSpecRadius = 500) OR (TargetingSpecLatitude = 47.617102 AND TargetingSpecLongitude = -122.203961 AND TargetingSpecRadius = 50 AND TargetingSpecUnit = 'KILOMETERS'))

Multi-country targeting: Targeting the US and Canada

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' OR TargetingSpecCountryCode = 'ca'

Snap Lifestyle Category inclusion of SLC_1, SLC_124 and exclusion of SLC_2

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND (TargetingSpecInterestCategoryId IN ('SLC_1', 'SLC_124') AND NOT TargetingSpecInterestCategoryId = 'SLC_2')

Columns

Name Type References Description
Id [KEY] String The insight Id.
AccountId String

Accounts.Id

The account Id.
Name String The insight name.
DimensionCategory String The dimension category of the insight.
Distribution String The distribution type of the insight.
TargetAudienceSizeMinimum String The minimum size of the target audience.
TargetAudienceSizeMaximum String The maximum size of the target audience.
ReferenceAudienceSizeMinimum String The minimum size of the target Reference.
ReferenceAudienceSizeMaximum String The maximum size of the target audience.
TargetAudiencePercent Decimal The target audience percent.
ReferenceAudiencePercent Decimal The reference audience percent.
TargetIndexToReference Decimal The target index to reference.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
BaseSpecAgeGroup String Age group targeting option.
TargetingSpecAgeGroup String Age group targeting option.
BaseSpecMinAge String Minimum age targeting option.
TargetingSpecMinAge String Minimum age targeting option.
BaseSpecMaxAge String Maximum targeting option.
TargetingSpecMaxAge String Maximum targeting option.
BaseSpecGender String Gender targeting option.
TargetingSpecGender String Gender targeting option.
BaseSpecLanguage String Language targeting option.
TargetingSpecLanguage String Language targeting option.
BaseSpecAdvancedDemographics String Advanced demographics targeting option.
TargetingSpecAdvancedDemographics String Advanced demographics targeting option.
BaseSpecDeviceConnectionType String Device connection type targeting option.
TargetingSpecDeviceConnectionType String Device connection type targeting option.
BaseSpecDeviceOSType String Device OS type targeting option.
TargetingSpecDeviceOSType String Device OS type targeting option.
BaseSpecDeviceOSVersionMin String Device OS min version targeting option.
TargetingSpecDeviceOSVersionMin String Device OS min version targeting option.
BaseSpecDeviceOSVersionMax String Device OS max version targeting option.
TargetingSpecDeviceOSVersionMax String Device OS max version targeting option.
BaseSpecDeviceCarrierId String Device carrier ID targeting option.
TargetingSpecDeviceCarrierId String Device carrier ID targeting option.
BaseSpecDeviceMake String Device make targeting option.
TargetingSpecDeviceMake String Device make targeting option.
BaseSpecCountryCode String Country code targeting option.
TargetingSpecCountryCode String Country code targeting option.
BaseSpecRegionId String Region/State ID targeting option.
TargetingSpecRegionId String Region/State ID targeting option.
BaseSpecMetroId String Metro/DMA ID targeting option.
TargetingSpecMetroId String Metro/DMA ID targeting option.
BaseSpecZipCode String ZipCode targeting option.
TargetingSpecZipCode String ZipCode targeting option.
BaseSpecLocationCategoryId String Location category ID targeting option.
TargetingSpecLocationCategoryId String Location category ID targeting option.
BaseSpecLocationProximity Int Proximity to selected location categories.
TargetingSpecLocationProximity Int Proximity to selected location categories.
BaseSpecLocationProximityUnit String Unit to be used for radius.
TargetingSpecLocationProximityUnit String Unit to be used for radius.
BaseSpecLatitude Decimal Latitude in decimal degrees.
TargetingSpecLatitude Decimal Latitude in decimal degrees.
BaseSpecLongitude Decimal Longitude in decimal degrees.
TargetingSpecLongitude Decimal Longitude in decimal degrees.
BaseSpecRadius Int Radius in meters (minimum 96 meters and maximum 100000 meters).
TargetingSpecRadius Int Radius in meters (minimum 96 meters and maximum 100000 meters).
BaseSpecUnit String Unit to be used for radius.
TargetingSpecUnit String Unit to be used for radius.
BaseSpecSegmentId String Segment ID targeting option.
TargetingSpecSegmentId String Segment ID targeting option.
BaseSpecInterestCategoryId String Interest category ID targeting option.
TargetingSpecInterestCategoryId String Interest category ID targeting option.
BaseSpecRegulatedContent Bool Flag to mark content within the Ad Squad as Regulated Content.
TargetingSpecRegulatedContent Bool Flag to mark content within the Ad Squad as Regulated Content.
BaseSpecEnableTargetingExpansion Bool Boolean, enabling this allows SnapchatAds to expand the audience beyond the selected targeting.
TargetingSpecEnableTargetingExpansion Bool Boolean, enabling this allows SnapchatAds to expand the audience beyond the selected targeting.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8963