Google AdWords

The Google AdWords integration is managed at the Group level. When enabled, all calls made to Number and NumberPools will be uploaded to Google AdWords as an offline conversion. For more details on how to configure a Google AdWords conversion, please visit https://learn.telmetrics.com.

To configure AdWords for your Group, you will need to:

  • Authorize Telmetrics to post offline conversions via the Google AdWords API
  • Configure your Group to use Google AdWords

1. AdWords Authentication

Before posting conversions to Google Adwords, you will need to Authorize Telmetrics to post to AdWords via API. This configuration is completed via the Telmetrics Ordering Portal.

Log in to the Telmetrics Ordering Portal as an administrator user, and navigate to the 'Settings' menu. From the menu, select the 'Integrations' option:

354

From the 'Integrations' screen, connect 'Google AdWords'

618

On the Google AdWords Integration screen, click the 'Add Configuration Link:

380

This will open a modal, where you can provide a name for your AdWords Integration:

1658

Click the 'Authorize' button to initiate the authorization process with your Google AdWords account:

980

All integrations that are configured via the Telmetrics Ordering Portal can be retrieved via the following end-point:

GET https://api.telmetrics.com/v3/api/configurations/integrations

The resulting output will look something like:

[
    {
        "integration_auth_id": "da62a35b-b9af-4916-bbdc-bdbbecd59b04",
        "description": "ABC Company - AdWords Integration",
        "type": "AdWords",
        "created_datetime": "2018-05-14T12:53:40.307"
    }
 ]

The 'integration-auth_id' returned above, will be a required field when configuring an integration for your Group.

2. Configuring AdWords Integration

Your AdWords configuration is associated with a Group. Below are the fields used when configuring this integration:

FieldDescriptionRequiredPossible Values
typeThe type of Integration you want to createYesAdWords
integration_auth_idUnique id created when you authorize Telmetrics to post conversion on your behalfYesGUID
configuration -> customer_idGoogle AdWords Customer IDYesAn existing Google AdWords Customer Id
configuration -> phone_call_conversionConversion Name specified in Google AdWordsNoAn existing offline conversion configured within AdWords
configuration -> phone_call_conversion_valueMonetary value of a phone call conversionNoMonetary value of conversion
configuration -> sms_conversionConversion Name specified in Google AdWordsNoAn existing offline conversion configured within AdWords
configuration -> sms_conversion_valueMonetary value of an SMS conversionNoMonetary value of conversion
configuration -> currencyCurrency code that conversions should be uploaded asNo (default: USD)For more details visit:
Google AdWords Currency Codes

Below is an example of how to request a number using the criteria outlined above:
POST https://api.telmetrics.com/v3/api/groups/{group_id}/integrations

Remember when configuring an Integration, it must be assigned to a group.

{  
  "type": "AdWords",
  "integration_auth_id": "6932dfd8-4efb-492e-97e3-48daba7b8ed5",
  "configuration": {
    "currency": "USD",
    "customer_id": "840-918-5555",
    "phone_call_conversion": "Telmetrics Phone Call",
    "phone_call_conversion_value": 2.15,
    "sms_conversion": "Telmetrics SMS Conversation",
    "sms_conversion_value": 2.15
  }
}

This request will result in a response similar to the following:

{
    "type": "AdWords",
    "integration_id": "d889faef-b6cb-4daa-afab-f767673057b1",
    "integration_auth_id": "6932dfd8-4efb-492e-97e3-48daba7b8ed5",
    "group_id": 11623348,
    "created_datetime": "2018-05-14T17:05:09.7261789Z",
    "modified_datetime": "2018-05-14T17:05:09.7261789Z",
    "configuration": {
        "customer_id": "1234",
        "currency": "USD",
        "phone_call_conversion": "Telmetrics Phone Call",
        "phone_call_conversion_value": 2.15,
        "sms_conversion": "Telmetrics SMS Conversation",
        "sms_conversion_value": 2.15
    }
}

Note that the 'integration_id' returned by this request must be used for any subsequent updates.

3. Updating AdWords Integration

In the event that you need to update your AdWords Integration, you will need to submit your request to the following end-point:

POST {{webserviceurl}}/v3/api/groups/integrations/{integration_id}

{  
  "integration_auth_id": "6932dfd8-4efb-492e-97e3-48daba7b8ed5",
  "configuration": {
    "currency": "USD",
    "customer_id": "840-918-5555",
    "phone_call_conversion": "Telmetrics Phone Call",
    "phone_call_conversion_value": 3.15,
    "sms_conversion": "Telmetrics SMS Conversation",
    "sms_conversion_value": 3.15
  }
}

This request will result in a response similar to the following:

{
    "type": "AdWords",
    "integration_id": "d889faef-b6cb-4daa-afab-f767673057b1",
  "integration_auth_id": "6932dfd8-4efb-492e-97e3-48daba7b8ed5",
    "group_id": 11623348,
    "created_datetime": "2018-05-14T17:05:09.727",
    "modified_datetime": "2018-05-14T17:19:43.9688953Z",
    "configuration": {
    		"customer_id": "840-918-5555",
        "currency": "USD",
        "phone_call_conversion": "call name",
        "phone_call_conversion_value": 3.15,
        "sms_conversion": "sms name",
        "sms_conversion_value": 3.15
    }
}