Create A Report with LinkedIn Ads API on New or Modified Records from Airtable API

Pipedream makes it easy to connect APIs for LinkedIn Ads, Airtable and 2,400+ other apps remarkably fast.

Trigger workflow on

New or Modified Records from the Airtable API

Next, do this

Create A Report with the LinkedIn Ads API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Airtable trigger and LinkedIn Ads action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New or Modified Records trigger
1. Connect your Airtable account
2. Configure timer
3. Select a Base
4. Select a Table
5. Optional- Select one or more Field IDs
6. Optional- Configure Return Fields By Field ID
Configure the Create A Report action
1. Connect your LinkedIn Ads account
2. Select a Ad Account Id
3. Select a Pivot
4. Select a Time Granularity
5. Configure Date Range Start
6. Optional- Configure Date Range End
7. Optional- Configure Shares
8. Optional- Configure Campaigns
9. Optional- Configure Creatives
10. Optional- Configure Campaign Groups
11. Optional- Select one or more Accounts
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New or Modified Records on Airtable

Description:Emit new event for each new or modified record in a table

Version:0.0.8

Key:airtable_oauth-new-or-modified-records

View on GitHub

Airtable Overview#

Airtable (OAuth) API on Pipedream allows you to manipulate and leverage your Airtable data in a myriad of powerful ways. Sync data between Airtable and other apps, trigger workflows on updates, or process bulk data operations asynchronously. By using Airtable's structured databases with Pipedream's serverless platform, you can craft custom automation solutions, integrate with other services seamlessly, and streamline complex data processes.

Trigger Code#

import base from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";
import moment from "moment";

