Set up the Openflow Connector for LinkedIn Ads¶
Note
The connector is subject to the Connector Terms.
This topic describes the steps to set up the Openflow Connector for LinkedIn Ads.
Prerequisites¶
Ensure that you have reviewed About Openflow Connector for LinkedIn Ads.
Ensure that you have set up Openflow.
Get the credentials¶
As a LinkedIn Ads user, perform the following tasks:
Optional: If you don’t have an ad account to run and manage campaigns, create one.
Ensure that the user account has at least a VIEWER role on the ad account.
Use the user account to apply for Advertising API access. For more information, see the Microsoft quick start.
Obtain a refresh token. Use
3-legged oAuth
and ther_ads_reporting
scope.Obtain the client ID, client secret from the LinkedIn Developer Portal. These credentials are available in the in the Auth tab in App Details.
Set up Snowflake account¶
As a Snowflake account administrator, perform the following tasks:
Create a new role or use an existing role.
Create a new Snowflake service user with the type as SERVICE.
Grant the Snowflake service user the role you created in the previous steps.
Configure with key-pair auth for the Snowflake SERVICE user from step 2.
Snowflake strongly recommends this step. Configure a secrets manager supported by Openflow, for example, AWS, Azure, and Hashicorp, and store the public and private keys in the secret store.
Note
If for any reason, you do not wish to use a secrets manager, then you are responsible for safeguarding the public key and private key files used for key-pair authentication according to the security policies of your organization.
Once the secrets manager is configured, determine how you will authenticate to it. On AWS, it’s recommended that you the EC2 instance role associated with Openflow as this way no other secrets have to be persisted.
In Openflow, configure a Parameter Provider associated with this Secrets Manager, from the hamburger menu in the upper right. Navigate to Controller Settings » Parameter Provider and then fetch your parameter values.
At this point all credentials can be referenced with the associated parameter paths and no sensitive values need to be persisted within Openflow.
If any other Snowflake users require access to the raw ingested documents and tables ingested by the connector (for example, for custom processing in Snowflake), then grant those users the role created in step 1.
Create a database and schema in Snowflake for the connector to store ingested data. Grant required Database privileges to the role created in the first step. Substitute the role placeholder with the actual value and use the following sql commands:
CREATE DATABASE linkedin_destination_db; CREATE SCHEMA linkedin_destination_db.linkedin_destination_schema; GRANT USAGE ON DATABASE linkedin_destination_db TO ROLE <linkedin_connector_role>; GRANT USAGE ON SCHEMA linkedin_destination_db.linkedin_destination_schema TO ROLE <linkedin_connector_role>; GRANT CREATE TABLE ON SCHEMA linkedin_destination_db.linkedin_destination_schema TO ROLE <linkedin_connector_role>;
Create a warehouse that will be used by the connector or use an existing one. Start with the smallest warehouse size, then experiment with size depending on the number of tables being replicated, and the amount of data transferred. Large table numbers typically scale better with multi-cluster warehouses, rather than larger warehouse sizes.
Ensure that the user with role used by the connector has the required privileges to use the warehouse. If that’s not the case then grant the required privileges to the role.
CREATE WAREHOUSE linkedin_connector_warehouse WITH WAREHOUSE_SIZE = 'X-Small'; GRANT USAGE ON WAREHOUSE linkedin_connector_warehouse TO ROLE <linkedin_connector_role>;
Set up the connector¶
As a data engineer, perform the following tasks to install and configure the connector:
Install the connector¶
Create a database and schema in Snowflake for the connector to store ingested data. Grant required Database privileges to the role created in the first step. Substitute the role placeholder with the actual value and use the following SQL commands:
CREATE DATABASE DESTINATION_DB; CREATE SCHEMA DESTINATION_DB.DESTINATION_SCHEMA; GRANT USAGE ON DATABASE DESTINATION_DB TO ROLE <CONNECTOR_ROLE>; GRANT USAGE ON SCHEMA DESTINATION_DB.DESTINATION_SCHEMA TO ROLE <CONNECTOR_ROLE>; GRANT CREATE TABLE ON SCHEMA DESTINATION_DB.DESTINATION_SCHEMA TO ROLE <CONNECTOR_ROLE>;
Navigate to the Openflow Overview page. In the Featured connectors section, select View more connectors.
On the Openflow connectors page, find the connector and select Add to runtime.
In the Select runtime dialog, select your runtime from the Available runtimes drop-down list.
Select Add.
Note
Before you install the connector, ensure that you have created a database and schema in Snowflake for the connector to store ingested data.
Authenticate to the deployment with your Snowflake account credentials and select Allow when prompted to allow the runtime application to access your Snowflake account. The connector installation process takes a few minutes to complete.
Authenticate to the runtime with your Snowflake account credentials.
The Openflow canvas appears with the connector process group added to it.
Configure the connector¶
Note
Each process group is responsible for fetching data for a single report configuration. To use multiple configurations on a regular schedule, create a separate process group for each report configuration.
Right-click on the imported process group and select Parameters.
Populate the required parameter values as described in Flow parameters.
Flow parameters¶
This section describes the flow parameters that you can configure based on the following parameter contexts:
Linkedin Ads Source Parameters: Used to establish connection with LinkedIn Ads API.
Linkedin Ads Destination Parameters: Used to establish connection with Snowflake.
- Linkedin Ads Ingestion Parameters: Contains all parameters from the other two parameter contexts and additional parameters specific to a given process group.
Because this parameter context contains ingestion-specific details, you must create new parameter contexts for each new report and process group.
Linkedin Ads Source Parameters¶
Parameter |
Description |
---|---|
Client ID |
The client ID of an application registered on LinkedIn |
Client Secret |
The client secret related to the client ID |
Refresh Token |
A user obtains the refresh token after the app registration process. They use it together with the client ID and the client secret to get an access token. |
Token Endpoint |
The token endpoint is obtained by a user during the app registration process |
Linkedin Ads Destination Parameters¶
Parameter |
Description |
---|---|
Destination Database |
The database where data will be persisted. It must already exist in Snowflake |
Destination Schema |
The schema where data will be persisted. It must already exist in Snowflake |
Snowflake Account Identifier |
Snowflake account name formatted as [organization-name]-[account-name] where data will be persisted |
Snowflake Authentication Strategy |
Strategy of authentication to Snowflake. Possible values: SNOWFLAKE_SESSION_TOKEN - when we are running flow on SPCS, KEY_PAIR when we want to setup access using private key |
Snowflake Private Key |
The RSA private key used for authentication. The RSA key must be formatted according to PKCS8 standards and have standard PEM headers and footers. Note that either Snowflake Private Key File or Snowflake Private Key must be defined |
Snowflake Private Key File |
The file that contains the RSA Private Key used for authentication to Snowflake, formatted according to PKCS8 standards and having standard PEM headers and footers. The header line starts with |
Snowflake Private Key Password |
The password associated with the Snowflake Private Key File |
Snowflake Role |
Snowflake Role used during query execution |
Snowflake Username |
User name used to connect to Snowflake instance |
Snowflake Warehouse |
Snowflake warehouse used to run queries |
Linkedin Ads Ingestion Parameters¶
The following table lists parameters that are not inherited from the other parameter contexts:
Parameter |
Description |
---|---|
Report Name |
The unique name of the report. It is uppercased and used as the destination table name. |
Start Date |
Time granularity of results. Possible values:
|
Conversion Window |
The timeframe for which data is refreshed during incremental load when It must be specified only when DAILY time granularity is chosen.
For other possible time granularities, such as The conversion window can be any number from 1 to 365. |
Metrics |
List of comma-separated metrics. Metrics are case-sensitive. For more information, see Reporting. The Up to 20 metrics can be specified, including the mandatory metrics. |
Pivots |
List of comma-separated pivots. The available pivots are as follows: The connector uses the Analytics Finder when zero or one pivot is specified, and switches to the Statistics Finder when two or three pivots are selected. You can use a maximum of three pivots. |
Shares |
List of comma-separated share IDs. This parameter can be used to filter results by share ID. |
Campaigns |
List of comma-separated campaign IDs. This parameter can be used to filter results by campaign ID. |
Campaign Groups |
List of comma-separated campaign group IDs. This parameter can be used to filter results by campaign group ID. |
Accounts |
List of comma-separated account IDs. This parameter can be used to filter results by account ID. |
Companies |
List of comma-separated company IDs. This parameter can be used to filter results by company ID. |
Destination Database |
The destination database in which the destination table is created. It must be created by the user. |
Destination Schema |
The destination schema in which the destination table is created. It must be created by the user. |
Note
You must specify at least one of the filters, that is shares, campaigns, campaign groups, accounts, or companies.
Run the flow¶
Right-click on the plane and select Enable all Controller Services.
- Right-click on the imported process group and select Start.
The connector starts the data ingestion.