Cmdlets for Snapchat Ads

Build 24.0.8963

Accounts

Lists all the ad accounts for the specified Organization.

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
  • OrganizationId supports the following operators: =,IN; If no value is specified, the cmdlet will try to get the first organization from the list returned by the Organizations view.
The following queries are processed server side:
    SELECT * FROM Accounts WHERE OrganizationId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM Accounts WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM Accounts WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM Accounts WHERE Id = '5f433224-28d2-40f8-982b-c353c67934cb'
    SELECT * FROM Accounts WHERE Id IN ('5f433224-28d2-40f8-982b-c353c67934cb', 'c353c67934cb-28d2-40f8-982b-c353c67934cb')

Insert


INSERT INTO Accounts (Name, Type, OrganizationId, Currency, TimeZone, BillingType, BillingCenterId, RestrictedDeliverySignalsRegulation, AgencyRepresentingClient, ClientPayingInvoices, Test, FundingSourceIds, ClientBasedInCountry, AgencyClientName, AgencyClientEmail, AgencyClientAddressLine1, AgencyClientCity, AgencyClientAdministrativeDistrictLevel1, AgencyClientCountry, AgencyClientZipCode, AgencyClientTaxId) VALUES ('delicieux aliments pour chiens', 'PARTNER', 'ca67fb1a-2653-495d-9446-c9e8a30f6232', 'EUR', 'Europe/Paris', 'REVOLVING', '6e0f4532-3702-4f0b-9889-9fe5d0614afd', false, true, false, true, '["5ca1687a-f2b4-437d-8554-a85403a714c5"]', 'FR', 'Madamemoiselle Poodle', '[email protected]', '101 Boulevard la Fayette', 'Paris', 'FR-O', 'FR', '62100', 'FR12345678900')

Update


UPDATE Accounts SET Name = 'Updated name', AgencyClientName = 'Updated agency client name' WHERE Id = '5f433224-28d2-40f8-982b-c353c67934cb'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

ID of the AD account.

OrganizationId String False

Organizations.Id

The ID of the organization.

Advertiser String False

Name of the Advertiser.

Currency String False

Account currency.

The allowed values are AUD, CAD, EUR, GBP, USD.

FundingSourceIds String False

Array of Funding Source IDs.

BillingType String False

Type of billing.

The allowed values are IO, REVOLVING.

BillingCenterId String False

BillingCenters.Id

The billing center ID.

Name String False

Account name.

Test Bool False

Indicates Ad Account is a test ad account, test ad accounts can never serve live ads.

CreatedAt Datetime False

The creation date of the entity.

UpdatedAt Datetime False

The date when the entity was last updated.

Timezone String False

Account timezone, remember to take the time differences into account when you set up your application.

The allowed values are Africa/Cairo, Africa/Johannesburg, America/Anchorage, America/Cancun, America/Chicago, America/Dawson, America/Dawson_Creek, America/Denver, America/Edmonton, America/Halifax, America/Hermosillo, America/Los_Angeles, America/Mazatlan, America/Mexico_City, America/Montevideo, America/New_York, America/Phoenix, America/Rainy_River, America/Regina, America/Tijuana, America/Toronto, America/Vancouver, Asia/Amman, Asia/Beirut, Asia/Dubai, Asia/Hong_Kong, Asia/Irkutsk, Asia/Jerusalem, Asia/Kamchatka, Asia/Krasnoyarsk, Asia/Magadan, Asia/Nicosia, Asia/Omsk, Asia/Qatar, Asia/Riyadh, Asia/Shanghai, Asia/Singapore, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Atlantic/Canary, Australia/Perth, Australia/Sydney, Europe/Amsterdam, Europe/Berlin, Europe/Brussels, Europe/Dublin, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Rome, Europe/Samara, Europe/Stockholm, Europe/Vienna, Europe/Vilnius, Europe/Warsaw, Europe/Zurich, Pacific/Auckland, Pacific/Honolulu, UTC.

Type String False

Account type.

The allowed values are DIRECT, PARTNER.

Status String False

Account status.

LifetimeSpendCap Decimal False

Required if BillingType is set to IO, the lifetime spend cap of the account.

AdvertiserOrganizationId String True

Organizations.Id

Organization ID of the Advertiser selected.

PayingAdvertiserName String False

Name of the paying advertiser/political entity, required if the Ad Account will contain political/advocacy ads.

RestrictedDeliverySignalsRegulation String False

Required if the Ad Account will contain ads for Credit, Housing or Employment, this attribute is immutable once set to true.

AgencyRepresentingClient Bool False

Whether the agency is representing a client or not.

ClientBasedInCountry String False

Required if AgencyRepresentingClient is true and if Advertiser is based in France or targeting Ads to audiences in France.

The allowed values are FR.

ClientPayingInvoices Bool False

Required if AgencyRepresentingClient is true and if Advertiser is based in France or targeting Ads to audiences in France.

DeliveryStatus String True

Delivery status.

AgencyClientName String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientEmail String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientAddressLine1 String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientCity String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientAdministrativeDistrictLevel1 String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientCountry String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientZipCode String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientTaxId String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

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