Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Snapchat Ads source in Nexla.
snapads_api.png

Snapchat Ads

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Snapchat Ads connector tile from the list of available connectors. Then, select the credential that will be used to connect to your Snapchat Ads account, and click Next; or, create a new Snapchat Ads credential for use in this flow.

  3. In Nexla, Snapchat Ads data sources can be created using pre-built endpoint templates, which expedite source setup for common Snapchat Ads endpoints. Each template is designed specifically for the corresponding Snapchat Ads endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Snapchat Ads sources can also be configured manually, allowing you to ingest data from Snapchat Ads endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Snapchat Ads endpoints. Each template is designed specifically for the corresponding Snapchat Ads endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get all Organizations

    This endpoint template retrieves all organizations from your Snapchat Ads account. Use this template when you need to retrieve information about organizations, including organization IDs, names, and other organization metadata.

    • This endpoint automatically retrieves all organizations from your Snapchat Ads account. No additional configuration is required beyond selecting this endpoint template.

    This endpoint returns all organizations from your Snapchat Ads account, including organization IDs, names, and other organization metadata. Use this endpoint to discover available organizations for use with other endpoints.

    For detailed information about organizations, API response structures, and available organization data, see the Snapchat Marketing API documentation.

    Get all Ad Accounts

    This endpoint template retrieves all ad accounts in an organization from your Snapchat Ads account. Use this template when you need to retrieve information about ad accounts, including ad account IDs, names, and other ad account metadata.

    • Enter the Organization ID in the Organization ID field. This should be the unique identifier of the organization whose ad accounts you want to retrieve. The Organization ID determines which organization's ad accounts will be retrieved. You can find the Organization ID by using the "Get all Organizations" endpoint. The endpoint uses next URL pagination to handle large datasets efficiently, returning up to 1000 records per page by default.

    This endpoint returns all ad accounts in an organization from your Snapchat Ads account, including ad account IDs, names, and other ad account metadata. The endpoint uses next URL pagination with paging.next_link to handle large datasets efficiently. Nexla will automatically follow the pagination links to fetch subsequent pages of data.

    The Organization ID can be found by using the "Get all Organizations" endpoint. For detailed information about ad accounts, API response structures, pagination, and available ad account data, see the Snapchat Marketing API documentation.

    Get Daily Measurement Stats

    This endpoint template fetches measurement stats for a campaign, ad, or ad account from your Snapchat Ads account. This template has granularity set to daily. Switch to advanced mode for customizing options.

    • Enter the Entity Type in the Entity Type field. This should be the type of entity for which you want to retrieve stats (e.g., campaigns, ads, adaccounts). The Entity Type determines which type of entity's stats will be retrieved.
    • Enter the Entity ID in the Entity ID field. This should be the unique identifier of the entity (campaign, ad, or ad account) for which you want to retrieve stats. The Entity ID determines which entity's stats will be retrieved.
    • Enter the Start Time in the Start Time field. This should be the start date and time for the stats period in ISO 8601 format (e.g., 2024-01-01T00:00:00Z). The Start Time determines the beginning of the stats period.
    • Enter the End Time in the End Time field. This should be the end date and time for the stats period in ISO 8601 format (e.g., 2024-01-31T23:59:59Z). The End Time determines the end of the stats period.

    This endpoint fetches measurement stats for a campaign, ad, or ad account from your Snapchat Ads account. The endpoint uses next URL pagination with paging.next_link to handle large datasets efficiently. Nexla will automatically follow the pagination links to fetch subsequent pages of data.

    This template has granularity set to daily. Switch to advanced mode for customizing options such as granularity, date ranges, and other measurement parameters. For detailed information about measurement stats, API response structures, pagination, and available stats data, see the Snapchat Marketing API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Snapchat Ads data sources can be manually configured to ingest data from any valid Snapchat Ads API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Snapchat Ads sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Snapchat Ads API from the Method pulldown menu. Snapchat Ads API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Snapchat Ads API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your Snapchat Ads endpoint (e.g., https://adsapi.snapchat.com/v1/me, https://adsapi.snapchat.com/v1/organizations). Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Snapchat Ads API endpoint URL should include the API base URL (https://adsapi.snapchat.com/v1/) and the resource path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Snapchat Ads API responses, use $.data[*] to extract all items from the data array, or $[*] to extract all items from the response array, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Snapchat Ads API response. Snapchat Ads API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. Snapchat Ads API may use different pagination mechanisms depending on the endpoint. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For incrementing page-based pagination, specify the page parameter name, page size parameter name, and starting page number.

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.