Create A Report with LinkedIn Ads API on New Chat from Microsoft Teams API

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

Trigger workflow on

New Chat from the Microsoft Teams 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 Microsoft Teams 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 Chat trigger
1. Connect your Microsoft Teams account
2. Configure Polling interval
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 Chat on Microsoft Teams

Description:Emit new event when a new chat is created

Version:0.0.7

Key:microsoft_teams-new-chat

View on GitHub

Microsoft Teams Overview#

The Microsoft Teams API on Pipedream allows you to automate tasks, streamline communication, and integrate with other services to enhance the functionality of Teams as a collaboration hub. With this API, you can send messages to channels, orchestrate complex workflows based on Teams events, and manage Teams' settings programmatically.

Trigger Code#

import base from "../common/base.mjs";

export default {
  ...base,
  key: "microsoft_teams-new-chat",
  name: "New Chat",
  description: "Emit new event when a new chat is created",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  methods: {
    ...base.methods,
    async getResources(lastCreated) {
      return this.getNewPaginatedResources(
        this.microsoftTeams.listChats,
        {},
        lastCreated,
      );
    },
    generateMeta(chat) {
      return {
        id: chat.id,
        summary: chat.topic ?? `Chat ID ${chat.id}`,
        ts: Date.parse(chat.createdDateTime),
      };
    },
  },
};

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
Microsoft Teams	`microsoftTeams`	`app`	This component uses the Microsoft Teams app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the YouTube API on this schedule

Trigger Authentication#

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

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

User.Reademailoffline_accessopenidprofileChat.ReadChat.ReadWriteChatMessage.SendChannel.ReadBasic.AllChannelMessage.Read.AllChannelMessage.SendTeam.ReadBasic.AllSchedule.Read.All

About Microsoft Teams#

Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.

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