add add_campaign_draft.py code example (googleads#251)

xflesym · web-flow · commit adf33d9a540f · 2020-03-24T08:16:58.000-04:00
* code example for update expanded text ads

* fixed argument wording

* wording tweaks, use f-string

* add punctuation

* quote around resource name, and end sentence with a period

* filename change

* add description field

* removing empty line

* add add_campaign_draft example

* address comments for add_campaign_draft.py

Co-authored-by: Fei Xiang &lt;xflesym@users.noreply.github.com&gt;
diff --git a/examples/campaign_management/add_campaign_draft.py b/examples/campaign_management/add_campaign_draft.py
@@ -0,0 +1,77 @@
+#!/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 campaign draft for a campaign.
+
+Make sure you specify a campaign that has a non-shared budget.
+"""
+
+
+import argparse
+import sys
+from uuid import uuid4
+
+from google.ads.google_ads.client import GoogleAdsClient
+from google.ads.google_ads.errors import GoogleAdsException
+
+
+def main(client, customer_id, base_campaign_id):
+    campaign_service = client.get_service('CampaignService', version='v3')
+    campaign_draft_service = client.get_service('CampaignDraftService',
+                                                version='v3')
+
+    # Creates a campaign draft operation.
+    campaign_draft_operation = client.get_type('CampaignDraftOperation')
+    campaign_draft = campaign_draft_operation.create
+
+    # Creates a campaign draft.
+    campaign_draft.base_campaign.value = campaign_service.campaign_path(
+        customer_id, base_campaign_id)
+    campaign_draft.name.value = f'Campaign Draft #{uuid4()}'
+
+    # Issues a mutate request to add the campaign draft.
+    try:
+        campaign_draft_response = (
+            campaign_draft_service.mutate_campaign_drafts(
+                customer_id, [campaign_draft_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 campaign draft: '
+          f'"{campaign_draft_response.results[0].resource_name}".')
+
+
+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=('Adds a campaign draft for the specified base campaign ID, '
+                     'for the given 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', '--base_campaign_id', type=str,
+                        required=True, help='The base campaign ID.')
+    args = parser.parse_args()
+
+    main(google_ads_client, args.customer_id, args.base_campaign_id)
