Campaigns
Lists all campaigns within a specified ad account.
Select
The provider 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 provider.
- 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 provider will try to get the first account from the list returned by the Accounts view.
SELECT * FROM Campaigns WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8' SELECT * FROM Campaigns WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37') SELECT * FROM Campaigns WHERE Id = '5f433224-28d2-40f8-982b-c353c67934cb' SELECT * FROM Campaigns WHERE Id IN ('5f433224-28d2-40f8-982b-c353c67934cb', 'c353c67934cb-5f433224-28d2-40f8-982b')
Insert
INSERT INTO Campaigns (Name, AccountId, Status, StartTime, RegulationsRestrictedDeliverySignals, MeasurementSpecIOSAppId, MeasurementSpecAndroidAppURL) VALUES ('Cool Campaign', '422588db-75f3-47d1-be3b-92e296d33f68', 'PAUSED', '2016-08-11 22:03:58.869', true, '1234', 'com.snapchatads.android')
Update
UPDATE Campaigns SET Name = 'Cool Campaign (Updated)', RegulationsRestrictedDeliverySignals = false WHERE ID = '1ebd8b15-8100-4cbb-8ad1-04b538bbd043'
Delete
DELETE Campaigns WHERE ID = '1ebd8b15-8100-4cbb-8ad1-04b538bbd043'
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
Campaign ID. | |
AccountId | String | False |
Accounts.Id |
Ad Account ID. |
DailyBudget | Decimal | False |
Daily Spend Cap. | |
EndTime | Datetime | False |
End time. | |
Name | String | False |
Campaign name. | |
CreatedAt | Datetime | False |
The creation date of the entity. | |
UpdatedAt | Datetime | False |
The date when the entity was last updated. | |
StartTime | Datetime | False |
Start time. | |
Status | String | False |
Campaign status. The allowed values are ACTIVE, PAUSED. | |
LifetimeSpendCap | Decimal | False |
Lifetime spend cap for the campaign. | |
MeasurementSpecIOSAppId | String | False |
The IOS app to be tracked for this campaign. | |
MeasurementSpecAndroidAppURL | String | False |
The Android app to be tracked for this campaign. | |
Objective | String | False |
Objective of the Campaign. The default value is BRAND_AWARENESS. | |
RegulationsRestrictedDeliverySignals | Bool | False |
Required for Campaigns that run Ads for Credit, Housing, Employment (CHE). | |
RegulationsCandidateBallotInformation | String | False |
The candidate / ballot field is optional, but may be required in certain states. | |
DeliveryStatus | String | True |
Delivery status. |