Snapchat Extract
- DarkLight
Snapchat Extract
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
This article is specific to the following platforms - Snowflake - Redshift - BigQuery.
Snapchat Extract
The Snapchat Extract component calls the Snapchat API to retrieve and store data to be either referenced by an external table or loaded into a table, depending on the user's cloud data warehouse. Users can then transform their data with the Matillion ETL library of transformation components.
Using this component may return structured data that requires flattening. For help with flattening such data, we recommend using the Nested Data Load Component for Amazon Redshift and the Extract Nested Data Component for Snowflake or Google BigQuery.
Properties
Snowflake Properties | ||
|---|---|---|
| Property | Setting | Description |
| Name | String | A human-readable name for the component. |
| Data Source | Select | Select a data source. As noted above, once you have configured the Data Source property, one or more properties specific to that data source will become available to configure. These properties are not optional and must be configured. Please refer to the "Data Source Properties" table in this documentation for guidance with these additional properties. |
| OAuth | Select | Select an OAuth entry to authenticate this component. An OAuth entry must be set up in advance. To learn how to create and authorise a fresh OAuth entry, please read our Snapchat Authentication Guide. |
| Page Limit | Integer | Limit the number of pages to stage. |
| Location | Storage Location | Provide an S3 bucket path, GCS bucket path, or Azure Blob Storage path that will be used to store the data. Once on an S3 bucket, GCS bucket or Azure Blob, the data can be referenced by an external table. A folder will be created at this location with the same name as the Target Table. |
| Integration | Select | (GCP only) Choose your Google Cloud Storage Integration. Integrations are required to permit Snowflake to read data from and write to a Google Cloud Storage bucket. Integrations must be set up in advance of selecting them in Matillion ETL. To learn more about setting up a storage integration, read our Storage Integration Setup Guide. |
| Warehouse | Select | Choose a Snowflake warehouse that will run the load. |
| Database | Select | Choose a database to create the new table in. |
| Schema | Select | Select the table schema. The special value, [Environment Default], will use the schema defined in the environment. For more information on using multiple schemas, see this article. |
| Target Table | String | Provide a new table name. Warning: This table will be recreated and will drop any existing table of the same name. |
Redshift Properties | ||
|---|---|---|
| Property | Setting | Description |
| Name | String | A human-readable name for the component. |
| Data Source | Select | Select a data source. As noted above, once you have configured the Data Source property, one or more properties specific to that data source will become available to configure. These properties are not optional and must be configured. Please refer to the "Data Source Properties" table in this documentation for guidance with these additional properties. |
| OAuth | Select | Select an OAuth entry to authenticate this component. An OAuth entry must be set up in advance. To learn how to create and authorise a fresh OAuth entry, please read our Snapchat Authentication Guide. |
| Page Limit | Integer | Limit the number of pages to stage. |
| Location | Storage Location | Provide an S3 Bucket path that will be used to store the data. Once on an S3 bucket, the data can be referenced by an external table. A folder will be created at this location with the same name as the Target Table. |
| Type | Dropdown | Select between a standard table and an external table. |
| Standard Schema | Dropdown | Select the Redshift schema. The special value, [Environment Default], will use the schema defined in the Matillion ETL environment. |
| External Schema | Select | Select the table's external schema. To learn more about external schemas, please consult the 'Configuring The Matillion ETL Client' section of the Getting Started With Amazon Redshift Spectrum documentation. |
| Target Table | String | Provide a name for the external table to be used. Warning: This table will be recreated and will drop any existing table of the same name. |
BigQuery Properties | ||
|---|---|---|
| Property | Setting | Description |
| Name | String | A human-readable name for the component. |
| Data Source | Select | Select a data source. As noted above, once you have configured the Data Source property, one or more properties specific to that data source will become available to configure. These properties are not optional and must be configured. Please refer to the "Data Source Properties" table in this documentation for guidance with these additional properties. |
| OAuth | Select | Select an OAuth entry to authenticate this component. An OAuth entry must be set up in advance. To learn how to create and authorise a fresh OAuth entry, please read our Snapchat Authentication Guide. |
| Page Limit | Integer | Limit the number of pages to stage. |
| Table Type | Select | Select whether the table is Native (by default in BigQuery) or an external table. |
| Project | Select | Select the Google Bigquery project. The special value, [Environment Default], will use the project defined in the environment. For more information, refer to the BigQuery documentation. |
| Dataset | Select | Select the Google Bigquery dataset to load data into. The special value, [Environment Default], will use the dataset defined in the environment. For more information, refer to the BigQuery documentation. |
| Target Table | String | A name for the table. Warning: This table will be recreated and will drop any existing table of the same name. Only available when the table type is Native. |
| New Target Table | String | A name for the new external table. Only available when the table type is External. |
| Cloud Storage Staging Area | Cloud Storage Bucket | Specify the target Google Cloud Storage bucket to be used for staging the queried data. Users can either:
Only available when the table type is Native. |
| Location | Cloud Storage Bucket | Specify the target Google Cloud Storage bucket to be used for staging the queried data. Users can either:
|
| Load Options | Multiple Select | Clean Cloud Storage Files: Destroy staged files on Cloud Storage after loading data. Default is On. Cloud Storage File Prefix: Give staged file names a prefix of your choice. The default setting is an empty field. Recreate Target Table: Choose whether the component recreates its target table before the data load. If Off, the component will use an existing table or create one if it does not exist. Default is On. Use Grid Variable: Check this checkbox to use a grid variable. This box is unchecked by default. |
Data Source Properties
The following table lists any Data Source that requires a unique component property for configuration. If a Data Source is missing from this table, it does NOT have any unique component properties.
| Data Source | Property Name | Type | Description |
|---|---|---|---|
| Ad Accounts | Organization ID | String | The ID of the organization to retrieve. |
| Ad Squad Stats | Ad Squad ID | String | The ID of the Ad Squad to retrieve. |
| Ad Squads under a Campaign | Campaign ID | String | The ID of the Campaign to retrieve. |
| Ad Squads under an Ad Account | Ad Account ID | String | The Ad Account ID. |
| Ad Stats | Ad ID | String | The ID of the Ad to retrieve. |
| Ads under an Ad Account | Ad Account ID | String | The Ad Account ID. |
| Ads under an Ad Squad | Ad Squad ID | String | The ID of the Ad Squad to retrieve. |
| Audience Segments | Ad Account ID | String | The Ad Account ID. |
| Campaign Stats | Campaign ID | String | The ID of the Campaign to retrieve. |
| Campaigns | Ad Account ID | String | The Ad Account ID. |
| Creatives | Ad Account ID | String | Ad Account ID. |
| Funding Sources | Organization ID | String | The ID of the organization to retrieve. |
| Media | Ad Account ID | String | The Ad Account ID. |
| Organizations | With Ad Accounts | Select True or False | Select whether to include Ad Accounts. Default is "false". |
| Targeting Device - OS Version | OS Type | Select | Select the operating system type. Users can choose either "ANDROID" or "iOS". |
| Targeting Geolocation Metro | Country Code | String | Provide the ISO ALPHA-2 Country Code (lowercase). |
| Targeting Geolocation Region | Country Code | String | Provide the ISO ALPHA-2 Country Code (lowercase). |
| Targeting Interests Snap Lifestyle Categories By Country | Country Code | String | ISO ALPHA-2 Country Code (lowercase). |