Skip to content

Commit 349a1cf

Browse files
authored
Merge pull request #189710 from Clare-Zheng82/0222-Update_Google_AdWords_connector_docs
Update Google AdWords connector docs
2 parents 77aebc4 + 46147f3 commit 349a1cf

File tree

5 files changed

+99
-24
lines changed

5 files changed

+99
-24
lines changed

articles/data-factory/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1051,6 +1051,8 @@ items:
10511051
href: connector-troubleshoot-dynamics-dataverse.md
10521052
- name: FTP, SFTP, and HTTP
10531053
href: connector-troubleshoot-ftp-sftp-http.md
1054+
- name: Google AdWords
1055+
href: connector-troubleshoot-google-adwords.md
10541056
- name: Hive
10551057
href: connector-troubleshoot-hive.md
10561058
- name: Oracle

articles/data-factory/connector-google-adwords.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: data-factory
88
ms.subservice: data-movement
99
ms.topic: conceptual
1010
ms.custom: synapse
11-
ms.date: 09/09/2021
11+
ms.date: 02/24/2022
1212
---
1313

1414
# Copy data from Google AdWords using Azure Data Factory or Synapse Analytics
@@ -63,12 +63,18 @@ The following sections provide details about properties that are used to define
6363

6464
## Linked service properties
6565

