Syncing audiences from Snowflake to LinkedIn Ads

Set your Polytomic API key as an environment variable:

export POLYTOMIC_API_KEY=YOUR-API-TOKEN

This example covers six steps:

Create a Snowflake Connection.
Create a LinkedIn Ads Connection.
Create a model from a Snowflake query.
Inspect the available audiences in LinkedIn Ads.
Sync data into an existing LinkedIn Ads audience.
Create a new audience and populate it from Snowflake.

1. Create a Snowflake connection

The Snowflake instance must be reachable from Polytomic over the network. For details, see the Snowflake connection guide.

cURL

Python

Typescript

Go

     curl --request POST \
     --url https://app.polytomic.com/api/connections \
     --header "accept: application/json" \
     --header "content-type: application/json" \
     --header "X-Polytomic-Version: 2024-02-08"  \
     --header "Authorization: Bearer ${POLYTOMIC_API_KEY}" \
     -d '{
     "name": "Snowflake Connection",
     "type": "snowflake",
     "configuration": {
        "account": "uc193736182",
        "username": "user",
        "password": "secret",
        "dbname": "database"
        }
    }'

2. Create a LinkedIn Ads connection and select accounts

The following request creates a LinkedIn Ads Connection. See the LinkedIn Ads connection configuration for the required fields.

cURL

curl --request POST  \
     --url https://app.polytomic.com/api/connections \
     --header "accept: application/json"  \
     --header "content-type: application/json"  \
     --header "X-Polytomic-Version: 2024-02-08"   \
     --header "Authorization: Bearer ${POLYTOMIC_API_KEY}"  \
     -d '{"type":"linkedinads", "name":"LinkedIn Ads","configuration":{}}'

{
  "data": {
    "organization_id": "d63a93bd-dfbd-4431-9006-63eb445d30a4",
    "id": "34c27eb9-ec01-45d0-93f8-5b1deb1344c1",
    "name": "Ads Test",
    "configuration": {},
    "auth_url": "https://www.linkedin.com/oauth/v2/authorization?access_type=offline..."
  }
}

LinkedIn Ads Connections authenticate with OAuth. Open the URL returned in the auth_url field of the response to complete the flow.

OAuth redirection

By default, the API expects auth_url to open in a new browser window. Set the optional redirect_url parameter in the request body to change the redirect target.

A LinkedIn Ads Connection can pull data from multiple ad accounts. To choose which ones, fetch the available connection parameters, then update the account list on the Connection.

cURL

curl --request GET  \
     --url https://app.polytomic.com/api/connections/YOUR-LINKEDIN-CONNECTION-ID/parameter_values \
     --header "accept: application/json"  \
     --header "content-type: application/json"  \
     --header "X-Polytomic-Version: 2024-02-08"   \
     --header "Authorization: Bearer ${POLYTOMIC_API_KEY}"

{
  "data": {
 ...
  }
}

Use those values to update the Connection.

cURL

curl --request POST  \
     --url https://app.polytomic.com/api/connections/YOUR-LINKEDIN-CONNECTION-ID \
     --header "accept: application/json"  \
     --header "content-type: application/json"  \
     --header "X-Polytomic-Version: 2024-02-08"   \
     --header "Authorization: Bearer ${POLYTOMIC_API_KEY}"  \
     -d '{"type":"linkedinads", "name":"LinkedIn Ads","configuration":{"accounts":[]}}'

{
  "data": {
    "organization_id": "d63a93bd-dfbd-4431-9006-63eb445d30a4",
    "id": "34c27eb9-ec01-45d0-93f8-5b1deb1344c1",
    "name": "Ads Test",
    "configuration": {},
    "auth_url": "https://www.linkedin.com/oauth/v2/authorization?access_type=offline..."
  }
}

3. Create a Snowflake model

Create a model backed by a Snowflake query:

cURL

Python

Typescript

Go

curl --request POST  \
     --url https://app.polytomic.com/api/models \
     --header "accept: application/json"  \
     --header "content-type: application/json"  \
     --header "X-Polytomic-Version: 2024-02-08"  \
     --header "Authorization: Bearer ${POLYTOMIC_API_KEY}"  \
     -d '{
           "name": "Active Users",
            "configuration": {
               "query": "SELECT first_name, last_name, email FROM users",
            },
            "connection_id": "YOUR-SNOWFLAKE-CONNECTION-ID"
          }'

Enumerating model sources

For information about how to enumerate sources, see this example.

4. Inspect the available audiences

Retrieve the audiences available on a LinkedIn Ads Connection by listing the target objects for that Connection.

cURL

Python

Typescript

Go

curl --request GET  \
     --url https://app.polytomic.com/api/connections/YOUR-LINKEDIN-CONNECTION-ID/modelsync/targetobjects \
     --header "accept: application/json"  \
     --header "content-type: application/json"  \
     --header "X-Polytomic-Version: 2024-02-08"   \
     --header "Authorization: Bearer ${POLYTOMIC_API_KEY}"

