Skip to main content

Google Ads Component

Manage campaigns, conversions, customers, and local services in Google Ads.

Component key: google-ads ·
· Changelog ↓

Description​

Google Ads is an online advertising platform that allows businesses to create and manage ad campaigns across Google Search, YouTube, and partner websites. This component allows managing campaigns, uploading conversions, handling customer accounts, and working with Local Services ads in Google Ads.

API Documentation​

This component was built using the Google Ads API, currently utilizing v23 by default. Older versions (v21, v22) are supported by specifying the API Version in the connection.

EU Political Advertising Self-Declaration (v22+)​

When using API v22 or later, the containsEuPoliticalAdvertising field must be set when:

  • Creating new campaigns
  • Modifying location or proximity targeting on existing campaigns

This field is required and accepts one of the following values:

  • CONTAINS_EU_POLITICAL_ADVERTISING: Campaign contains EU political advertising.
  • DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING: Campaign does not contain EU political advertising.
  • UNSPECIFIED or UNKNOWN: Use when the value is unknown or indeterminate.

Failure to set this field will result in a FieldError.REQUIRED error from the API.

Google documents many common errors that will aid in troubleshooting.

Important Notes for v23​

Breaking changes from v22:

  • CallAd and CallAdInfo are removed — call ad creation and management must use alternative ad types
  • Campaign.start_date and Campaign.end_date are replaced by Campaign.start_date_time and Campaign.end_date_time
  • Campaign.url_expansion_opt_out is removed — URL expansion is now managed through AssetAutomationType settings
  • Video metrics are renamed: video_views becomes video_trueview_views, average_cpv becomes trueview_average_cpv, video_view_rate becomes video_trueview_view_rate

For full details, see the v23 release notes.

EU Political Advertising Self-Declaration (v22+): When using API v22 or later, the containsEuPoliticalAdvertising field must be set when:

  • Creating new campaigns
  • Modifying location or proximity targeting on existing campaigns

This field is required and accepts one of the following values:

  • CONTAINS_EU_POLITICAL_ADVERTISING - Campaign contains EU political advertising
  • DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING - Campaign does not contain EU political advertising
  • UNSPECIFIED or UNKNOWN - Use when the value is unknown or indeterminate

Failure to set this field will result in a FieldError.REQUIRED error from the API.

Version Compatibility​

The component supports multiple API versions through the apiVersion connection field:

  • v23 (recommended): Latest features and improvements
  • v22: Stable, sunset October 2026
  • v21: Stable, sunset August 2026
  • v20: Minimum supported, sunset June 2026

To use a specific version, set the apiVersion field when configuring the Google Ads connection. See the official deprecation and sunset schedule for the latest dates.

Connections​

Data Manager OAuth 2.0​

key: dataManagerOAuth

This connection uses OAuth 2.0 to connect to the Google Data Manager API. Use this connection for the Ingest Offline Conversions action. A Developer Token is not required for the Data Manager API.

Prerequisites​

  • A Google Developer account with permission to manage APIs and OAuth credentials
  • A Google Ads account that owns the conversion actions to ingest into
  • The numeric Customer ID of the Google Ads account that will receive the offline conversions (configured per-action, not on the connection)

Configure Google Cloud Project​

  1. Sign in to the Google Cloud Console and select or create a project.
  2. Select APIs & Services -> Enabled APIs & services from the left hand menu.
  3. Click Enable APIs and Services at the top of the screen.
  4. Search for "data manager api" and select Data Manager API in the results.
  5. Click the Enable button to add the API to the project.
  6. From the sidebar, select Credentials.
  7. An OAuth 2.0 app requires a "Consent Screen". Click CONFIGURE CONSENT SCREEN.
    1. The app will be externally available to customers, so choose a User Type of External.
    2. Fill out the OAuth consent screen with an app name, support email, app logo, and authorized domain.
    3. On the next page, add the https://www.googleapis.com/auth/datamanager scope to the app.
    4. Enter test users for testing purposes. The app will only work for those testing users until it is "verified" by Google. When ready for verification, click PUBLISH APP on the OAuth consent screen.
  8. Once the "Consent Screen" is configured, open the Credentials page from the sidebar again.
  9. Click +CREATE CREDENTIALS and select OAuth client ID.
    1. Under Application type select Web application.
    2. Under Authorized redirect URIs enter the OAuth 2.0 callback URL: https://oauth2.prismatic.io/callback
    3. Click CREATE.
  10. Take note of the Client ID and Client Secret that are generated.

