Merge pull request #263615 from Clare-Zheng82/0118-Update_Google_Ads_doc

v-ccolin · web-flow · commit e144964a7f6a · 2024-02-08T10:00:19.000Z
[Doc update] Update Google Ads doc and add TSG
diff --git a/articles/data-factory/.openpublishing.redirection.data-factory.json b/articles/data-factory/.openpublishing.redirection.data-factory.json
@@ -1073,7 +1073,7 @@
           },
           {
             "source_path_from_root": "/articles/data-factory/connector-troubleshoot-google-adwords.md",
-            "redirect_url": "/azure/data-factory/connector-google-adwords",
+            "redirect_url": "/azure/data-factory/connector-troubleshoot-google-ads",
             "redirect_document_id": false
           }          
     ]
diff --git a/articles/data-factory/TOC.yml b/articles/data-factory/TOC.yml
@@ -1229,6 +1229,9 @@ items:
       - name: FTP, SFTP, and HTTP
         href: connector-troubleshoot-ftp-sftp-http.md
         displayName: troubleshooting
+      - name: Google Ads
+        href: connector-troubleshoot-google-ads.md
+        displayName: troubleshooting      
       - name: Hive
         href: connector-troubleshoot-hive.md
         displayName: troubleshooting
diff --git a/articles/data-factory/connector-google-adwords.md b/articles/data-factory/connector-google-adwords.md
@@ -8,7 +8,7 @@ ms.service: data-factory
 ms.subservice: data-movement
 ms.topic: conceptual
 ms.custom: synapse
-ms.date: 12/22/2023
+ms.date: 01/18/2024
 ---
 
 # Copy data from Google Ads using Azure Data Factory or Synapse Analytics
@@ -19,7 +19,7 @@ ms.date: 12/22/2023
 This article outlines how to use the Copy Activity in an Azure Data Factory or Synapse Analytics pipeline to copy data from Google Ads. It builds on the [copy activity overview](copy-activity-overview.md) article that presents a general overview of copy activity.
 
 > [!Important]
-> It is highly recommended to [upgrade your Google Ads driver version](#upgrade-the-google-ads-driver-version).
+> Please kindly [upgrade your Google Ads driver version](#upgrade-the-google-ads-driver-version) before **February 18, 2024**. If not, connection will start to fail with an [error](connector-troubleshoot-google-ads.md#error-code-deprecatedgoogleadslegacydriverversion) because of the deprecation of the legacy driver.
 
 ## Supported capabilities
 
@@ -74,19 +74,24 @@ The following properties are supported for Google Ads linked service:
 | Property | Description | Required |
 |:--- |:--- |:--- |
 | type | The type property must be set to: **GoogleAdWords** | Yes |
-| googleAdsApiVersion | The Google Ads API version that you use. You can refer this [article](https://developers.google.com/google-ads/api/docs/release-notes) for API version information.|  Yes |
+| googleAdsApiVersion | The Google Ads API version that you use when you select the recommended driver version. You can refer this [article](https://developers.google.com/google-ads/api/docs/release-notes) for API version information.|  Yes |
 | clientCustomerID | The Client customer ID of the Ads account that you want to fetch report data for.  | Yes |
 | loginCustomerID | The customer ID of the Google Ads manager account through which you want to fetch report data of specific customer.| No |
 | developerToken | The developer token associated with the manager account that you use to grant access to the Ads 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 |
-| 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 |
+| authenticationType | The OAuth 2.0 authentication mechanism used for authentication. <br/>Allowed values are: **ServiceAuthentication**, **UserAuthentication**. <br/>ServiceAuthentication can only be used on self-hosted IR. | Yes |
+|*For **UserAuthentication***:|||
 | refreshToken | The refresh token obtained from Google for authorizing access to Ads 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 |
 | clientId | The client ID of the Google application used to acquire the refresh token. 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 |
 | clientSecret | The client secret of the google application used to acquire the refresh token. 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 |
+|*For **ServiceAuthentication***:|||
 | email | The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.  | No |
 | privateKey | The service private key that is used for ServiceAuthentication for recommended driver version and can only be used on self-hosted IR. 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 |
-| keyFilePath | The full path to the `.p12` or `.json` key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Specify this property when you use ServiceAuthentication for the legacy driver version. | No |
-| trustedCertPath | The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over TLS. This property can only be set when using TLS on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Specify this property when you use ServiceAuthentication for the legacy driver version. | No |
-| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. Specify this property when you use ServiceAuthentication for the legacy driver version. | No |
+|*For **ServiceAuthentication** using the legacy driver version*:|||
+| email | The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.  | No |
+| keyFilePath | The full path to the `.p12` or `.json` key file that is used to authenticate the service account email address and can only be used on self-hosted IR. | No |
+| trustedCertPath | The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over TLS. This property can only be set when using TLS on self-hosted IR. The default value is the cacerts.pem file installed with the IR. | No |
+| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | No |
+
 
 **Example:**
 
@@ -205,7 +210,7 @@ To upgrade your Google Ads driver version, you need update your linked service a
 
 ### Update the linked service configuration
 
-Create a new Google Ads linked service and configure it by referring to [Linked service properties](#linked-service-properties). 
+In **Edit linked service** page, select **Recommended** under **Driver version** and configure the linked service by referring to [Linked service properties](#linked-service-properties). 
 
 ### Migrate from SQL to GAQL
 
@@ -259,5 +264,60 @@ Here are the concrete examples of the field name conversion:
 | Segments | `DayOfWeek` | `segments.day_of_week` | 
 | Metrics | `VideoViews` | `metrics.video_views` | 
 
+
+## Upgrade Google AdWords connector to Google Ads connector 
+
+Upgrade your Google AdWords linked service to the latest Google Ads linked service following the steps below:
+
+1. Select **Recommended** as driver version to create a new Google Ads linked service and configure it by referring to [Linked service properties](connector-google-adwords.md#linked-service-properties). 
+1. Update your pipelines that refer to the legacy Google AdWords linked service. Considering that the Google Ads linked service only supports using query to copy data, so:
+    1. If your pipeline is directly retrieving data from the report of Google AdWords, find the corresponding resource name of Google Ads in the table below and use this [tool](https://developers.google.com/google-ads/api/fields/v15/overview_query_builder) to build the query.
+        
+        | Google AdWords report| Google Ads resource |
+        |---------| --------|
+        | ACCOUNT_PERFORMANCE_REPORT | customer |  
+        | AD_PERFORMANCE_REPORT | ad_group_ad |  
+        | ADGROUP_PERFORMANCE_REPORT | ad_group |  
+        | AGE_RANGE_PERFORMANCE_REPORT | age_range_view | 
+        | AUDIENCE_PERFORMANCE_REPORT | campaign_audience_view,ad_group_audience_view | 
+        | AUTOMATIC_PLACEMENTS_PERFORMANCE_REPORT | group_placement_view |  
+        | BID_GOAL_PERFORMANCE_REPORT | bidding_strategy | 
+        | BUDGET_PERFORMANCE_REPORT | campaign_budget |  
+        | CALL_METRICS_CALL_DETAILS_REPORT | call_view | 
+        | CAMPAIGN_AD_SCHEDULE_TARGET_REPORT | ad_schedule_view |  
+        | CAMPAIGN_CRITERIA_REPORT | campaign_criterion | 
+        | CAMPAIGN_PERFORMANCE_REPORT | campaign | 
+        | CAMPAIGN_SHARED_SET_REPORT | campaign_shared_set |  
+        | CAMPAIGN_LOCATION_TARGET_REPORT | location_view | 
+        | CLICK_PERFORMANCE_REPORT | click_view | 
+        | DISPLAY_KEYWORD_PERFORMANCE_REPORT | display_keyword_view | 
+        | DISPLAY_TOPICS_PERFORMANCE_REPORT | topic_view |  
+        | GENDER_PERFORMANCE_REPORT | gender_view |  
+        | GEO_PERFORMANCE_REPORT | geographic_view,user_location_view |  
+        | KEYWORDLESS_QUERY_REPORT | dynamic_search_ads_search_term_view | 
+        | KEYWORDS_PERFORMANCE_REPORT | keyword_view |  
+        | LABEL_REPORT | label |  
+        | LANDING_PAGE_REPORT | landing_page_view,expanded_landing_page_view | 
+        | PAID_ORGANIC_QUERY_REPORT | paid_organic_search_term_view |  
+        | PARENTAL_STATUS_PERFORMANCE_REPORT | parental_status_view |  
+        | PLACEHOLDER_FEED_ITEM_REPORT | feed_item,feed_item_target |  
+        | PLACEHOLDER_REPORT | feed_placeholder_view | 
+        | PLACEMENT_PERFORMANCE_REPORT | managed_placement_view | 
+        | PRODUCT_PARTITION_REPORT | product_group_view | 
+        | SEARCH_QUERY_PERFORMANCE_REPORT | search_term_view |  
+        | SHARED_SET_CRITERIA_REPORT | shared_criterion |  
+        | SHARED_SET_REPORT | shared_set |  
+        | SHOPPING_PERFORMANCE_REPORT | shopping_performance_view | 
+        | TOP_CONTENT_PERFORMANCE_REPORT | No longer available in the Google Ads API. | 
+        | URL_PERFORMANCE_REPORT | detail_placement_view |  
+        | USER_AD_DISTANCE_REPORT | distance_view |  
+        | VIDEO_PERFORMANCE_REPORT | video | 
+
+    1. If the pipeline is using query to retrieve data from Google AdWords, use [Query Migration tool](https://developers.google.com/google-ads/scripts/docs/reference/query-migration-tool) to translate the AWQL (AdWords Query Language) into GAQL (Google Ads Query Language). 
+
+1. Be aware that there are certain limitations with this upgrade: 
+    1. Not all report types from AWQL are supported in GAQL. 
+    1. Not all AWQL queries are cleanly translated to GAQL queries.  
+
 ## Related content
 For a list of data stores supported as sources and sinks by the copy activity, see [supported data stores](copy-activity-overview.md#supported-data-stores-and-formats).
diff --git a/articles/data-factory/connector-troubleshoot-google-ads.md b/articles/data-factory/connector-troubleshoot-google-ads.md
@@ -0,0 +1,47 @@
+---
+title: Troubleshoot the Google Ads connector
+titleSuffix: Azure Data Factory & Azure Synapse
+description: Learn how to troubleshoot issues with the Google Ads connector in Azure Data Factory and Azure Synapse Analytics. 
+author: jianleishen
+ms.service: data-factory
+ms.subservice: data-movement
+ms.topic: troubleshooting
+ms.date: 01/19/2024
+ms.author: jianleishen
+ms.custom: has-adal-ref, synapse
+---
+
+# Troubleshoot the Google Ads connector in Azure Data Factory and Azure Synapse
+
+[!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
+
+This article provides suggestions to troubleshoot common problems with the Google Ads connector in Azure Data Factory and Azure Synapse.
+
+## Error code: DeprecatedGoogleAdsLegacyDriverVersion 
+
+- **Message**: `The Google Ads connector’s legacy driver has been deprecated. To ensure your pipeline works, please upgrade the driver version of Google Ads linked service. Detailed instructions can be found in this documentation: https://learn.microsoft.com/azure/data-factory/connector-google-adwords?tabs=data-factory#upgrade-the-google-ads-driver-version`
+
+- **Cause**: Your pipeline is still running on a legacy Google Ads connector's driver.
+
+- **Resolution**: Upgrade your Google Ads linked service's driver version to the Recommended version. Refer to this [article](connector-google-adwords.md#upgrade-the-google-ads-driver-version).
+    
+
+## Error code: DeprecatedGoogleAdWordsOdbcConnector 
+
+- **Message**: `The Google AdWords connector has been deprecated. To ensure your pipeline works, please create a new Google Ads linked service. Detailed instructions can be found in this documentation: https://learn.microsoft.com/azure/data-factory/connector-google-adwords#upgrade-google-adwords-connector-to-google-ads-connector`
+
+- **Cause**: Your pipeline is still running on a deprecated Google AdWords connector. 
+
+- **Resolution**: Create a new Google Ads linked service. Refer to this [article](connector-google-adwords.md#upgrade-google-adwords-connector-to-google-ads-connector). 
+
+## Related content
+
+For more troubleshooting help, try these resources:
+
+- [Connector troubleshooting guide](connector-troubleshoot-guide.md)
+- [Data Factory blog](https://techcommunity.microsoft.com/t5/azure-data-factory-blog/bg-p/AzureDataFactoryBlog)
+- [Data Factory feature requests](/answers/topics/azure-data-factory.html)
+- [Azure videos](https://azure.microsoft.com/resources/videos/index/?sort=newest&services=data-factory)
+- [Microsoft Q&A page](/answers/topics/azure-data-factory.html)
+- [Stack Overflow forum for Data Factory](https://stackoverflow.com/questions/tagged/azure-data-factory)
+- [Twitter information about Data Factory](https://twitter.com/hashtag/DataFactory)

Original file line number	Diff line number	Diff line change
`@@ -1073,7 +1073,7 @@`
`1073`	`1073`	`},`
`1074`	`1074`	`{`
`1075`	`1075`	`"source_path_from_root": "/articles/data-factory/connector-troubleshoot-google-adwords.md",`
`1076`		`- "redirect_url": "/azure/data-factory/connector-google-adwords",`
	`1076`	`+ "redirect_url": "/azure/data-factory/connector-troubleshoot-google-ads",`
`1077`	`1077`	`"redirect_document_id": false`
`1078`	`1078`	`}`
`1079`	`1079`	`]`