actions/create-report/create-report.mjs
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/reference/rpc/v21/GoogleAdsService/Search?transport=rest)", version: "0.1.4", annotations: { destructiveHint: false, openWorldHint: true, readOnlyHint: false, }, 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/v21/${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/reference/rpc/v21/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/reference/rpc/v21/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, }; }, };
Chase Roberts@chsrbrts@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨@heyelliedayEvaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley@MBraedleyUpdate: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting@mrthomascuttingWant quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts@mattdotrobertsday 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭@auchenbergYahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑@raymondcamdenAwesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero@nachocaballeroI couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow@jyksnwDeveloped a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana@steven_terrana@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD@DotDotJamesWant to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin@AtinuxGitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul@raul_predescuIf you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc@bitfallsSo @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich@ZachLanichUm, wow 🤯 @pipedream
Steven Bell@bellontechI just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸@_jayhack_Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴♂️🌳@philsturgeonFor context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.