Configure the Connection​

  • Client ID: From the Google Cloud Console OAuth client credentials
  • Client Secret: From the Google Cloud Console OAuth client credentials
  • API Version: The Google Data Manager API version to use. Defaults to v1. Refer to the Data Manager API reference for the latest version.

After entering the credentials, authorize the connection by signing in with the Google account that has access to the target Google Ads account.

No Developer Token

Unlike the standard Google Ads connection, the Data Manager API does not require a Developer Token. The developer-token header is not sent on requests made by this connection.

Supported API Versions​

The component supports the following Google Data Manager API versions through the API Version connection field:

VersionStatus
v1Recommended (default)

Refer to the official Data Manager API release notes for the latest version information.

App Verification​

Google requires OAuth apps that request access to user data to pass a verification review before being deployed at scale. This process ensures the app complies with Google's API Services User Data Policy, accurately represents its functionality, and handles user data responsibly.

Google OAuth apps pass through three stages before they are ready for production use.

Testing (unpublished): The app is only accessible to users manually added as test users in the OAuth consent screen. Up to 100 test users are allowed. All other users receive an error. This is the expected state during initial development.

Published, unverified: After publishing the app, all Google users can authenticate. However, for sensitive scopes, users see a "This app isn't verified" warning. Users can proceed by clicking Advanced -> Go to [app name] (unsafe), but this warning reduces trust and may be blocked by organizations with strict Google Workspace policies.

Verified: Google has reviewed and approved the app. No warning is shown. Verification is required before deploying to production users.

Publishing the App​

Publishing is required before any users outside the test list can authenticate:

  1. In the Google Cloud Console, navigate to APIs & Services -> OAuth consent screen
  2. Click PUBLISH APP and confirm

Requesting Verification​

The datamanager scope used by this connection is classified as sensitive by Google. Submitting for verification removes the "This app isn't verified" warning:

  1. On the OAuth consent screen, click Prepare for verification
  2. Provide a privacy policy URL, authorized domain, and app logo
  3. Submit for review. Google typically responds within several weeks.

Refer to Google's OAuth consent screen documentation for the full verification requirements.

Verify Connection​

Save the integration to authenticate. After authorizing, run the Ingest Offline Conversions action with Validate Only enabled to confirm the connection and payload are valid without ingesting live data.

InputNotesExample
API Version

The version of the Google Data Manager API to use. Defaults to v1. See API reference.

v1
Authorize URL

The OAuth 2.0 Authorization URL for the Google Data Manager API. See OAuth 2.0 documentation.

https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&prompt=consent
Client ID

The Client ID for the Google Data Manager API application. Obtain from the Google Cloud Console.

123456789012-abcdefghijklmnopqrstuvwxyz123456.apps.googleusercontent.com
Client Secret

The Client Secret for the Google Data Manager API application. Obtain from the Google Cloud Console.

GOCSPX-abcdefghijklmnopqrstuvwxyz
Scopes

Space-separated OAuth 2.0 permission scopes for the Google Data Manager API. See OAuth scopes documentation.

https://www.googleapis.com/auth/datamanager
Token URL

The OAuth 2.0 Token URL for the Google Data Manager API. See OAuth 2.0 documentation.

https://oauth2.googleapis.com/token

OAuth 2.0​

key: oauth

This component uses OAuth 2.0 to connect to the Google Ads API.

Prerequisites​

  • A Developer Token is required to work with Google Ads
  • The Customer ID of the Ads Manager account (the hyphenated number in the top-left corner of the Ads app) must be noted
  • A Google Developer account is required

Developer Token​

The Developer Token is obtained from a Google Ads Manager account:

  1. Sign in to Google Ads with the Google account that will be used for the integration
  2. Click Tools & Settings in the top right corner
  3. Under Setup, click API Center
  4. In the Developer token section, click Create token or view the existing token
  5. Copy and save the Developer Token value securely
  6. Take note of the Customer ID displayed in the top-right corner of Google Ads (XXX-XXX-XXXX). This will be needed when configuring the connection.

