AdWords U2 Release

msaniscalchi · msaniscalchi · commit 8d11de8437c8 · 2015-03-02T16:31:50.000-05:00
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,7 @@
+3.1.1 - 2/25/2015
+* Added new example for migrating to Upgraded URLS.
+* Updated examples to reference final URLs.
+
 3.1.0 - 2/17/2015
 * Added support for v201502 for the DoubleClick for Publishers Client Library.
 * Removing support for v201311, v201308, and v201306.
diff --git a/examples/adwords/v201406/advanced_operations/add_text_ad_with_upgraded_urls.py b/examples/adwords/v201406/advanced_operations/add_text_ad_with_upgraded_urls.py
@@ -16,9 +16,6 @@
 
 """This examples adds a text add that uses upgraded URLs.
 
-This will only work if your account is a test account or is whitelisted for this
-feature.
-
 The LoadFromStorage method is pulling credentials and properties from a
 "googleads.yaml" file. By default, it looks for this file in your home
 directory. For more information, see the "Caching authentication information"
@@ -49,7 +46,7 @@ def main(client, adgroup_id):
       'displayUrl': 'www.example.com',
       # Specify a tracking URL for 3rd party tracking provider. You may specify
       # one at customer, campaign, ad group, ad, criterion or feed item levels.
-      'trackingUrlTemplate': ('http://tracker.example.com/?cid={_season}'
+      'trackingUrlTemplate': ('http://tracker.example.com/?season={_season}'
                               '&promocode={_promocode}&u={lpurl}'),
       'urlCustomParameters': {
           'parameters': [
diff --git a/examples/adwords/v201409/advanced_operations/add_ad_customizer.py b/examples/adwords/v201409/advanced_operations/add_ad_customizer.py
@@ -216,7 +216,7 @@ def main(client, adgroups):
       'headline': 'Luxury Cruise to {=%s.Name}' % FEEDNAME,
       'description1': 'Only {=%s.Price}' % FEEDNAME,
       'description2': 'Offer ends in {=countdown(%s.Date)}!' % FEEDNAME,
-      'url': 'http://www.example.com',
+      'finalUrls': ['http://www.example.com'],
       'displayUrl': 'www.example.com'
   }
 
diff --git a/examples/adwords/v201409/advanced_operations/add_click_to_download_ad.py b/examples/adwords/v201409/advanced_operations/add_click_to_download_ad.py
@@ -80,8 +80,9 @@ def main(client, ad_group_id):
       'xsi_type': 'TemplateAd',
       'name': 'Ad for demo game',
       'templateId': '353',
-      'url': ('http://play.google.com/store/apps/details?'
-              'id=com.example.demogame'),
+      'finalUrls': [
+          'http://play.google.com/store/apps/details?id=com.example.demogame'
+      ],
       'displayUrl': 'play.google.com',
       'templateElements': [ad_data]
   }
@@ -102,7 +103,7 @@ def main(client, ad_group_id):
   if 'value' in ads:
     for ad in ads['value']:
       print ('Added new click-to-download ad to ad group ID \'%s\' '
-             'with URL \'%s\'.' % (ad['ad']['id'], ad['ad']['url']))
+             'with URL \'%s\'.' % (ad['ad']['id'], ad['ad']['finalUrls'][0]))
   else:
     print 'No ads were added.'
 
diff --git a/examples/adwords/v201409/advanced_operations/add_site_links.py b/examples/adwords/v201409/advanced_operations/add_site_links.py
@@ -38,7 +38,7 @@
 # https://developers.google.com/adwords/api/docs/appendix/placeholders.html
 PLACEHOLDER_SITELINKS = '1'
 PLACEHOLDER_FIELD_SITELINK_LINK_TEXT = '1'
-PLACEHOLDER_FIELD_SITELINK_LINK_URL = '2'
+PLACEHOLDER_FIELD_SITELINK_FINAL_URL = '5'
 PLACEHOLDER_FIELD_LINE_1_TEXT = '3'
 PLACEHOLDER_FIELD_LINE_2_TEXT = '4'
 
@@ -61,7 +61,7 @@ def main(client, campaign_id):
       'name': 'Feed For Site Links #%s' % uuid.uuid4(),
       'attributes': [
           {'type': 'STRING', 'name': 'Link Text'},
-          {'type': 'URL', 'name': 'Link URL'},
+          {'type': 'URL_LIST', 'name': 'Link Final URLs'},
           {'type': 'STRING', 'name': 'Line 1 Description'},
           {'type': 'STRING', 'name': 'Line 2 Description'}
       ]
@@ -70,21 +70,22 @@ def main(client, campaign_id):
   response = feed_service.mutate([
       {'operator': 'ADD', 'operand': site_links_feed}
   ])
+
   if 'value' in response:
     feed = response['value'][0]
     link_text_feed_attribute_id = feed['attributes'][0]['id']
-    link_url_feed_attribute_id = feed['attributes'][1]['id']
+    final_url_feed_attribute_id = feed['attributes'][1]['id']
     line_1_feed_attribute_id = feed['attributes'][2]['id']
     line_2_feed_attribute_id = feed['attributes'][3]['id']
     print ('Feed with name \'%s\' and ID \'%s\' was added with' %
            (feed['name'], feed['id']))
-    print ('\tText attribute ID \'%s\' and URL attribute ID \'%s\'.' %
-           (link_text_feed_attribute_id, link_url_feed_attribute_id))
+    print ('\tText attribute ID \'%s\' and Final URL attribute ID \'%s\'.' %
+           (link_text_feed_attribute_id, final_url_feed_attribute_id))
     print ('\tLine 1 attribute ID \'%s\' and Line 2 attribute ID \'%s\'.' %
            (line_1_feed_attribute_id, line_2_feed_attribute_id))
     sitelinks_data['feedId'] = feed['id']
     sitelinks_data['linkTextFeedId'] = link_text_feed_attribute_id
-    sitelinks_data['linkUrlFeedId'] = link_url_feed_attribute_id
+    sitelinks_data['finalUrlFeedId'] = final_url_feed_attribute_id
     sitelinks_data['line1FeedId'] = line_1_feed_attribute_id
     sitelinks_data['line2FeedId'] = line_2_feed_attribute_id
   else:
@@ -116,7 +117,7 @@ def main(client, campaign_id):
                 'stringValue': item['text']
             },
             {
-                'feedAttributeId': sitelinks_data['linkUrlFeedId'],
+                'feedAttributeId': sitelinks_data['finalUrlFeedId'],
                 'stringValue': item['url']
             },
             {
@@ -164,10 +165,10 @@ def main(client, campaign_id):
               'feedAttributeId': sitelinks_data['linkTextFeedId'],
               'fieldId': PLACEHOLDER_FIELD_SITELINK_LINK_TEXT
           },
-          {
-              'feedAttributeId': sitelinks_data['linkUrlFeedId'],
-              'fieldId': PLACEHOLDER_FIELD_SITELINK_LINK_URL
-          },
+          #{
+          #    'feedAttributeId': sitelinks_data['finalUrlFeedId'],
+          #    'fieldId': PLACEHOLDER_FIELD_SITELINK_FINAL_URL
+          #},
           {
               'feedAttributeId': sitelinks_data['line1FeedId'],
               'fieldId': PLACEHOLDER_FIELD_LINE_1_TEXT
diff --git a/examples/adwords/v201409/advanced_operations/add_text_ad_with_upgraded_urls.py b/examples/adwords/v201409/advanced_operations/add_text_ad_with_upgraded_urls.py
@@ -14,10 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""This examples adds a text add that uses upgraded URLs.
-
-This will only work if your account is a test account or is whitelisted for this
-feature.
+"""This example adds a text add that uses advanced features of upgraded URLS.
 
 The LoadFromStorage method is pulling credentials and properties from a
 "googleads.yaml" file. By default, it looks for this file in your home
@@ -49,7 +46,7 @@ def main(client, adgroup_id):
       'displayUrl': 'www.example.com',
       # Specify a tracking URL for 3rd party tracking provider. You may specify
       # one at customer, campaign, ad group, ad, criterion or feed item levels.
-      'trackingUrlTemplate': ('http://tracker.example.com/?cid={_season}'
+      'trackingUrlTemplate': ('http://tracker.example.com/?season={_season}'
                               '&promocode={_promocode}&u={lpurl}'),
       'urlCustomParameters': {
           'parameters': [
diff --git a/examples/adwords/v201409/basic_operations/add_keywords.py b/examples/adwords/v201409/basic_operations/add_keywords.py
@@ -52,7 +52,9 @@ def main(client, ad_group_id):
       },
       # These fields are optional.
       'userStatus': 'PAUSED',
-      'destinationUrl': 'http://example.com/mars'
+      'finalUrls': {
+          'urls': ['http://example.com/mars']
+      }
   }
 
   keyword2 = {
diff --git a/examples/adwords/v201409/basic_operations/add_text_ads.py b/examples/adwords/v201409/basic_operations/add_text_ads.py
@@ -57,7 +57,7 @@ def main(client, ad_group_id):
               'adGroupId': ad_group_id,
               'ad': {
                   'xsi_type': 'TextAd',
-                  'url': 'http://www.example.com',
+                  'finalUrls': ['http://www.example.com'],
                   'displayUrl': 'example.com',
                   'description1': 'Visit the Red Planet in style.',
                   'description2': 'Low-gravity fun for everyone!',
@@ -74,7 +74,7 @@ def main(client, ad_group_id):
               'adGroupId': ad_group_id,
               'ad': {
                   'xsi_type': 'TextAd',
-                  'url': 'http://www.example.com',
+                  'finalUrls': ['http://www.example.com'],
                   'displayUrl': 'example.com',
                   'description1': 'Enjoy your stay at Red Planet.',
                   'description2': 'Buy your tickets now!',
diff --git a/examples/adwords/v201409/campaign_management/set_ad_parameters.py b/examples/adwords/v201409/campaign_management/set_ad_parameters.py
@@ -51,7 +51,9 @@ def main(client, ad_group_id, criterion_id):
           'adGroupId': ad_group_id,
           'ad': {
               'xsi_type': 'TextAd',
-              'url': 'http://www.example.com',
+              'finalUrls': {
+                  'urls': ['http://www.example.com']
+              },
               'displayUrl': 'example.com',
               'description1': 'Low-gravity fun for {param1:cheap}.',
               'description2': 'Only {param2:a few} seats left!',
diff --git a/examples/adwords/v201409/campaign_management/validate_text_ad.py b/examples/adwords/v201409/campaign_management/validate_text_ad.py
@@ -49,7 +49,9 @@ def main(client, ad_group_id):
           'adGroupId': ad_group_id,
           'ad': {
               'xsi_type': 'TextAd',
-              'url': 'http://www.example.com',
+              'finalUrls': {
+                  'urls': ['http://www.example.com']
+              },
               'displayUrl': 'example.com',
               'description1': 'Visit the Red Planet in style.',
               'description2': 'Low-gravity fun for everyone!',
diff --git a/examples/adwords/v201409/error_handling/handle_policy_violation_error.py b/examples/adwords/v201409/error_handling/handle_policy_violation_error.py
@@ -53,7 +53,7 @@ def main(client, ad_group_id):
               'headline': 'Mars Cruise!!!',
               'description1': 'Visit the Red Planet in style.',
               'description2': 'Low-gravity fun for everyone!',
-              'url': 'http://www.example.com',
+              'finalUrls': ['http://www.example.com'],
               'displayUrl': 'www.example.com',
           }
       }
diff --git a/examples/adwords/v201409/migration/__init__.py b/examples/adwords/v201409/migration/__init__.py
diff --git a/examples/adwords/v201409/migration/upgrade_ad_url.py b/examples/adwords/v201409/migration/upgrade_ad_url.py
@@ -0,0 +1,82 @@
+#!/usr/bin/python
+#
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""This example upgrades an ad to use upgraded URLs.
+
+The LoadFromStorage method is pulling credentials and properties from a
+"googleads.yaml" file. By default, it looks for this file in your home
+directory. For more information, see the "Caching authentication information"
+section of our README.
+
+Tags: AdGroupAdService.get, AdGroupAdService.upgradeUrl
+"""
+
+__author__ = 'Mark Saniscalchi'
+
+from googleads import adwords
+from googleads import errors
+
+
+ADGROUP_ID = 'INSERT_ADGROUP_ID_HERE'
+AD_ID = 'INSERT_AD_ID_HERE'
+
+
+def main(client, adgroup_id, ad_id):
+  # Initialize appropriate service.
+  adgroup_ad_service = client.GetService('AdGroupAdService', version='v201409')
+
+  selector = {
+      'fields': ['Id', 'Url'],
+      'predicates': [
+          {
+              'field': 'AdGroupId',
+              'operator': 'EQUALS',
+              'values': [adgroup_id]
+          },
+          {
+              'field': 'Id',
+              'operator': 'EQUALS',
+              'values': [ad_id]
+          }
+      ]
+  }
+
+  page = adgroup_ad_service.get(selector)
+
+  adgroup_ad = page['entries'][0] if page['entries'] else None
+
+  if not adgroup_ad:
+    raise errors.GoogleAdsError('Ad not found.')
+
+  ad_url_upgrade = {
+      'adId': adgroup_ad['ad']['id'],
+      'finalUrl': adgroup_ad['ad']['url']
+  }
+
+  adgroup_ad = adgroup_ad_service.upgradeUrl([ad_url_upgrade])[0]
+
+  if adgroup_ad:
+    print ('AdGroupAd with ID %s and destination URL \'%s\' was upgraded.'
+           % (adgroup_ad['id'], adgroup_ad['finalUrls'][0]))
+  else:
+    raise errors.GoogleAdsError('Failed to create AdGroupAd.')
+
+
+if __name__ == '__main__':
+  # Initialize client object.
+  adwords_client = adwords.AdWordsClient.LoadFromStorage()
+
+  main(adwords_client, ADGROUP_ID, AD_ID)
diff --git a/examples/adwords/v201409/reporting/download_criteria_report.py b/examples/adwords/v201409/reporting/download_criteria_report.py
@@ -49,7 +49,7 @@ def main(client):
       'downloadFormat': 'CSV',
       'selector': {
           'fields': ['CampaignId', 'AdGroupId', 'Id', 'CriteriaType',
-                     'Criteria', 'Impressions', 'Clicks', 'Cost']
+                     'Criteria', 'FinalUrls', 'Impressions', 'Clicks', 'Cost']
       },
       # Enable to get rows with zero impressions.
       'includeZeroImpressions': 'false'
diff --git a/examples/adwords/v201409/reporting/download_criteria_report_as_stream.py b/examples/adwords/v201409/reporting/download_criteria_report_as_stream.py
@@ -50,7 +50,7 @@ def main(client):
       'downloadFormat': 'CSV',
       'selector': {
           'fields': ['CampaignId', 'AdGroupId', 'Id', 'CriteriaType',
-                     'Criteria', 'Impressions', 'Clicks', 'Cost']
+                     'Criteria', 'FinalUrls', 'Impressions', 'Clicks', 'Cost']
       },
       # Enable to get rows with zero impressions.
       'includeZeroImpressions': 'false'
diff --git a/examples/adwords/v201409/reporting/download_criteria_report_as_stream_with_awql.py b/examples/adwords/v201409/reporting/download_criteria_report_as_stream_with_awql.py
@@ -51,7 +51,7 @@ def main(client):
 
   # Create report query.
   report_query = ('SELECT CampaignId, AdGroupId, Id, Criteria, CriteriaType, '
-                  'Impressions, Clicks, Cost '
+                  'FinalUrls', 'Impressions, Clicks, Cost '
                   'FROM CRITERIA_PERFORMANCE_REPORT '
                   'WHERE Status IN [ENABLED, PAUSED] '
                   'DURING LAST_7_DAYS')
diff --git a/examples/adwords/v201409/reporting/download_criteria_report_as_string.py b/examples/adwords/v201409/reporting/download_criteria_report_as_string.py
@@ -49,7 +49,7 @@ def main(client):
       'downloadFormat': 'CSV',
       'selector': {
           'fields': ['CampaignId', 'AdGroupId', 'Id', 'CriteriaType',
-                     'Criteria', 'Impressions', 'Clicks', 'Cost']
+                     'Criteria', 'FinalUrls', 'Impressions', 'Clicks', 'Cost']
       },
       # Enable to get rows with zero impressions.
       'includeZeroImpressions': 'false'
diff --git a/examples/adwords/v201409/reporting/download_criteria_report_as_string_with_awql.py b/examples/adwords/v201409/reporting/download_criteria_report_as_string_with_awql.py
@@ -43,7 +43,7 @@ def main(client):
 
   # Create report query.
   report_query = ('SELECT CampaignId, AdGroupId, Id, Criteria, CriteriaType, '
-                  'Impressions, Clicks, Cost '
+                  'FinalUrls', 'Impressions, Clicks, Cost '
                   'FROM CRITERIA_PERFORMANCE_REPORT '
                   'WHERE Status IN [ENABLED, PAUSED] '
                   'DURING LAST_7_DAYS')
diff --git a/examples/adwords/v201409/reporting/download_criteria_report_with_awql.py b/examples/adwords/v201409/reporting/download_criteria_report_with_awql.py
@@ -43,7 +43,7 @@ def main(client, path):
 
   # Create report query.
   report_query = ('SELECT CampaignId, AdGroupId, Id, Criteria, CriteriaType, '
-                  'Impressions, Clicks, Cost '
+                  'FinalUrls, Impressions, Clicks, Cost '
                   'FROM CRITERIA_PERFORMANCE_REPORT '
                   'WHERE Status IN [ENABLED, PAUSED] '
                   'DURING LAST_7_DAYS')
diff --git a/googleads/common.py b/googleads/common.py
@@ -28,7 +28,7 @@
 import googleads.errors
 import googleads.oauth2
 
-VERSION = '3.1.0'
+VERSION = '3.1.1'
 _COMMON_LIB_SIG = 'googleads/%s' % VERSION
 _PROXY_YAML_KEY = 'proxy_info'
 _PYTHON_VERSION = 'Python/%d.%d' % (sys.version_info[0], sys.version_info[1])

Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ def main(client, adgroups):`
`216`	`216`	`'headline': 'Luxury Cruise to {=%s.Name}' % FEEDNAME,`
`217`	`217`	`'description1': 'Only {=%s.Price}' % FEEDNAME,`
`218`	`218`	`'description2': 'Offer ends in {=countdown(%s.Date)}!' % FEEDNAME,`
`219`		`- 'url': 'http://www.example.com',`
	`219`	`+ 'finalUrls': ['http://www.example.com'],`
`220`	`220`	`'displayUrl': 'www.example.com'`
`221`	`221`	`}`
`222`	`222`