← Google Ads

Create Report with Google Ads API

Pipedream makes it easy to connect APIs for Google Ads and 2,200+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Report with the Google Ads API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Report with the Google Ads API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create Report action
    1. Connect your Google Ads account
    2. Select a Use Google Ads As
    3. Optional- Select a Managed Account
    4. Select a Resource
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Report with Google Ads API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Google Ads
 
Try it
Create Report with Google Ads API on New Submission from Typeform API
Typeform + Google Ads
 
Try it
Create Report with Google Ads API on New Submission (Instant) from Jotform API
Jotform + Google Ads
 
Try it
Create Report with Google Ads API on New Scheduled Tasks from Pipedream API
Pipedream + Google Ads
 
Try it
Create Report with Google Ads API on npm Download Counts from npm API
npm + Google Ads
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Report on Google Ads
Description:Generates a report from your Google Ads data. [See the documentation](https://developers.google.com/google-ads/api/fields/v16/overview)
Version:0.1.0
Key:google_ads-create-report

Code

import common from "../common/common.mjs";
import { adGroup } from "../../common/resources/adGroup.mjs";
import { ad } from "../../common/resources/ad.mjs";
import { campaign } from "../../common/resources/campaign.mjs";
import { customer } from "../../common/resources/customer.mjs";
import { ConfigurationError } from "@pipedream/platform";
import { DATE_RANGE_OPTIONS } from "./common-constants.mjs";
import { checkPrefix } from "../../common/utils.mjs";

const RESOURCES = [
  adGroup,
  ad,
  campaign,
  customer,
];

export default {
  ...common,
  key: "google_ads-create-report",
  name: "Create Report",
  description: "Generates a report from your Google Ads data. [See the documentation](https://developers.google.com/google-ads/api/fields/v16/overview)",
  version: "0.1.0",
  type: "action",
  props: {
    ...common.props,
    resource: {
      type: "string",
      label: "Resource",
      description: "The resource to generate a report for.",
      options: RESOURCES.map((r) => r.resourceOption),
      reloadProps: true,
    },
  },
  additionalProps() {
    const resource = RESOURCES.find((r) => r.resourceOption.value === this.resource);
    if (!resource) throw new ConfigurationError("Select one of the available resources.");

    const {
      label, value,
    } = resource.resourceOption;

    return {
      docsAlert: {
        type: "alert",
        alertType: "info",
        content: `[See the documentation](https://developers.google.com/google-ads/api/fields/v16/${value}) for more information on available fields, segments and metrics.`,
      },
      objectFilter: {
        type: "string[]",
        label: `Filter by ${label}s`,
        description: `Select the ${label}s to generate a report for (or leave blank for all ${label}s)`,
        optional: true,
        useQuery: true,
        options: async ({
          query, prevContext: { nextPageToken: pageToken },
        }) => {
          const {
            accountId, customerClientId, resource,
          } = this;
          const {
            results, nextPageToken,
          } = await this.googleAds.listResources({
            accountId,
            customerClientId,
            resource,
            query,
            pageToken,
          });
          const options = results?.map?.((item) => this.getResourceOption(item, resource));
          return {
            options,
            context: {
              nextPageToken,
            },
          };
        },
      },
      dateRange: {
        type: "string",
        label: "Date Range",
        description: "Select a date range for the report",
        options: DATE_RANGE_OPTIONS,
        optional: true,
        reloadProps: true,
      },
      ...(this.dateRange === "CUSTOM" && {
        startDate: {
          type: "string",
          label: "Start Date",
          description: "The start date, in `YYYY-MM-DD` format",
        },
        endDate: {
          type: "string",
          label: "End Date",
          description: "The end date, in `YYYY-MM-DD` format",
        },
      }),
      fields: {
        type: "string[]",
        label: "Fields",
        description: "Select any fields you want to include in your report.",
        options: resource.fields,
        optional: true,
        reloadProps: true,
      },
      segments: {
        type: "string[]",
        label: "Segments",
        description: "Select any segments you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/fields/v16/segments)",
        options: resource.segments,
        default: [
          "segments.date",
        ],
        optional: true,
        reloadProps: true,
      },
      metrics: {
        type: "string[]",
        label: "Metrics",
        description: "Select any metrics you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/fields/v16/metrics)",
        options: resource.metrics,
        optional: true,
        reloadProps: true,
      },
      orderBy: {
        type: "string",
        label: "Order By",
        description: "The field to order the results by",
        optional: true,
        options: [
          this.fields,
          this.segments,
          this.metrics,
        ].filter((v) => v).flatMap((value) => {
          let returnValue = value;
          if (typeof value === "string") {
            try {
              returnValue = JSON.parse(value);
            } catch (err) {
              returnValue = value.split(",");
            }
          }
          return returnValue?.map?.((str) => str.trim());
        }),
      },
      direction: {
        type: "string",
        label: "Direction",
        description: "The direction to order the results by, if `Order By` is specified",
        optional: true,
        options: [
          {
            label: "Ascending",
            value: "ASC",
          },
          {
            label: "Descending",
            value: "DESC",
          },
        ],
        default: "ASC",
      },
      limit: {
        type: "integer",
        label: "Limit",
        description: "The maximum number of results to return",
        optional: true,
      },
    };
  },
  methods: {
    getResourceOption(item, resource) {
      let label, value;
      switch (resource) {
      case "campaign":
        label = item.campaign.name;
        value = item.campaign.id;
        break;

      case "customer":
        label = item.customer.descriptiveName;
        value = item.customer.id;
        break;

      case "ad_group":
        label = item.adGroup.name;
        value = item.adGroup.id;
        break;

      case "ad_group_ad":
        label = item.adGroupAd.ad.name;
        value = item.adGroupAd.ad.id;
        break;
      }

      return {
        label,
        value,
      };
    },
    buildQuery() {
      const {
        resource, fields, segments, metrics, limit, orderBy, direction, objectFilter, dateRange,
      } = this;

      const filteredSegments = dateRange
        ? segments
        : segments?.filter((i) => i !== "segments.date");

      const selection = [
        ...checkPrefix(fields, resource),
        ...checkPrefix(filteredSegments, "segments"),
        ...checkPrefix(metrics, "metrics"),
      ];

      if (!selection.length) {
        throw new ConfigurationError("Select at least one field, segment or metric.");
      }

      let query = `SELECT ${selection.join(", ")} FROM ${resource}`;
      if (objectFilter) {
        query += ` WHERE ${resource === "ad_group_ad"
          ? "ad_group_ad.ad"
          : resource}.id IN (${objectFilter.join?.(", ") ?? objectFilter})`;
      }
      if (dateRange) {
        const dateClause = dateRange === "CUSTOM"
          ? `BETWEEN '${this.startDate}' AND '${this.endDate}'`
          : `DURING ${dateRange}`;
        query += ` ${objectFilter
          ? "AND"
          : "WHERE"} segments.date ${dateClause}`;
      }

      if (orderBy && direction) {
        query += ` ORDER BY ${orderBy} ${direction}`;
      }
      if (limit) {
        query += ` LIMIT ${limit}`;
      }

      return query;
    },
  },
  async run({ $ }) {
    const query = this.buildQuery();
    const results = (await this.googleAds.createReport({
      $,
      accountId: this.accountId,
      customerClientId: this.customerClientId,
      data: {
        query,
      },
    })) ?? [];

    const { length } = results;

    $.export("$summary", `Successfully obtained ${length} result${length === 1
      ? ""
      : "s"}`);
    return {
      query,
      results,
    };
  },
};

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.
LabelPropTypeDescription
Google AdsgoogleAdsappThis component uses the Google Ads app.
Use Google Ads AsaccountIdstringSelect a value from the drop down menu.
Managed AccountcustomerClientIdstringSelect a value from the drop down menu.
ResourceresourcestringSelect a value from the drop down menu:{ "label": "Ad Group", "value": "ad_group" }{ "label": "Ad", "value": "ad_group_ad" }{ "label": "Campaign", "value": "campaign" }{ "label": "Customer", "value": "customer" }

Authentication

Google Ads uses OAuth authentication. When you connect your Google Ads account, Pipedream will open a popup window where you can sign into Google 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 Google Ads API.

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

emailprofilehttps://www.googleapis.com/auth/adwords

About Google Ads

Reach customers wherever they are. Show up at the right time and place across the vast Google Ads ecosystem.

More Ways to Use Google Ads

Triggers

New Campaign Created from the Google Ads API

Emit new event when a new campaign is created. See the documentation

 
Try it
New Lead Form Entry from the Google Ads API

Emit new event for new leads on a Lead Form. See the documentation

 
Try it

Actions

Add Contact to Customer List by Email with the Google Ads API

Adds a contact to a specific customer list in Google Ads. Lists typically update in 6 to 12 hours after operation. See the documentation

 
Try it
Create Customer List with the Google Ads API

Create a new customer list in Google Ads. See the documentation

 
Try it
Send Offline Conversion with the Google Ads API

Send an event from to Google Ads to track offline conversions. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,200+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.