Configure Google Cloud Project​

  1. Access the project selector in the top-left and select an existing project or create a new one.
  2. Select APIs & Services -> Enabled APIs & services from the left hand menu
  3. Click Enable APIs and Services towards the top of the screen
  4. Search for "google ads api" and select Google Ads API in the results (avoid selecting AdWords as that is deprecated)
  5. Click the Enable button to add the API to the project
  6. On the sidebar, select Credentials.
  7. An OAuth 2.0 app includes a "Consent Screen". Click CONFIGURE CONSENT SCREEN.
    1. The app will be externally available to customers, so choose a User Type of External.
    2. Fill out the OAuth consent screen with an app name, support email, app logo, domain, etc.
    3. On the next page, add the https://www.googleapis.com/auth/adwords scope to the app.
    4. Enter some test users for testing purposes. The app will only work for those testing users until it is "verified" by Google. When ready for verification, click PUBLISH APP on the OAuth consent screen. That will allow customers to authorize the integration to access their Google Ads.
  8. Once the "Consent Screen" is configured, open the Credentials page from the sidebar again.
  9. Click +CREATE CREDENTIALS and select OAuth client ID.
    1. Under Application type select Web application.
    2. Under Authorized redirect URIs enter the OAuth 2.0 callback URL: https://oauth2.prismatic.io/callback
    3. Click CREATE.
  10. Take note of the Client ID and Client Secret that are generated.

Configure the Connection​

  • Client ID: From the Google Cloud Console OAuth client credentials
  • Client Secret: From the Google Cloud Console OAuth client credentials
  • Developer Token: From the Google Ads API Center
  • API Version: The Google Ads API version to use. Refer to the Google Ads API release notes for the latest version.

Supported API Versions​

The component supports multiple API versions through the API Version connection field:

VersionStatusTentative Sunset
v23Recommended (default)January 2027
v22StableOctober 2026
v21StableAugust 2026
v20StableJune 2026
v19SunsetFebruary 11, 2026

Sunset dates are tentative and subject to change. See the official deprecation and sunset schedule for the latest information.

After entering the credentials, authorize the connection by signing in with the Google account used to create the Developer Token and OAuth credentials.

App Verification​

Google requires OAuth apps that request access to user data to pass a verification review before being deployed at scale. This process ensures the app complies with Google's API Services User Data Policy, accurately represents its functionality, and handles user data responsibly.

Google OAuth apps pass through three stages before they are ready for production use.

Testing (unpublished): The app is only accessible to users manually added as test users in the OAuth consent screen. Up to 100 test users are allowed. All other users receive an error. This is the expected state during initial development.

Published, unverified: After publishing the app, all Google users can authenticate. However, for sensitive scopes, users see a "This app isn't verified" warning. Users can proceed by clicking Advanced → Go to [app name] (unsafe), but this warning reduces trust and may be blocked by organizations with strict Google Workspace policies.

Verified: Google has reviewed and approved the app. No warning is shown. Verification is required before deploying to production users.

Publishing the App​

Publishing is required before any users outside the test list can authenticate:

  1. In the Google Cloud Console, navigate to APIs & Services → OAuth consent screen
  2. Click PUBLISH APP and confirm

Requesting Verification​

The scopes used by this component are classified as sensitive by Google. Submitting for verification removes the "This app isn't verified" warning:

  1. On the OAuth consent screen, click Prepare for verification
  2. Provide a privacy policy URL, authorized domain, and app logo
  3. Submit for review. Google typically responds within several weeks

Refer to Google's OAuth consent screen documentation for the full verification requirements.

InputNotesExample
API Version

The version of the Google Ads API to use. Defaults to v23. Older versions (v21, v22) are supported by specifying the version explicitly. Note: v20 sunsets in June 2026. See API versions documentation.

v23
Authorize URL

The OAuth 2.0 Authorization URL for the Google Ads API. See OAuth 2.0 documentation.

https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&prompt=consent
Client ID

The Client ID for the Google Ads API application. Obtain from the Google Cloud Console.

123456789012-abcdefghijklmnopqrstuvwxyz123456.apps.googleusercontent.com
Client Secret

The Client Secret for the Google Ads API application. Obtain from the Google Cloud Console.

GOCSPX-abcdefghijklmnopqrstuvwxyz
Developer Token

The Developer Token for the Google Ads Manager account. Obtain from the Google Ads API Center.

ABcdeFGH93KL-NOPQ_RsTuv
Scopes

Space-separated OAuth 2.0 permission scopes for the Google Ads API. See OAuth scopes documentation.

https://www.googleapis.com/auth/adwords
Token URL

The OAuth 2.0 Token URL for the Google Ads API. See OAuth 2.0 documentation.

https://oauth2.googleapis.com/token

Triggers​

Account Change History​

Checks for Google Ads account modifications with user attribution on a configured schedule. | key: changeHistoryTrigger

