View as Markdown
Google Ad Manager icon

Google Ad Manager ACTION

Create Report

Create a report in Google Ad Manager. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Ad Manager 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_ad_manager-create-report",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_ad_manager: { authProvisionId: "apn_xxxxxxx" },
    parent: "Parent Network",
    name: "Name",
  },
})

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
parent Parent Network string
The parent resource where this Report will be created. Format: networks/{networkCode}.
Required Dynamic
name Name string
Identifier. The resource name of the report. Report resource names have the form: networks/{networkCode}/reports/{reportId}.
Required
visibility Visibility string
The visibility of the report.
Required
displayName Display Name string
The display name of the report.
Optional
scheduleOptions Schedule Options object
The options for a scheduled report. See the documentation.
Optional
dimensions Dimensions string[]
The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.
Required
metrics Metrics string[]
The list of metrics to report on. If empty, the report will have no metrics.
Required
filters Filters string[]
The filters for this report. Each row must be formatted as a JSON object. See the documentation.
Optional
timeZone Time Zone string
The time zone the date range is defined in for this report. Defaults to publisher's time zone if not specified. Time zone in IANA format. Acceptable values depend on the report type. Publisher time zone is always accepted. Use America/Los_Angeles for pacific time, or Etc/UTC for UTC.
Optional
currencyCode Currency Code string
The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.
Optional
customDimensionKeyIds Custom Dimension Key IDs string[]
Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, customDimensionKeyIds[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.
Optional
lineItemCustomFieldIds Line Item Custom Field IDs string[]
Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, lineItemCustomFieldIds[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.
Optional
orderCustomFieldIds Order Custom Field IDs string[]
Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, orderCustomFieldIds[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.
Optional
creativeCustomFieldIds Creative Custom Field IDs string[]
Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creativeCustomFieldIds[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.
Optional
reportType Report Type string
The type of this report.
Required
timePeriodColumn Time Period Column string
Include a time period column to introduce comparison columns in the report for each generated period. For example, set to QUARTERS here to have a column for each quarter present in the primary date range. If PREVIOUS PERIOD is specified in Comparison Date Range, then each quarter column will also include comparison values for its relative previous quarter.
Optional
flags Flags string[]
List of flags for this report. Used to flag rows in a result set based on a set of defined filters. Each row must be formatted as a JSON object. See the documentation.
Optional
sorts Sorts string[]
Default sorts to apply to this report. Each row must be formatted as a JSON object. See the documentation.
Optional
dateRange Date Range Type string
The date range of this report.
Required
comparisonDateRange Comparison Date Range Type string
The comparison date range of this report. If unspecified, the report will not have any comparison metrics.
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_ad_manager-create-report
Version
0.0.2
App
Google Ad Manager
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes