Skip to main content
Skip table of contents

Snapchat - Structure

Overview

Vendor/Partner

Snapchat

Version

v1

API Documentation

https://marketingapi.snapchat.com/docs/#version

Sunset Date

None as of 10/06/2023

https://marketingapi.snapchat.com/docs/#version

Channel(s)

Refresh Time (CST)

Default backfill

Alli Data Library

(tick) (error) (Not at the moment)

Getting Started

  1. Click the Request Snapchat Ads Access button and grant access.

  2. Select the Ad Account that you would like to run a report on from the drop down menu.

  3. Select the report type you would like to run

Limitations

Selectable Accounts

Accounts that show up after authentication does not guarantee access to the client. This datasource does NOT check whether the user has the necessary access to request data from Snap. Below is an example of a permission related error:

CODE
None of the requested actions [READ_CONTAINER_ENTITY, READ_AD] can be authorized. Current user principal: 489aad24-1207-4672-be7d-a1bde5a53026. Container roles: [member, audience]"

Define your Data

Account Report:

Column Name

Description

ID

Unique ID for the Account

Advertiser

Name of the Advertiser

Name

Account name

Timezone

Account timezone, in which all timings are stored in UTC

Currency

Account currency

Funding Source IDs

Array of Funding Source IDs

Organization ID

Organization ID

Billing Type

Type of billing

Type

Account type

Advertiser Organization ID

Organization ID of the Advertiser selected

Lifetime Spend Cap

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

Test

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

Paying Advertiser Name

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

Regulations

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

Agency Representing Client

Indicates whether an agency is representing the client

Client Based in Country

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

Client Paying Invoices

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

Agency Client Metadata

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

Delivery Status

Delivery status

Updated At

Timestamp of when the campaign was last updated

Created At

Timestamp of when the campaign was created

Campaigns Report:

Column Name

Description

ID

Unique ID for the campaign

Ad Account ID

Ad Account ID

Name

Campaign name (max length: 375 characters)

Daily Spend Cap

Daily spend cap for the campaign

Lifetime Spend Cap

Lifetime spend cap for the campaign

Start Time

Start time for the campaign

End Time

End time for the campaign

Status

Campaign status (ACTIVE, PAUSED)

Objective

Objective of the campaign (BRAND_AWARENESS (default), APP_CONVERSION, APP_INSTALL, CATALOG_SALES, ENGAGEMENT, LEAD_GENERATION, VIDEO_VIEW, WEB_CONVERSION, PROMOTE_STORIES, PROMOTE_PLACES)

Delivery Status

Delivery status

Deleted

Indicates whether the entity has been deleted or not, only shown when using the parameter read_deleted_entities

Android Measurement Spec

The Android apps to be tracked for this campaign

IOS Measurement Spec

The IOS apps to be tracked for this campaign

Buy Model

Buy Model (AUCTION(default), RESERVED)

Regulations

Regulations for Campaigns that run Ads for Credit, Housing, Employment (CHE)

Updated At

Timestamp of when the campaign was last updated

Created At

Timestamp of when the campaign was created

Adsquads Report:

Column Name

Description

ID

Unique ID for the Ad Squad

Campaign ID

Unique ID for the campaign

Campaign Name

Name of the Campaign

Ad Account ID

Unique ID for the Ad Account

Name

Ad Squad name

Max Bid (micro-currency)

Maximum bid for the campaign in micro-currency

Daily Budget (micro-currency)

Daily budget in micro-currency

Lifetime Budget (micro-currency)

Lifetime budget in micro-currency

Start Time

Start time for the campaign

End Time

End time for the campaign

Campaign Status

Campaign status

Conversion Window

Delivery optimization window

Delivery Status

Delivery status

Deleted

Indicates whether the entity has been deleted or not

Billing Event

Billing event

Child Ad Type

Indicates what Ad type the Ad Squad uses

Forced View Setting

Indicates the type of Commercial used by the Ad Squad

Optimization Goal

Optimization goal

Story Ad Creative Type

Indicates the type of Creative used in Dynamic Story Ads

Placement V2

Placement V2

Targeting Auto Expansion Custom Audiences

Targeting - Expands targeting based on selected custom audiences

Targeting Regulated Content

Targeting - Flag to mark content within the Ad Squad as Regulated Content

Targeting Device Targets

Targeting - List of Device Targets