InputNotesExample
Connection

The Google Ads connection to use.

Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Include User Info

When true, user email and client type will be included in change events.

true
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Resource Types

Types of resources to track changes for. Leave empty to track all resource types.

The Account Change History trigger checks for account modifications with user attribution on a configured schedule. Unlike the New and Updated Campaigns trigger which monitors only campaigns, this trigger captures changes across all resource types using the Google Ads Change Event API.

How It Works​

  1. Run on the configured schedule (e.g., every 15 minutes)
  2. Query the change_event resource for modifications since the last poll
  3. Return change details including what changed, who made the change, and when
  4. Update state with the current timestamp for the next poll

Configuration​

Required Inputs:

  • Connection - Google Ads OAuth2 connection
  • Customer ID - The Google Ads client account ID (format: 111-222-4444 or 1112224444)

Optional Inputs:

  • Manager Customer ID - Manager account ID when accessing sub-accounts
  • Resource Types - Filter for specific resource types:
    • CAMPAIGN, CAMPAIGN_BUDGET, CAMPAIGN_CRITERION
    • AD_GROUP, AD_GROUP_AD, AD_GROUP_CRITERION
    • ASSET, CUSTOMER, and more
    • Leave empty to monitor all resource types
  • Include User Info - Include user email and client type in results (default: true)

Returned Data​

The trigger returns an object containing change events and metadata. When no changes are detected, returns polledNoChanges: true.

View example response
{
  "data": {
    "changes": [
      {
        "changeEvent": {
          "resourceName": "customers/6577008345/changeEvents/1764141874897602~0~1",
          "changeDateTime": "2025-11-26 01:24:34.897602",
          "changeResourceType": "CAMPAIGN_BUDGET",
          "changeResourceName": "customers/6577008345/campaignBudgets/15170398017",
          "clientType": "GOOGLE_ADS_WEB_CLIENT",
          "userEmail": "user@example.com",
          "oldResource": {
            "campaignBudget": {}
          },
          "newResource": {
            "campaignBudget": {
              "resourceName": "customers/6577008345/campaignBudgets/15170398017",
              "amountMicros": "481350000"
            }
          },
          "resourceChangeOperation": "CREATE"
        }
      }
    ],
    "changeCount": 1,
    "timeRange": {
      "start": "2025-11-26 01:11:50",
      "end": "2025-11-26 01:30:17"
    }
  }
}
Example Payload for Account Change History⤓
Loading…

Campaign Budget Alerts​

Checks for campaigns approaching or exceeding budget thresholds on a configured schedule. | key: budgetAlertTrigger

InputNotesExample
Alert Threshold (%)

Budget spend percentage at which to trigger an alert.

80
Connection

The Google Ads connection to use.

Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Include Shared Budgets

When true, shared budgets across multiple campaigns will be monitored.

true
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890

The Campaign Budget Alerts trigger checks for campaigns approaching or exceeding budget thresholds on a configured schedule.

This trigger uses the Google Ads API Campaign resource to query campaign budget and cost data, calculating budget utilization in real-time.

How It Works​

  1. Run on the configured schedule (e.g., every 15 minutes)
  2. Query all enabled campaigns with their budget and cost metrics
  3. Calculate spending percentage, remaining budget, and severity level for each campaign
  4. Return only campaigns that exceed the alert threshold

Severity Levels​

Budget alerts are classified by severity:

  • Warning - Spending has reached or exceeded the alert threshold (default: 80%) but is below 100%
  • Critical - Spending has reached or exceeded 100% of the configured budget

Only campaigns with Warning or Critical severity are included in the results.

Configuration​

Required Inputs:

  • Connection - Google Ads OAuth2 connection
  • Customer ID - The Google Ads client account ID (format: 111-222-4444 or 1112224444)

Optional Inputs:

  • Manager Customer ID - Manager account ID when accessing sub-accounts
  • Alert Threshold - Percentage threshold for triggering alerts (default: 80)

Returned Data​

The trigger returns an object containing budget alerts and metadata. When no campaigns exceed the threshold, returns polledNoChanges: true.

View example response
{
  "data": {
    "alerts": [
      {
        "campaignId": "23302011123",
        "campaignName": "Example-Campaign-1",
        "budgetAmount": 100,
        "spent": 95,
        "percentSpent": 95,
        "remaining": 5,
        "period": "DAILY",
        "shouldAlert": true,
        "severity": "WARNING",
        "message": "Campaign approaching daily budget limit"
      }
    ],
    "totalCampaignsMonitored": 10,
    "alertThreshold": 80
  }
}
Example Payload for Campaign Budget Alerts⤓
Loading…

