Cmdlets for Snapchat Ads

Build 24.0.8963

AdSquads

Lists all ad squads within a specified ad account.

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.

  • 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 cmdlet will try to get the first account from the list returned by the Accounts view.
  • CampaignId supports the following operators: =,IN
The following queries are processed server side:
    SELECT * FROM AdSquads WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM AdSquads WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37') 
    SELECT * FROM AdSquads WHERE CampaignId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM AdSquads WHERE CampaignId IN ('2e8231d37-a1d5-4579-9f7c-331deb8082b8', 'ads2345-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM AdSquads WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
    SELECT * FROM AdSquads WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '8f19507f6bdd-69b96ded-4871-4750-83ba')

Columns

Name Type References Description
Id [KEY] String ID of the ad squad.
AccountId String

Accounts.Id

Ad account ID.
CampaignId String

Campaigns.Id

Campaign ID.
Bid Decimal Max Bid.
BillingEvent String Billing Event.
DailyBudget Decimal Daily Budget.
LifetimeBudget Decimal Lifetime budget.
EndTime Datetime End time.
Name String Ad Squad name.
CreatedAt Datetime The creation date of the entity.
UpdatedAt Datetime The date when the entity was last updated.
OptimizationGoal String Optimization Goal.

The allowed values are IMPRESSIONS, SWIPES, APP_INSTALLS, VIDEO_VIEWS, VIDEO_VIEWS_15_SEC, USES, STORY_OPENS, PIXEL_PAGE_VIEW, PIXEL_ADD_TO_CART, PIXEL_PURCHASE, PIXEL_SIGNUP, APP_ADD_TO_CART, APP_PURCHASE, APP_SIGNUP.

ConversionWindow String Conversion window optimization, requires optimization_goal is one of APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_REENGAGE_OPEN.

The allowed values are SWIPE_28DAY_VIEW_1DAY, SWIPE_7D.

Placement String Placement.
StartTime Datetime Start time.
Status String Ad Squad status.

The allowed values are ACTIVE, PAUSED.

Targeting String Targeting spec.
Type String Ad Squad Type.

The allowed values are SNAP_ADS, LENS, FILTER.

CapAndExclusionConfig String The frequency cap and exclusion spec.
AdSchedulingConfig String The schedule for running ads.
BidStrategy String Bidding strategy for this Ad Squad.

The allowed values are AUTO_BID, LOWEST_COST_WITH_MAX_BID, MIN_ROAS, TARGET_COST.

RoasValue Decimal The desired ROAS used with the MIN_ROAS BidStrategy.
PixelId String Pixel to be associated with the Ad Squad.
MeasurementProviderNames String approved measurement provider.

The allowed values are MOAT_SS, DOUBLEVERIFY.

DeliveryConstraint String Type of delivery.
PacingType String Type of pacing.

The allowed values are STANDARD, ACCELERATED.

The default value is STANDARD.

DeliveryStatus String Delivery status.

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