export default {
  ...base,
  name: "New or Modified Records",
  key: "airtable_oauth-new-or-modified-records",
  description: "Emit new event for each new or modified record in a table",
  version: "0.0.8",
  type: "source",
  props: {
    ...base.props,
    tableId: {
      propDefinition: [
        base.props.airtable,
        "tableId",
        ({ baseId }) => ({
          baseId,
        }),
      ],
      description: "The table ID to watch for changes.",
    },
    fieldIds: {
      propDefinition: [
        base.props.airtable,
        "sortFieldId",
        ({
          baseId, tableId,
        }) => ({
          baseId,
          tableId,
        }),
      ],
      type: "string[]",
      label: "Field IDs",
      description: "Identifiers of spedific fields/columns to watch for updates",
      withLabel: true,
    },
    returnFieldsByFieldId: {
      propDefinition: [
        base.props.airtable,
        "returnFieldsByFieldId",
      ],
    },
  },
  methods: {
    ...base.methods,
    _getFieldValues() {
      return this.db.get("fieldValues") || {};
    },
    _setFieldValues(fieldValues) {
      this.db.set("fieldValues", fieldValues);
    },
    updateFieldValues(newFieldValues, record) {
      const fieldKey = this.returnFieldsByFieldId
        ? "value"
        : "label";
      for (const fieldId of this.fieldIds) {
        newFieldValues[record.id] = {
          ...newFieldValues[record.id],
          [fieldId.value]: record.fields[fieldId[fieldKey]] || null,
        };
      }
      return newFieldValues;
    },
    isUpdated(fieldValues, fieldIds, record) {
      const fieldKey = this.returnFieldsByFieldId
        ? "value"
        : "label";
      for (const fieldId of fieldIds) {
        if (!record.fields[fieldId[fieldKey]]) {
          record.fields[fieldId[fieldKey]] = null;
        }
        if (fieldValues[record.id]
          && fieldValues[record.id][fieldId.value] !== undefined
          && record.fields[fieldId[fieldKey]] !== fieldValues[record.id][fieldId.value]
        ) {
          return true;
        }
      }
      return false;
    },
  },
  async run(event) {
    const {
      baseId,
      tableId,
      viewId,
    } = this;

    const lastTimestamp = this._getLastTimestamp();
    const fieldValues = this._getFieldValues();
    const isFirstRunWithFields = this.fieldIds && Object.keys(fieldValues).length === 0;
    const params = {
      returnFieldsByFieldId: this.returnFieldsByFieldId || false,
    };
    if (!isFirstRunWithFields) {
      params.filterByFormula = `LAST_MODIFIED_TIME() > "${lastTimestamp}"`;
    }

    const records = await this.airtable.listRecords({
      baseId,
      tableId,
      params,
    });

    if (!records.length) {
      console.log("No new or modified records.");
      return;
    }

    const metadata = {
      baseId,
      tableId,
      viewId,
    };

    let newRecords = 0, modifiedRecords = 0;
    let newFieldValues = {
      ...fieldValues,
    };
    for (const record of records) {
      if (this.fieldIds) {
        newFieldValues = this.updateFieldValues(newFieldValues, record);
      }
      if (!lastTimestamp || moment(record.createdTime) > moment(lastTimestamp)) {
        record.type = "new_record";
        newRecords++;
      } else {
        if (this.fieldIds
          && (!this.isUpdated(fieldValues, this.fieldIds, record) || isFirstRunWithFields)
        ) {
          continue;
        }
        record.type = "record_modified";
        modifiedRecords++;
      }

      record.metadata = metadata;

      this.$emit(record, {
        summary: `${record.type}: ${JSON.stringify(record.fields)}`,
        id: record.id,
        ts: Date.now(),
      });
    }
    this._setFieldValues(newFieldValues);
    console.log(`Emitted ${newRecords} new records(s) and ${modifiedRecords} modified record(s).`);

    // We keep track of the timestamp of the current invocation
    this.updateLastTimestamp(event);
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Airtable	`airtable`	`app`	This component uses the Airtable app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Base	`baseId`	`string`	Select a value from the drop down menu.
Table	`tableId`	`string`	Select a value from the drop down menu.
Field IDs	`fieldIds`	`string[]`	Select a value from the drop down menu.
Return Fields By Field ID	`returnFieldsByFieldId`	`boolean`	An optional boolean value that lets you return field objects where the key is the field id. This defaults to `false`, which returns field objects where the key is the field name.

Trigger Authentication#

Airtable uses OAuth authentication. When you connect your Airtable account, Pipedream will open a popup window where you can sign into Airtable and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Airtable API.

Pipedream requests the following authorization scopes when you connect your account:

data.records:readdata.records:writedata.recordComments:readdata.recordComments:writeschema.bases:readschema.bases:writewebhook:manageuser.email:read

About Airtable#

Airtable is a low-code platform to build next-gen apps. Move beyond rigid tools, operationalize your critical data, and reimagine workflows with AI.

Action#

Create A Report on LinkedIn Ads

Description:Queries the Analytics Finder to get analytics for the specified entity i.e company, account, campaign. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/ads-reporting#analytics-finder)

Version:0.0.4

Key:linkedin_ads-create-report

View on GitHub

LinkedIn Ads Overview#

The LinkedIn Ads API on Pipedream enables you to automate and integrate your LinkedIn advertising efforts with other services. Fetch campaign data, manage ad accounts, or automate ad creation and adjustments. With Pipedream, you can trigger workflows with HTTP requests, emails, and on a schedule, and connect to thousands of other apps with minimal effort.

Action Code#

/* eslint-disable no-unused-vars */
import common from "../common/report.mjs";

export default {
  ...common,
  key: "linkedin_ads-create-report",
  name: "Create A Report",
  description: "Queries the Analytics Finder to get analytics for the specified entity i.e company, account, campaign. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/ads-reporting#analytics-finder)",
  version: "0.0.4",
  type: "action",
  props: {
    ...common.props,
    adAccountId: {
      propDefinition: [
        common.props.app,
        "adAccountId",
      ],
    },
    pivot: {
      propDefinition: [
        common.props.app,
        "pivot",
      ],
    },
    timeGranularity: {
      propDefinition: [
        common.props.app,
        "timeGranularity",
      ],
    },
    dateRangeStart: {
      type: "string",
      label: "Date Range Start",
      description: "Represents the inclusive start time range of the analytics. If unset, it indicates an open range up to the end time. Should be in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2022-12-27.",
    },
    dateRangeEnd: {
      type: "string",
      label: "Date Range End",
      description: "Represents the inclusive end time range of the analytics. Must be after start time if it's present. If unset, it indicates an open range from start time to everything after. Should be in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2022-12-27.",
      optional: true,
    },
    shares: {
      type: "string[]",
      label: "Shares",
      description: "An [Array of Share URN](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/share-api). Required unless another facet is provided.",
      optional: true,
    },
    campaigns: {
      type: "string[]",
      label: "Campaigns",
      description: "An [Array of Sponsored Campaign URN](https://docs.microsoft.com/en-us/linkedin/shared/references/v2/ads/adcampaigns?context=linkedin/marketing/context). Required unless another facet is provided.",
      optional: true,
    },
    creatives: {
      type: "string[]",
      label: "Creatives",
      description: "An [Array of Sponsored Creative URN](https://docs.microsoft.com/en-us/linkedin/shared/references/v2/ads/adcreatives?context=linkedin/marketing/context). Required unless another facet is provided.",
      optional: true,
    },
    campaignGroups: {
      type: "string[]",
      label: "Campaign Groups",
      description: "An [Array of Campaign Group URN](https://docs.microsoft.com/en-us/linkedin/shared/references/v2/ads/adcampaigngroups?context=linkedin/marketing/context). Required unless another facet is provided.",
      optional: true,
    },
    accounts: {
      propDefinition: [
        common.props.app,
        "accounts",
        ({ adAccountId }) => ({
          adAccountId,
        }),
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      getDateRangeParam,
      getListParams,
      createReport,
      adAccountId,
      pivot,
      timeGranularity,
      dateRangeStart,
      dateRangeEnd,
      ...arrayProps
    } = this;

    const response = await createReport({
      $,
      params: {
        q: "analytics",
        pivot,
        timeGranularity,
        dateRange: getDateRangeParam(dateRangeStart, dateRangeEnd),
        ...getListParams(arrayProps),
      },
    });

    $.export("$summary", `Successfully retrieved analytics information with ${response.elements.length} elements.`);

    return response.elements;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
LinkedIn Ads	`app`	`app`	This component uses the LinkedIn Ads app.
Ad Account Id	`adAccountId`	`string`	Select a value from the drop down menu.
Pivot	`pivot`	`string`	Select a value from the drop down menu:`COMPANYACCOUNTSHARECAMPAIGNCREATIVECAMPAIGN_GROUPCONVERSIONCONVERSATION_NODECONVERSATION_NODE_OPTION_INDEXSERVING_LOCATIONCARD_INDEXMEMBER_COMPANY_SIZEMEMBER_INDUSTRYMEMBER_SENIORITYMEMBER_JOB_TITLEMEMBER_JOB_FUNCTIONMEMBER_COUNTRY_V2MEMBER_REGION_V2MEMBER_COMPANY`
Time Granularity	`timeGranularity`	`string`	Select a value from the drop down menu:`ALLDAILYMONTHLYYEARLY`
Date Range Start	`dateRangeStart`	`string`	Represents the inclusive start time range of the analytics. If unset, it indicates an open range up to the end time. Should be in the ISO 8601 format, e.g. 2022-12-27.
Date Range End	`dateRangeEnd`	`string`	Represents the inclusive end time range of the analytics. Must be after start time if it's present. If unset, it indicates an open range from start time to everything after. Should be in the ISO 8601 format, e.g. 2022-12-27.
Shares	`shares`	`string[]`	An Array of Share URN. Required unless another facet is provided.
Campaigns	`campaigns`	`string[]`	An Array of Sponsored Campaign URN. Required unless another facet is provided.
Creatives	`creatives`	`string[]`	An Array of Sponsored Creative URN. Required unless another facet is provided.
Campaign Groups	`campaignGroups`	`string[]`	An Array of Campaign Group URN. Required unless another facet is provided.
Accounts	`accounts`	`string[]`	Select a value from the drop down menu.

Action Authentication#

LinkedIn Ads uses OAuth authentication. When you connect your LinkedIn Ads account, Pipedream will open a popup window where you can sign into LinkedIn Ads and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any LinkedIn Ads API.

Pipedream requests the following authorization scopes when you connect your account:

r_ads_reportingrw_adsr_adsr_basicprofiler_marketing_leadgen_automationr_ads_leadgen_automationr_organization_adminrw_conversionsr_events