New and Updated Campaigns​

Checks for new and updated campaigns in a Google Ads account on a configured schedule. | key: campaignChangesTrigger

InputNotesExample
Change Types to Monitor

Types of campaign changes to detect. Leave empty to detect all change types.

Connection

The Google Ads connection to use.

Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890

The New and Updated Campaigns trigger checks for new and updated campaigns in a Google Ads account on a configured schedule. It monitors campaign properties including status, budget, bidding strategy, and settings by comparing the current state against the previous polling state.

This trigger uses the Google Ads API Campaign resource to query campaign data and performs client-side change detection between polling intervals.

How It Works​

  1. Run on the configured schedule (e.g., every 15 minutes)
  2. Query campaigns modified since the last poll using Google Ads Query Language
  3. Compare current campaign data against stored state to identify changes
  4. Categorize changes as "created", "updated", or "deleted"
  5. Update state with current campaign data for the next poll

Configuration​

Required Inputs:

  • Connection - Google Ads OAuth2 connection
  • Customer ID - The Google Ads client account ID (format: 111-222-4444 or 1112224444)

Optional Inputs:

  • Manager Customer ID - Manager account ID when accessing sub-accounts
  • Change Types to Monitor - Filter for specific change types:
    • Status Changes (enabled, paused, removed)
    • Budget Changes (amounts or assignments)
    • Bid Strategy Changes (strategies or amounts)
    • Campaign Settings (targeting, schedule, ad rotation)
    • Leave empty to detect all changes

Returned Data​

The trigger returns an object containing detected changes and metadata. When no changes are detected, returns polledNoChanges: true.

View example response
{
  "data": {
    "changes": [
      {
        "changeType": "created",
        "campaignId": "12345678901",
        "campaignName": "Example-Campaign-1",
        "field": "campaign",
        "oldValue": null,
        "newValue": {
          "campaign": {
            "resourceName": "customers/1234567890/campaigns/12345678901",
            "status": "ENABLED",
            "name": "Example-Campaign-1",
            "id": "12345678901"
          }
        },
        "changedAt": "2025-01-01T12:00:00.000Z"
      }
    ],
    "totalCampaigns": 1,
    "changesDetected": 1,
    "syncedAt": "2025-01-01"
  }
}
Example Payload for New and Updated Campaigns⤓
Loading…

Data Sources​

List Accessible Customers​

Get a list of accessible customers for the logged in user. | key: listAccessibleCustomers | type: picklist

InputNotesExample
Connection

The Google Ads connection to use.

Example Payload for List Accessible Customers⤓
Loading…

List Accessible Sub Accounts​

Get a list of accessible sub accounts for the customer ID provided. | key: listAccessibleSubAccounts | type: picklist

InputNotesExample
Connection

The Google Ads connection to use.

Customer Client Level

The hierarchy depth level of the customer client to retrieve. Defaults to 1 (direct children only).

1
Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Example Payload for List Accessible Sub Accounts⤓
Loading…

Actions​

Confirms a pending customer client link. | key: confirmClientLink

InputNotesExample
Connection

The Google Ads connection to use.

Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Manager Link ID

The unique identifier of the manager link. See Customer manager link documentation.

1234567890
Example Payload for Confirm Client Link⤓
Loading…

Create an invitation to link a client account to a manager account. | key: createClientLink

InputNotesExample
Connection

The Google Ads connection to use.

Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Example Payload for Create Client Link⤓
Loading…

Get Account Reports​

Retrieve account reports showing performance and metrics for Local Services accounts linked to a Manager account. | key: accountReports

InputNotesExample
Connection

The Google Ads connection to use.

Customer IDs

The Google Ads customer IDs to filter the Local Services report. Leave empty to include all accessible customers.

End Date

The end date of the date range, inclusive. Format: MM-DD-YYYY.

12-31-2025
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Page Size

The maximum number of results to return per page.

100
Page Token

The pagination cursor from a previous request. Returned in previous page responses.

CJL5XLT2PWDmIpGNGciABRnu
Start Date

The start date of the date range, inclusive. Format: MM-DD-YYYY.

01-01-2025
Example Payload for Get Account Reports⤓
Loading…

Get Conversion Action​

Retrieve Conversion Action data for a customer account. | key: getConversionAction

InputNotesExample
Connection

The Google Ads connection to use.

Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Page Token

The pagination cursor from a previous request. Returned in previous page responses.

CJL5XLT2PWDmIpGNGciABRnu
Example Payload for Get Conversion Action⤓
Loading…

Get Customer​

Retrieve Customer data for a customer account. | key: getCustomer

InputNotesExample
Connection

The Google Ads connection to use.

Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Page Token

The pagination cursor from a previous request. Returned in previous page responses.

CJL5XLT2PWDmIpGNGciABRnu
Example Payload for Get Customer⤓
Loading…

Get Detailed Lead Reports​

Retrieve detailed lead reports providing an in-depth view of leads for Local Services accounts linked to a Manager account. | key: detailedLeadReports

InputNotesExample
Connection

The Google Ads connection to use.

Customer IDs

The Google Ads customer IDs to filter the Local Services report. Leave empty to include all accessible customers.

End Date

The end date of the date range, inclusive. Format: MM-DD-YYYY.

12-31-2025
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Page Size

The maximum number of results to return per page.

100
Page Token

The pagination cursor from a previous request. Returned in previous page responses.

CJL5XLT2PWDmIpGNGciABRnu
Start Date

The start date of the date range, inclusive. Format: MM-DD-YYYY.

01-01-2025
Example Payload for Get Detailed Lead Reports⤓
Loading…

Ingest Offline Conversions​

Import offline conversion events into Google Ads using the Data Manager API. | key: ingestOfflineConversions

InputNotesExample
Connection

The Google Ads connection to use.

Destinations

The array of destinations that describe where each event should be ingested. See Destination reference.

[
  {
    "operatingAccount": {
      "accountType": "GOOGLE_ADS",
      "accountId": "1234567890"
    },
    "productDestinationId": "987654321"
  }
]
Hash Encoding

The encoding format to select for hashed user data fields (such as email or phone). Required when userData fields are included in events.

HEX
Events

The array of conversion events to ingest (max 2000 per request). See Event resource.

[
  {
    "eventTimestamp": "2026-05-15T12:30:00Z",
    "transactionId": "ORDER-2026-00123",
    "adIdentifiers": {
      "gclid": "CjwKCAjw1234567890abcdefGHIJKLmnoPQRStuvwxyz"
    },
    "conversionValue": 149.99,
    "currency": "USD",
    "consent": {
      "adUserData": "CONSENT_GRANTED",
      "adPersonalization": "CONSENT_GRANTED"
    }
  }
]
Validate Only

When true, the request is validated but not executed. Only errors are returned, not results.

false
Example Payload for Ingest Offline Conversions⤓
Loading…

Invite User​

Invite a user by email to a customer. | key: inviteUser

InputNotesExample
Access Role

The access role to grant to the user. See Access roles documentation.

Connection

The Google Ads connection to use.

Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Email Address

The email address of the user to invite to the customer account.

john.doe@example.com
Example Payload for Invite User⤓
Loading…

List Accessible Customers​

Get a list of customers accessible to the logged in user. | key: listAccessibleCustomers

InputNotesExample
Connection

The Google Ads connection to use.

Example Payload for List Accessible Customers⤓
Loading…

List Customers by Manager​

List all customers under a manager account. | key: listCustomers

InputNotesExample
Connection

The Google Ads connection to use.

Fetch All

When true, automatically fetches all pages of results. When false, only the first page of results will be returned.

false
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Page Token

The pagination cursor from a previous request. Returned in previous page responses.

CJL5XLT2PWDmIpGNGciABRnu
Example Payload for List Customers by Manager⤓
Loading…

Mutate Campaign​

Creates, updates, or removes campaigns as well as local services campaigns. Operation statuses are returned. When using API v22+, the containsEuPoliticalAdvertising field is required for campaign creation and location targeting changes. | key: mutateCampaign

InputNotesExample
Connection

The Google Ads connection to use.

Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Operations

The list of operations to perform on individual campaigns. See Campaign operations documentation.

[
  {
    "updateMask": "status,name",
    "create": {
      "name": "Example Campaign",
      "advertisingChannelType": "SEARCH",
      "status": "PAUSED",
      "campaignBudget": "customers/1234567890/campaignBudgets/9876543210"
    },
    "update": {
      "resourceName": "customers/1234567890/campaigns/1122334455",
      "status": "ENABLED"
    },
    "remove": "customers/1234567890/campaigns/1122334455"
  }
]
Partial Failure