66+
> [!Important]
67+
> Due to the sunset of Google AdWords API by **April 27, 2022**, the service has upgraded to the new Google Ads API. Please refer this [document](connector-troubleshoot-google-adwords.md#migrate-to-the-new-version-of-google-ads-api) for detailed migration steps and recommendations. Please make sure the migration to be done before **April 27, 2022**.
68+
6669
The following properties are supported for Google AdWords linked service:
6770

6871
| Property | Description | Required |
6972
|:--- |:--- |:--- |
7073
| type | The type property must be set to: **GoogleAdWords** | Yes |
74+
| connectionProperties | A group of properties that defines how to connect to Google AdWords. | Yes |
75+
| ***Under `connectionProperties`:*** | | |
7176
| clientCustomerID | The Client customer ID of the AdWords account that you want to fetch report data for. | Yes |
77+
| loginCustomerID | The customer ID of the Google AdWords manager account through which you want to fetch report data of specific customer.| No |
7278
| developerToken | The developer token associated with the manager account that you use to grant access to the AdWords API. You can choose to mark this field as a SecureString to store it securely, or store password in Azure Key Vault and let the copy activity pull from there when performing data copy - learn more from [Store credentials in Key Vault](store-credentials-in-key-vault.md). | Yes |
7379
| authenticationType | The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. <br/>Allowed values are: **ServiceAuthentication**, **UserAuthentication** | Yes |
7480
| refreshToken | The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication. You can choose to mark this field as a SecureString to store it securely, or store password in Azure Key Vault and let the copy activity pull from there when performing data copy - learn more from [Store credentials in Key Vault](store-credentials-in-key-vault.md). | No |
@@ -87,32 +93,34 @@ The following properties are supported for Google AdWords linked service:
8793
"properties": {
8894
"type": "GoogleAdWords",
8995
"typeProperties": {
90-
"clientCustomerID" : "<clientCustomerID>",
91-
"developerToken": {
92-
"type": "SecureString",
93-
"value": "<developerToken>"
94-
},
95-
"authenticationType" : "ServiceAuthentication",
96-
"refreshToken": {
97-
"type": "SecureString",
98-
"value": "<refreshToken>"
99-
},
100-
"clientId": {
101-
"type": "SecureString",
102-
"value": "<clientId>"
103-
},
104-
"clientSecret": {
105-
"type": "SecureString",
106-
"value": "<clientSecret>"
107-
},
108-
"email" : "<email>",
109-
"keyFilePath" : "<keyFilePath>",
110-
"trustedCertPath" : "<trustedCertPath>",
111-
"useSystemTrustStore" : true,
96+
"connectionProperties": {
97+
"clientCustomerID": "<clientCustomerID>",
98+
"loginCustomerID": "<loginCustomerID>",
99+
"developerToken": {
100+
"type": "SecureString",
101+
"value": "<developerToken>"
102+
},
103+
"authenticationType": "ServiceAuthentication",
104+
"refreshToken": {
105+
"type": "SecureString",
106+
"value": "<refreshToken>"
107+
},
108+
"clientId": {
109+
"type": "SecureString",
110+
"value": "<clientId>"
111+
},
112+
"clientSecret": {
113+
"type": "SecureString",
114+
"value": "<clientSecret>"
115+
},
116+
"email": "<email>",
117+
"keyFilePath": "<keyFilePath>",
118+
"trustedCertPath": "<trustedCertPath>",
119+
"useSystemTrustStore": true,
120+
}
112121
}
113122
}
114123
}
115-
116124
```
117125

118126
## Dataset properties
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: Troubleshoot the Google AdWords connector
3+
titleSuffix: Azure Data Factory & Azure Synapse
4+
description: Learn how to troubleshoot issues with the Google AdWords connector in Azure Data Factory and Azure Synapse Analytics.
5+
author: jianleishen
6+
ms.service: data-factory
7+
ms.subservice: data-movement
8+
ms.topic: troubleshooting
9+
ms.date: 02/23/2022
10+
ms.author: jianleishen
11+
ms.custom: has-adal-ref, synapse
12+
---
13+
14+
# Troubleshoot the Google AdWords connector in Azure Data Factory and Azure Synapse
15+
16+
[!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
17+
18+
This article provides suggestions to troubleshoot common problems with the Google AdWords connector in Azure Data Factory and Azure Synapse.
19+
20+
## Migrate to the new version of Google Ads API
21+
22+
- **Symptoms**
23+
24+
You see a hint on the Google AdWords linked service configuration page. It reminds you to upgrade your linked service to a newer version before the legacy API is deprecated by Google.
25+
26+
- **Cause**
27+
28+
Due to the sunset of Google AdWords API by **April 27, 2022**, you are recommended to migrate your existing linked service to the new version of Google Ads API before the date. Starting **April 27, 2022**, connection will start to fail because of the deprecation of Google AdWords API (see this [link](https://ads-developers.googleblog.com/2021/04/upgrade-to-google-ads-api-from-adwords.html)). Migration steps:
29+
30+
1. Open your Google AdWords connector linked service configuration page.
31+
2. Edit the linked service and choose the new API version (select **Google Ads**).
32+
33+
:::image type="content" source="media/connector-troubleshoot-guide/update-google-adwords-linked-service.png" alt-text="Screenshot of updating the linked service configuration for Google AdWords.":::
34+
35+
3. Apply the changes.
36+
37+
- **Known issues and recommendations**
38+
39+
1. The new Google Ads API doesn't provide a migration plan for below reports/tables:
40+
a. AD_CUSTOMIZERS_FEED_ITEM_REPORT
41+
b. CAMPAIGN_GROUP_PERFORMANCE_REPORT
42+
c. CAMPAIGN_NEGATIVE_KEYWORDS_PERFORMANCE_REPORT
43+
d. CAMPAIGN_NEGATIVE_LOCATIONS_REPORT
44+
e. CAMPAIGN_NEGATIVE_PLACEMENTS_PERFORMANCE_REPORT
45+
f. CREATIVE_CONVERSION_REPORT
46+
g. CRITERIA_PERFORMANCE_REPORT
47+
h. FINAL_URL_REPORT
48+
i. KEYWORDLESS_CATEGORY_REPORT
49+
j. MARKETPLACE_PERFORMANCE_REPORT
50+
k. TOP_CONTENT_PERFORMANCE_REPORT
51+
52+
2. The syntax for Google Ads query language is similar to AWQL from the AdWords API, but not identical. You can refer this [document](https://developers.google.com/google-ads/api/docs/migration/querying) for more details.
53+
54+
55+
## Next steps
56+
57+
For more troubleshooting help, try these resources:
58+
59+
- [Connector troubleshooting guide](connector-troubleshoot-guide.md)
60+
- [Data Factory blog](https://azure.microsoft.com/blog/tag/azure-data-factory/)
61+
- [Data Factory feature requests](/answers/topics/azure-data-factory.html)
62+
- [Azure videos](https://azure.microsoft.com/resources/videos/index/?sort=newest&services=data-factory)
63+
- [Microsoft Q&A page](/answers/topics/azure-data-factory.html)
64+
- [Stack Overflow forum for Data Factory](https://stackoverflow.com/questions/tagged/azure-data-factory)
65+
- [Twitter information about Data Factory](https://twitter.com/hashtag/DataFactory)
4.76 KB
Loading
45.7 KB
Loading

0 commit comments

Comments
 (0)