Skip to main content

Google Ads Component

Google Ads

Manage Google Ad and Local Ad campaigns

Component key: google-ads

Description​

Google Ads (formerly Google AdWords and Google AdWords Express) is an online advertising solution that businesses use to promote their products and services on Google Search, YouTube, and other sites across the web. Google Ads also allows advertisers to choose specific goals for their ads, like driving phone calls or website visits. With a Google Ads account, advertisers can customize their budgets and targeting, and start or stop their ads at any time.

This component allows you to add external conversions to Ads campaigns.

Google documents many common errors that will aid in troubleshooting.

Connections​

OAuth 2.0​

This component uses OAuth 2.0 to connect to the Google Ads API. To begin working with Google Ads you will need a Developer Token. You will also need to make note of the Customer ID of the Ads Manager account (the hyphenated number in the top-left corner of the Ads app).

Next, you will need to create a GCP OAuth 2.0 app. To create one you will need to ensure you have a Google Developer account. Then:

  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 your project
  6. On the sidebar, select Credentials.
  7. An OAuth 2.0 app includes a "Consent Screen" (the page that asks "Do you want to allow (Your Company) to access Google Drive on your behalf?"). Click CONFIGURE CONSENT SCREEN.
    1. Your app will be externally available to your customers, so choose a User Type of External.
    2. Fill out the OAuth consent screen with an app name (your company or product's name), support email, app logo, domain, etc.
    3. You can ignore domains for now.
    4. On the next page, add the https://www.googleapis.com/auth/adwords scope to your app.
    5. Enter some test users for your testing purposes. Your app will only work for those testing users until it is "verified" by Google. When you are ready for verification (they verify your privacy policy statement, etc), click PUBLISH APP on the OAuth consent screen. That'll allow your customers to authorize your integration to access their Google Drive.
  8. Once your "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 Prismatic's 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.
info

Make sure to publish your OAuth 2.0 app after you've tested it so users outside of your test users can authorize your integration to interact with Google Drive on their behalf.

Now that you have a Client ID and Client Secret, add Google Ads step to your integration in Prismatic. Open the Configuration Wizard Designer by clicking Configuration Wizard, select your Google Ads Connection and enter your client ID and secret.

Data Sources​

List Accessible Customers​

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

Data Source Payload​

{
  "result": [
    {
      "label": "Example Account - 123-456-7890",
      "key": "1234567890"
    }
  ]
}

List Accessible Sub Accounts​

Get a list of accessible Sub Accounts for the customer id provided. | key: listAccessibleSubAccounts | type: picklist

Data Source Payload​

{
  "result": [
    {
      "label": "Example Account - 123-456-7890",
      "key": "1234567890"
    }
  ]
}

Actions​

Account Reports​

Account Reports show the performance and metrics associated with the linked Local Services accounts of a Manager account. | key: accountReports

Confirm a pending customer client link | key: confirmClientLink

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

Output Example Payload​

{
  "data": {
    "resourceName": "customers/1111111111/customerClientLinks/2222222222~3333333333",
    "managerCustomerId": "1111111111",
    "clientCustomerId": "2222222222",
    "managerLinkId": "3333333333"
  }
}

Detailed Lead Reports​

Detailed Lead Reports show an in-depth view of leads associated with the linked Local Services accounts of a Manager account. | key: detailedLeadReports

Get Conversion Action​

Get Conversion Action | key: getConversionAction

Get Customer​

Get Customer | key: getCustomer

Invite User​

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

List Accessible Customers​

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

Output Example Payload​

{
  "data": {
    "resourceNames": [
      "customers/1234567890",
      "customers/5555555555"
    ]
  }
}

List Manager's Customers​

List all customers under a manager account | key: listCustomers

Output Example Payload​

{
  "data": {
    "results": {
      "results": [
        {
          "customerClient": {
            "resourceName": "customers/1234567890/customerClients/1234567890",
            "clientCustomer": "customers/1234567890",
            "id": "1234567890",
            "hidden": false,
            "level": "1"
          }
        },
        {
          "customerClient": {
            "resourceName": "customers/1234567890/customerClients/1234567890",
            "clientCustomer": "customers/1234567890",
            "id": "1234567890",
            "hidden": false,
            "level": "1"
          }
        }
      ],
      "nextPageToken": "CJL5XLT2PWDmIpGNGciABRnu",
      "fieldMask": "customerClient.resourceName,customerClient.clientCustomer,customerClient.id,customerClient.level,customerClient.hidden,customerClient.level"
    }
  }
}

Mutate Campaign​

Creates, updates, or removes campaigns as well as local services campaigns. Operation statuses are returned. | key: mutateCampaign

Mutate Campaign Criteria​

Creates, updates, or removes campaign criteria as well as local services campaign criterion. Operation statuses are returned. | key: mutateCampaignCriteria

Raw Request​

Send raw HTTP request to Google Ads | key: rawRequest

Search Ads​

Returns all rows that match the search query. You can query for local services resources: https://developers.google.com/google-ads/api/docs/campaigns/local-service-campaigns#local_services_resources | key: searchAdsLocalServices

Upload Call Conversions​

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

Output Example Payload​

{
  "data": {
    "partialFailureError": {
      "code": 123,
      "message": "string",
      "details": [
        {
          "@type": "string"
        }
      ]
    },
    "results": [
      {
        "callerId": "string",
        "callStartDateTime": "string",
        "conversionAction": "string",
        "conversionDateTime": "string"
      }
    ]
  }
}

Upload Click Conversions​

Upload offline click conversions into Google Ads in order to track ads that led to sales | key: uploadClickConversions

Output Example Payload​

{
  "data": {
    "partialFailureError": {
      "code": 123,
      "message": "string",
      "details": [
        {
          "@type": "string"
        }
      ]
    },
    "results": [
      {
        "callerId": "string",
        "callStartDateTime": "string",
        "conversionAction": "string",
        "conversionDateTime": "string"
      }
    ]
  }
}