When true, successful operations will be carried out and invalid operations will return errors. When false, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to true. See Partial failure documentation.

false
Validate Only

When true, the request is validated but not executed. Only errors are returned, not results.

false
Example Payload for Mutate Campaign⤓
Loading…

Mutate Campaign Criteria​

Creates, updates, or removes campaign criteria as well as local services campaign criterion. Operation statuses are returned. When using API v22+, the containsEuPoliticalAdvertising field must be set on the parent campaign before modifying location or proximity targeting criteria. | key: mutateCampaignCriteria

InputNotesExample
Connection

The Google Ads connection to use.

Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Operations

The list of operations to perform on individual campaigns. See Campaign operations documentation.

[
  {
    "updateMask": "bidModifier",
    "create": {
      "campaign": "customers/1234567890/campaigns/1122334455",
      "location": {
        "geoTargetConstant": "geoTargetConstants/1014044"
      }
    },
    "update": {
      "resourceName": "customers/1234567890/campaignCriteria/1122334455~987654321",
      "bidModifier": 1.5
    },
    "remove": "customers/1234567890/campaignCriteria/1122334455~987654321"
  }
]
Partial Failure

When true, successful operations will be carried out and invalid operations will return errors. When false, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to true. See Partial failure documentation.

false
Validate Only

When true, the request is validated but not executed. Only errors are returned, not results.

false
Example Payload for Mutate Campaign Criteria⤓
Loading…

Raw Request​

Send raw HTTP request to Google Ads. | key: rawRequest

InputNotesExample
Connection