Targeting Interest Targets

Targeting - List of Interest Targets

Targeting Demographic Targets

Targeting - List of Demographic Targets

Targeting Geo/Location Targets

Targeting - List of Geo/Location Targets

Targeting Customer List segment targets

Targeting specification - List of Customer List segment targets

Targeting Targeting Expansion

Targeting Allowed Targeting to Expand

Targeting Auto Expansion Interest

Targeting Expands targeting based on interest targeting

Ad Squad Type

Ad Squad Type

Cap and Exclusion Config

Frequency cap and exclusion configuration

Bid Strategy

Bidding strategy for this Ad Squad

ROAS Value

Desired ROAS used with the MIN_ROAS BidStrategy

Pixel ID

Pixel ID associated with the Ad Squad

Pacing Type

Type of pacing

Measurement Provider Names

Approved measurement provider

Reach and Frequency Status

Status of the reach and frequency booking

Delivery Constraint

Type of delivery

Reach Goal

Reach goal as specified in the Forecasting request

Impression Goal

Impression goal as specified in the Forecasting request

Event Sources

Snap App Id to be associated with the Ad Squad

SKAdNetwork Properties Status

SKAdNetwork enrollment status

Separated Types

Indicates if a targeting spec type has been separated into the new 'targeting_spec' entity

Updated At

Timestamp of when the campaign was last updated

Created At

Timestamp of when the campaign was created

Ads Type

Column Name

Description

ID

Unique ID for the Ad

Ad Squad ID

Unique ID for the Ad Squad

Campaign ID

Unique ID for the Campaign

Campaign Name

Name of the Campaign

Ad Account ID

Unique ID for the Ad Account

Creative ID

Unique ID for the Creative

Ad Name

Name of the Ad

Ad Review Status

Review status of the Ad

Ad Review Rejection Reasons

List of reasons for Ad rejection

Ad Status

Status of the Ad

Ad Type

Type of Ad

Delivery Status

Delivery status of the Ad

Deleted

Indicates whether the Ad has been deleted or not

Paying Advertiser Name

Name of the paying advertiser/political entity

Updated At

Timestamp of when the Ad was last updated

Created At

Timestamp of when the Ad was created

Creatives Report

Column Name

Description

ID

Unique ID for the Creative

Ad Account ID

Ad Account ID

Brand Name

Brand Name (max length: 32 characters)

Call to Action

Call to Action (Please refer to the Creative type to CTA mapping table)

Headline (displayed under brand name)

Headline (max length: 34 characters)

Allow Users to Share with Friends

Allow Users to Share with Friends (true (default), false)

Creative Name

Creative name (max length: 375 characters)

Top Snap Media ID

Top Snap Media ID

Top Snap Crop Position

Top Snap Crop Position (OPTIMIZED (default), MIDDLE, TOP, BOTTOM)

Creative Type

Creative Type (SNAP_AD, APP_INSTALL, WEB_VIEW, DEEP_LINK, AD_TO_LENS, AD_TO_CALL, AD_TO_MESSAGE, PREVIEW, COMPOSITE, LENS, LENS_WEB_VIEW, LENS_APP_INSTALL, LENS_DEEP_LINK, COLLECTION, LEAD_GENERATION)

Indicates whether Creative can be used as a Commercial

Indicates whether Creative can be used as a Commercial (FULL_DURATION, SIX_SECONDS, NONE)

ID of the preview creative

ID of the preview creative (Required for Story Ads)

Playback Type

Playback Type (AUTO_ADVANCING (default), LOOPING)

Type of Ad Product

Type of Ad Product (SNAP_AD (default), LENS, FILTER)

Profile ID

Contains the profile ID to be associated with the creative

Media Report

Column Name

Description

ID

Unique ID for the Media

Ad Account ID

Unique ID for the Ad Account

Name

Name of the Media

Download Link

URL to Media File

File Name

Name of the Media File

Visibility

Visibility of the Media

Image Metadata (height, width, image format)

Metadata of the Media (number, number, string)

Video Metadata (width, height, rotation, integrated loudness, true peak)

Metadata of the Media (number, number, string, number, number)

Media Status

Status of the Media

Type

Type of Media

Lens Package Metadata

Metadata for lens media created by Lens Studio

Updated At

Timestamp of when the Media was last updated

Created At

Timestamp of when the Media was created

Endpoints

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.