{
	"target_creation": {
		"supported": true,
		"properties": [
			{
				"id": "account",
				"title": "LinkedIn Ads account ID",
				"enum": true
			},
			{
				"id": "type",
				"title": "Audience type",
				"enum": true
			},
			{
				"id": "name",
				"title": "Audience name",
				"enum": false
			}
		]
	},
	"data": [
		{
			"id": "512630692::urn:li:organization:28818517~company_audience.29728356",
			"name": "Company Audience: Polytomic-Created Company List",
			"modes": [
				{
					"id": "create",
					"requires_identity": false,
					"supports_target_filters": false,
					"supports_per_field_mode": false
				},
				{
					"id": "remove",
					"requires_identity": false,
					"supports_target_filters": false,
					"supports_per_field_mode": false
				}
			]
		}
	]
}

5. Sync into an existing audience

To write to an existing LinkedIn Ads audience, set the audience ID as the target object on the sync.

The following sync maps email, first_name, and last_name from the Snowflake model to the corresponding LinkedIn Ads fields. Add more entries to the fields array to sync additional columns.

cURL

curl --request POST  \
     --url https://app.polytomic.com/api/syncs \
     --header "accept: application/json"  \
     --header "content-type: application/json"  \
     --header "X-Polytomic-Version: 2024-02-08"  \
     --header "Authorization: Bearer ${POLYTOMIC_API_KEY}"  \
     -d '{
          "name": "Snowflake to LinkedIn AdsSync",
          "mode": "create",
          "identity": {
               "source": {
                    "field": "email",
                    "model_id": "YOUR-MODEL-ID"
               },
               "target": "Email",
               "function": "equality"
           },
          "fields": [
               {
                    "source": {
                         "field": "first_name",
                         "model_id": "YOUR-MODEL-ID"
                    },
                    "target": "FirstName"
               },
               {
                    "source": {
                         "field": "last_name",
                         "model_id": "YOUR-MODEL-ID"
                    },
                    "target": "LastName"
               }
          ],
          "schedule": {
               "frequency": "continuous"
          },
          "target": {
               "connection_id": "YOUR-LINKEDIN-CONNECTION-ID",
               "object": "YOUR-AUDIENCE-ID"
          }
     }'

6. Create a new audience and populate it

To write to a new audience, pass the audience’s creation properties in the target object of the sync request.

The required properties come from the target_creation section of the target objects list response.

 "target_creation": {
		"supported": true,
		"properties": [
			{
				"id": "account",
				"title": "LinkedIn Ads account ID",
				"enum": true
			},
			{
				"id": "type",
				"title": "Audience type",
				"enum": true
			},
			{
				"id": "name",
				"title": "Audience name",
				"enum": false
			}
		]
	}

The Step 4 response shows that LinkedIn Ads supports creating destinations and requires three properties:

account
type
name

Both account and type are marked "enum": true, so you can fetch their allowed values from the property values endpoint.

Fetching account returns the ad accounts enabled on the Connection:

cURL

curl --request GET  \
     --url https://app.polytomic.com/api/connections/YOUR-LINKEDIN-CONNECTION-ID/modelsync/targetobjects/properties/account \
     --header "accept: application/json"  \
     --header "content-type: application/json"  \
     --header "X-Polytomic-Version: 2024-02-08"   \
     --header "Authorization: Bearer ${POLYTOMIC_API_KEY}"

{
	"data": {
		"enum": false,
		"values": [
			{
				"value": "512630692::urn:li:organization:28818517",
				"label": "Polytomic Inc. (512630692)"
			}
		]
	}
}

Fetching type returns the supported audience types:

cURL

curl --request GET  \
     --url https://app.polytomic.com/api/connections/YOUR-LINKEDIN-CONNECTION-ID/modelsync/targetobjects/properties/type \
     --header "accept: application/json"  \
     --header "content-type: application/json"  \
     --header "X-Polytomic-Version: 2024-02-08"   \
     --header "Authorization: Bearer ${POLYTOMIC_API_KEY}"

{
	"data": {
		"enum": false,
		"values": [
			{
				"value": "company_audience",
				"label": "Company Audience"
			},
			{
				"value": "user_audience",
				"label": "User Audience"
			}
		]
	}
}

Instead of setting a target object, pass these properties as a create object on the target. For example:

"target": {
    "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "create": {
        "name": "New audience",
        "type": "user_audience",
        "account": "512630692::urn:li:organization:28818517"
    }
}

cURL

curl --request POST  \
     --url https://app.polytomic.com/api/syncs \
     --header "accept: application/json"  \
     --header "content-type: application/json"  \
     --header "X-Polytomic-Version: 2024-02-08"  \
     --header "Authorization: Bearer ${POLYTOMIC_API_KEY}"  \
     -d '{
          "name": "Snowflake to LinkedIn AdsSync",
          "mode": "create",
          "identity": {
               "source": {
                    "field": "email",
                    "model_id": "YOUR-MODEL-ID"
               },
               "target": "Email",
               "function": "equality"
           },
          "fields": [
               {
                    "source": {
                         "field": "first_name",
                         "model_id": "YOUR-MODEL-ID"
                    },
                    "target": "FirstName"
               },
               {
                    "source": {
                         "field": "last_name",
                         "model_id": "YOUR-MODEL-ID"
                    },
                    "target": "LastName"
               }
          ],
          "schedule": {
               "frequency": "continuous"
          },
          "target": {
              "connection_id": "YOUR-LINKEDIN-CONNECTION-ID",
              "create": {
                  "name": "New audience",
                  "type": "user_audience",
                  "account": "512630692::urn:li:organization:28818517"
              }
          }
     }'