The Google Ads connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/v23/customers:listAccessibleCustomers), The base URL is already included (https://googleads.googleapis.com). For example, to connect to https://googleads.googleapis.com/v23/customers:listAccessibleCustomers, only /v23/customers:listAccessibleCustomers is entered in this field. Note: If using the Raw Request action, you must specify the API version in the path (e.g., /v23/) to override the connection default.

/v23/customers:listAccessibleCustomers
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false
Example Payload for Raw Request⤓
Loading…

Search Ads​

Returns rows matching a GAQL query against Local Services resources. | key: searchAdsLocalServices

InputNotesExample
Connection

The Google Ads connection to use.

Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Fetch All

When true, automatically fetches all pages of results. When false, only the first page of results will be returned.

false
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Page Token

The pagination cursor from a previous request. Returned in previous page responses.

CJL5XLT2PWDmIpGNGciABRnu
Query

Google Ads Query Language (GAQL) query string. See GAQL documentation.

SELECT campaign.id, campaign.status, campaign_budget.id, campaign_budget.period, campaign_budget.amount_micros, campaign_budget.type FROM campaign WHERE campaign.advertising_channel_type = 'LOCAL_SERVICES'
Return Total Results Count

When true, the total number of results that match the query ignoring the LIMIT clause will be included in the response. Default is false.

false
Example Payload for Search Ads⤓
Loading…

Upload Call Conversions​

Upload offline call conversions into Google Ads in order to track ads that led to sales. | key: uploadCallConversions

InputNotesExample
Connection

The Google Ads connection to use.

Conversions

The conversions that are being uploaded. See Click conversions documentation.

{
  "customVariables": [
    {
      "conversionCustomVariable": "string",
      "value": "string"
    }
  ],
  "consent": {
    "adUserData": "UNSPECIFIED | UNKNOWN | GRANTED | DENIED",
    "adPersonalization": "UNSPECIFIED | UNKNOWN | GRANTED | DENIED"
  },
  "callerId": "string",
  "callStartDateTime": "string",
  "conversionAction": "string",
  "conversionDateTime": "string",
  "conversionValue": 123,
  "currencyCode": "string"
}
Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Validate Only

When true, the request is validated but not executed. Only errors are returned, not results.

false
Example Payload for Upload Call Conversions⤓
Loading…

Upload Click Conversions​

Upload offline click conversions into Google Ads in order to track ads that led to sales. This action will stop working after June 15, 2026. Use Ingest Offline Conversions instead. | key: uploadClickConversions

InputNotesExample
Connection

The Google Ads connection to use.

Conversions

The conversions that are being uploaded. See Click conversions documentation.

[
  {
    "gbraid": "gbraid_identifier_string",
    "wbraid": "wbraid_identifier_string",
    "externalAttributionData": {
      "externalAttributionCredit": 0.75,
      "externalAttributionModel": "LINEAR"
    },
    "customVariables": [
      {
        "conversionCustomVariable": "customers/1234567890/conversionCustomVariables/11111",
        "value": "premium_tier"
      }
    ],
    "cartData": {
      "merchantId": "1234567",
      "feedCountryCode": "US",
      "feedLanguageCode": "EN",
      "localTransactionCost": 5.99,
      "items": [
        {
          "productId": "SKU-12345",
          "quantity": 2,
          "unitPrice": 49.99
        }
      ]
    },
    "userIdentifiers": [
      {
        "userIdentifierSource": "FIRST_PARTY",
        "hashedEmail": "a1159e9df3670d549d04524532629f5477ceb7deec9b45e47e8c009506ecb2c8",
        "hashedPhoneNumber": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
        "mobileId": "cdda802e-fb9c-47ad-0794d394c913",
        "thirdPartyUserId": "ext-user-98765",
        "addressInfo": {
          "hashedFirstName": "a8cfcd74832004951b4408cdb0a5dbcd8c7e52d43f7fe244bf720582e05241da",
          "hashedLastName": "2c624232cdd221771294dfbb310aca000a0df6ac8b166e8b32c4bdc2a5a5cc0a",
          "city": "San Francisco",
          "state": "CA",
          "countryCode": "US",
          "postalCode": "94105",
          "hashedStreetAddress": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35"
        }
      }
    ],
    "conversionEnvironment": "WEB",
    "consent": {
      "adUserData": "GRANTED",
      "adPersonalization": "GRANTED"
    },
    "gclid": "TeSter123.gClIdString_xYz",
    "conversionAction": "customers/1234567890/conversionActions/987654321",
    "conversionDateTime": "2026-01-15 10:30:00-05:00",
    "conversionValue": 149.99,
    "currencyCode": "USD",
    "orderId": "ORDER-2026-00123"
  }
]
Customer ID

The unique identifier for the Google Ads client account. Accepts hyphenated or number forms. See Customer ID documentation.

111-222-4444
Manager Customer ID

The unique identifier for the Google Ads Manager account. Accepts hyphenated or number forms. When used in conjunction with a sub account as the customer ID, this value is used as the 'login-customer-id' header for the HTTP request. See Customer ID documentation.

123-456-7890
Validate Only

When true, the request is validated but not executed. Only errors are returned, not results.

false
Example Payload for Upload Click Conversions⤓
Loading…

Changelog​

2026-05-22​

Added Ingest Offline Conversions action using the Google Ads Data Manager API to replace the deprecated Upload Click Conversions action, which will stop accepting requests after June 15, 2026.

This action uses a new dedicated Data Manager OAuth 2.0 connection, separate from the existing Google Ads OAuth connection:

  • No Developer Token required — the Data Manager API does not use the developer-token header
  • Configurable API version — defaults to v1
  • Scoped to the Data Manager API only — does not affect existing Google Ads OAuth connections

2026-05-11​

Raised minimum supported Google Ads API version from v20 to v21 ahead of v20's June 2026 sunset. Connections explicitly configured for v20 will be auto-upgraded to v21 by the existing validateApiVersion floor check.

2026-04-30​

Various modernizations and documentation updates

2026-03-31​

Various modernizations and documentation updates

2026-03-11​

Updated default Google Ads API version from v22 to v23 and raised minimum supported version from v19 to v20:

  • Default API version updated to v23 — default for all new connections, bringing support for Performance Max channel reporting, AI-powered audience definitions, and enhanced invoice granularity.
  • Minimum supported version raised to v20 — Google sunset v19 on February 11, 2026; connections configured with v19 will now fall back to v20.
  • Campaign date fields updated — trigger queries now use campaign.start_date_time and campaign.end_date_time (v23 replaces the previous start_date/end_date fields).
  • Existing integrations unaffected — connections using v20, v21, or v22 can continue using their configured version.
  • GAQL query review recommended — users with queries referencing CallAd, CallAdInfo, Campaign.url_expansion_opt_out, or the legacy video metric names (video_views, average_cpv, video_view_rate) should review these fields before upgrading, as they are removed or renamed in v23.

2025-12-15​

Updated default Google Ads API version to v22 with new EU Political Advertising requirements:

  • Default API version updated to v22 — applied to all new connections.
  • EU Political Advertising field required — campaign creation and location targeting now require the Contains EU Political Advertising field when using v22.
  • Existing integrations unaffected — connections can continue using v19, v20, or v21 by specifying the API Version connection field.

2025-06-09​

Added inline data sources for accessible customers and sub-accounts to enhance data selection capabilities