View as Markdown
Google Ads icon

Google Ads ACTION

Create Report

Generates a report from your Google Ads data. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Ads account once, then configure and run Create Report from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "google_ads-create-report",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_ads: { authProvisionId: "apn_xxxxxxx" },
    accountId: "Use Google Ads As",
    customerClientId: "Managed Account",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Report inputs
Property Type Description
accountId Use Google Ads As string
The ID of an account of a customer directly accessible by the authenticated user. This is usually a Manager Account, used as login-customer-id (e.g., 1234567890). Use the List Account ID Options action to get the list of accessible accounts.
Required Dynamic
customerClientId Managed Account string
The ID of a customer client from the list of customers linked to the selected account (e.g., 1234567890). Use the List Customer Clients action to get the list of customer clients.
Optional Dynamic
resource Resource string
The resource to generate a report for.
Required
objectFilter Filter by Resources string[]
Google Ads resource IDs to limit the report to. Pass a string array of numeric IDs (e.g. ["1234567890", "9876543210"]). Omit to include all resources.
Optional Dynamic
dateRange Date Range string
Predefined Google Ads date range keyword (e.g. LAST_30_DAYS, THIS_MONTH). For a custom range, use CUSTOM with startDate and endDate in YYYY-MM-DD format (e.g. 2024-01-01, 2024-01-31).
Optional
startDate Start Date string
The start date in YYYY-MM-DD format (e.g. 2024-01-01). Only relevant if Date Range is set to CUSTOM.
Optional
endDate End Date string
The end date in YYYY-MM-DD format (e.g. 2024-01-31). Only relevant if Date Range is set to CUSTOM.
Optional
fields Fields string[]
Resource field names for the GAQL SELECT clause. Pass a string array (e.g. ["id", "name"] or ["campaign.id", "campaign.name"] for campaign reports).
Optional Dynamic
segments Segments string[]
Segment field names to include (e.g. ["date"] or ["segments.date"]). See the documentation here.
Optional Dynamic
metrics Metrics string[]
Metric field names to include (e.g. ["impressions", "clicks"] or ["metrics.impressions", "metrics.clicks"]). See the documentation here.
Optional Dynamic
orderBy Order By string
The field to order the results by
Optional Dynamic
direction Direction string
The direction to order the results by, if Order By is specified
Optional
limit Limit integer
The maximum number of results to return
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
google_ads-create-report
Version
0.3.0
App
Google Ads
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes