-
Notifications
You must be signed in to change notification settings - Fork 480
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added add_prices.py feed extension example (#205)
* Added add_prices.py feed extension example * addressed review comments * updating indentation * updating indentation#2
- Loading branch information
Showing
1 changed file
with
169 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 1,169 @@ | ||
| #!/usr/bin/env python | ||
| # Copyright 2020 Google LLC | ||
| # | ||
| # 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 | ||
| # | ||
| # https://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 adds a price extension and associates it with an account. | ||
| Campaign targeting is also set using the specified campaign ID. To get | ||
| campaigns, run basic_operations/get_campaigns.py | ||
| """ | ||
|
|
||
|
|
||
| import argparse | ||
| import sys | ||
|
|
||
| from google.ads.google_ads.client import GoogleAdsClient | ||
| from google.ads.google_ads.errors import GoogleAdsException | ||
|
|
||
|
|
||
| def main(client, customer_id, campaign_id): | ||
| """The main method that creates all necessary entities for the example.""" | ||
| # Create the price extension feed item | ||
| price_feed_item = client.get_type('PriceFeedItem', version='v2') | ||
| price_feed_item.type = ( | ||
| client.get_type('PriceExtensionTypeEnum', version='v2').SERVICES) | ||
| # Optional: set price qualifier | ||
| price_feed_item.price_qualifier = ( | ||
| client.get_type('PriceExtensionPriceQualifierEnum').FROM) | ||
| price_feed_item.tracking_url_template.value = ( | ||
| 'http://tracker.example.com/?u={lpurl}') | ||
| price_feed_item.language_code.value = 'en' | ||
|
|
||
| # To create a price extension, at least three price offerings are needed. | ||
| price_extension_price_unit_enum = ( | ||
| client.get_type('PriceExtensionPriceUnitEnum')) | ||
| price_feed_item.price_offerings.extend([ | ||
| _create_price_offer(client, | ||
| 'Scrubs', | ||
| 'Body Scrub, Salt Scrub', | ||
| 60000000, # 60 USD | ||
| 'USD', | ||
| price_extension_price_unit_enum.PER_HOUR, | ||
| 'http://www.example.com/scrubs', | ||
| 'http://m.example.com/scrubs'), | ||
| _create_price_offer(client, | ||
| 'Hair Cuts', | ||
| 'Once a month', | ||
| 75000000, # 75 USD | ||
| 'USD', | ||
| price_extension_price_unit_enum.PER_MONTH, | ||
| 'http://www.example.com/haircuts', | ||
| 'http://m.example.com/haircuts'), | ||
| _create_price_offer(client, | ||
| 'Skin Care Package', | ||
| 'Four times a month', | ||
| 250000000, # 250 USD | ||
| 'USD', | ||
| price_extension_price_unit_enum.PER_MONTH, | ||
| 'http://www.example.com/skincarepackage') | ||
| ]) | ||
|
|
||
| # Create a customer extension setting using the previously created | ||
| # extension feed item. This associates the price extension to your | ||
| # account. | ||
| campaign_service = client.get_service('CampaignService', version='v2') | ||
| extension_feed_item_operation = ( | ||
| client.get_type('ExtensionFeedItemOperation', version='v2')) | ||
| extension_feed_item = extension_feed_item_operation.create | ||
| extension_feed_item.extension_type = ( | ||
| client.get_type('ExtensionTypeEnum').PRICE) | ||
| extension_feed_item.price_feed_item.CopyFrom(price_feed_item) | ||
| extension_feed_item.targeted_campaign.value = ( | ||
| campaign_service.campaign_path(customer_id, campaign_id)) | ||
| day_of_week_enum = client.get_type('DayOfWeekEnum', version='v2') | ||
| minute_of_hour_enum = client.get_type('MinuteOfHourEnum', version='v2') | ||
| extension_feed_item.ad_schedules.extend([ | ||
| _create_ad_schedule_info(client, | ||
| day_of_week_enum.SUNDAY, | ||
| 10, | ||
| minute_of_hour_enum.ZERO, | ||
| 18, | ||
| minute_of_hour_enum.ZERO), | ||
| _create_ad_schedule_info(client, | ||
| day_of_week_enum.SATURDAY, | ||
| 10, | ||
| minute_of_hour_enum.ZERO, | ||
| 22, | ||
| minute_of_hour_enum.ZERO) | ||
| ]) | ||
|
|
||
| # Add the extension | ||
| try: | ||
| feed_service = client.get_service('ExtensionFeedItemService', | ||
| version='v2') | ||
| # Issues a mutate request to add the customer extension setting and | ||
| # print its information. | ||
| feed_response = ( | ||
| feed_service.mutate_extension_feed_items(customer_id, | ||
| [extension_feed_item_operation]) | ||
| ) | ||
| except GoogleAdsException as ex: | ||
| print(f'Request with ID "{ex.request_id}" failed with status ' | ||
| f'"{ex.error.code().name}" and includes the following errors:') | ||
| for error in ex.failure.errors: | ||
| print(f'\tError with message "{error.message}".') | ||
| if error.location: | ||
| for field_path_element in error.location.field_path_elements: | ||
| print(f'\t\tOn field: {field_path_element.field_name}') | ||
| sys.exit(1) | ||
|
|
||
| print('Created extension feed with resource name {}.' | ||
| .format(feed_response.results[0].resource_name)) | ||
|
|
||
|
|
||
| def _create_price_offer(client, header, description, price_in_micros, | ||
| currency_code, unit, in_final_url, | ||
| in_final_mobile_url=None): | ||
| """Create a price offer.""" | ||
| price_offer = client.get_type('PriceOffer', version='v2') | ||
| price_offer.header.value = header | ||
| price_offer.description.value = description | ||
| final_url = price_offer.final_urls.add() | ||
| final_url.value = in_final_url | ||
| price_offer.price.amount_micros.value = price_in_micros | ||
| price_offer.price.currency_code.value = currency_code | ||
| price_offer.unit = unit | ||
| # Optional: set the final mobile URLs | ||
| if in_final_mobile_url: | ||
| final_mobile_url = price_offer.final_mobile_urls.add() | ||
| final_mobile_url.value = in_final_mobile_url | ||
| return price_offer | ||
|
|
||
|
|
||
| def _create_ad_schedule_info(client, day_of_week, start_hour, start_minute, | ||
| end_hour, end_minute): | ||
| """Create a new ad schedule info with the specified parameters.""" | ||
| ad_schedule_info = client.get_type('AdScheduleInfo', version='v2') | ||
| ad_schedule_info.day_of_week = day_of_week | ||
| ad_schedule_info.start_hour.value = start_hour | ||
| ad_schedule_info.start_minute = start_minute | ||
| ad_schedule_info.end_hour.value = end_hour | ||
| ad_schedule_info.end_minute = end_minute | ||
| return ad_schedule_info | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| # GoogleAdsClient will read the google-ads.yaml configuration file in the | ||
| # home directory if none is specified. | ||
| google_ads_client = GoogleAdsClient.load_from_storage() | ||
|
|
||
| parser = argparse.ArgumentParser( | ||
| description='Add price extension for the specified customer id') | ||
| # The following argument(s) should be provided to run the example. | ||
| parser.add_argument('-c', '--customer_id', type=str, | ||
| required=True, help='The Google Ads customer ID') | ||
| parser.add_argument('-i', '--campaign_id', type=str, | ||
| required=True, help='The campaign ID.') | ||
| args = parser.parse_args() | ||
|
|
||
| main(google_ads_client, args.customer_id, args.campaign_id) |