Cmdlets for Snapchat Ads

Build 24.0.8963

Ads

Lists all ads 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.
  • AdSquadId supports the following operators: =,IN
The following queries are processed server side:
    SELECT * FROM Ads WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM Ads WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37') 
    SELECT * FROM Ads WHERE AdSquadId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM Ads WHERE AdSquadId IN ('2e8231d37-a1d5-4579-9f7c-331deb8082b8', 'ads2345-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM Ads WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
    SELECT * FROM Ads WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '83ba-8f19507f6bdd-69b96ded-4871-4750')

Columns

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

Accounts.Id

Ad Account ID.
AdSquadId String

AdSquads.Id

Ad Squad ID.
CreativeId String Creative ID.
Name String Ad name.
CreatedAt Datetime The creation date of the entity.
UpdatedAt Datetime The date when the entity was last updated.
PayingAdvertiserName String Name of the paying advertiser/political entity.
ReviewStatus String Ad Review Status.

The allowed values are PENDING, APPROVED, REJECTED.

ReviewStatusReason String List of Ad Review Rejection Reasons.
Status String Ad status.

The allowed values are ACTIVE, PAUSED.

Type String Ad type.

The allowed values are SNAP_AD, LONGFORM_VIDEO, APP_INSTALL, REMOTE_WEBPAGE, DEEP_LINK, STORY, AD_TO_LENS, AD_TO_CALL, AD_TO_MESSAGE, FILTER, LENS, LENS_WEB_VIEW, LENS_APP_INSTALL, LENS_DEEP_LINK, LENS_LONGFORM_VIDEO, COLLECTION.

DeliveryStatus String Delivery status.

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