Adding a full example of how to create a Responsive Search Ad (with keywords and geo targeting) #715

fblascogarma · 2022-10-24T22:31:22Z

This example shows how to create a complete Responsive Search ad.

Includes creation of: budget, campaign, ad group, ad group ad,
keywords, geo targeting, and image extensions.

…cation target set.

git add .

… to use.

'updating repo' git add .

…ords and geo targetting.

BenRKarl · 2023-01-10T20:38:57Z

examples/advanced_operations/add_responsive_search_ad_full.py

@@ -0,0 +1,541 @@
+#!/usr/bin/env python
+# Copyright 2022 Google LLC


This should now be updated to 2023

examples/advanced_operations/add_responsive_search_ad_full.py

BenRKarl · 2023-01-10T20:42:13Z

examples/advanced_operations/add_responsive_search_ad_full.py

+
+
+# Keywords from user.
+keyword_text_exact_1 = "example of exact match"


As module-level variables, these should be capitalized with leading underscores, for example:

_KEYWORD_TEXT_EXACT_1 = ... _KEYWORD_TEXT_PHRASE_1 = ... _KEYWORD_TEXT_BROAD_1 = ...

Feel free to reference the Smart Campaign example.

BenRKarl · 2023-01-10T20:42:35Z

examples/advanced_operations/add_responsive_search_ad_full.py

+# Geo targeting from user.
+location_1 = "Buenos aires"
+location_2 = "San Isidro"
+location_3 = "Mar del Plata"


Same as above for these variables, capitalize with leading underscore.

BenRKarl · 2023-01-10T20:45:58Z

examples/advanced_operations/add_responsive_search_ad_full.py

+
+# A list of country codes can be referenced here:
+# https://developers.google.com/google-ads/api/reference/data/geotargets
+COUNTRY_CODE = "AR"


The two above variables should have leading underscores.

examples/advanced_operations/add_responsive_search_ad_full.py

BenRKarl · 2023-01-10T21:33:05Z

examples/advanced_operations/add_responsive_search_ad_full.py

+      business_profile_location: the ID of a Business Profile location.
+      business_name: the name of a Business Profile.
+  """
+  # [START Step 1 -- Create campaign and budget]


The [START xyz] notation is used to port specific sections of the example to our docs, so there's no need to include them here since this example isn't accompanied by a guide.

So this comment can just be:

# Step 1 -- Create campaign and budget

BenRKarl · 2023-01-11T17:27:24Z

examples/advanced_operations/add_responsive_search_ad_full.py

+  campaign_budget.amount_micros = 500000
+
+  # Add budget.
+  try:


If you wrap the call to main in a try/catch at the bottom of the file then you don't need to handle any exceptions here or any where else in the file.

BenRKarl · 2023-01-11T17:28:49Z

examples/advanced_operations/add_responsive_search_ad_full.py

+      campaign_id = campaign_response.results[0].resource_name.split("/")[-1]
+  except GoogleAdsException as ex:
+      handle_googleads_exception(ex)
+  # [END Step 1 -- Create campaign and budget]


As mentioned earlier, you can remove the comment formatted that looks like:

[START xyz]

[END xyz]

Just leave the xyz part.

BenRKarl · 2023-01-11T17:31:33Z

examples/advanced_operations/add_responsive_search_ad_full.py

+6 steps to create a Responsive Search Ad (RSA).
+'''
+
+def main(


Can you break this method into smaller methods where each is responsible for creating a single resource? Specifically the body in main should look something like:

def main(...): _create_campaign_budget(...) _create_campaign(...) _create_ad_group(...)

The smart campaign example does a good job of this in order to make the chunks of code more discernable for the reader.

git add . .

fblascogarma · 2023-01-23T23:45:52Z

Hi Ben, thank you for all your great recommendations. I have followed all of them and commit the changes.

Please review and let me know what you think.

Thank you!

bobhancockg

Please only use an initial underbar when it conforms with PEP8.

_single_leading_underscore: weak “internal use” indicator. E.g. from M import * does not import objects whose names start with an underscore.

examples/advanced_operations/add_responsive_search_ad_full.py

bobhancockg · 2023-01-24T14:45:59Z

examples/advanced_operations/add_responsive_search_ad_full.py

+  """
+    # Step 1.1 -- Create budget.
+    # Create a budget, which can be shared by multiple campaigns.
+    campaign_budget = _create_campaign_budget(client, customer_id)


See above. Why is the initial underbar used?

See my response above - it's because I asked for them to be changed. I remember now that we stopped using this pattern so agree let's remove the leading underscore from all the method names in this example.

fblascogarma · 2023-01-24T21:54:08Z

Hi Ben, I removed the leading underscores in method names as requested.

BenRKarl · 2023-02-01T16:40:49Z

examples/advanced_operations/add_responsive_search_ad_full.py

+
+  Returns:
+      A responsive search ad with all settings required to run campaign.
+  """


The above lines (75-83) should be indented by 4 spaces.

BenRKarl · 2023-02-01T16:42:18Z

examples/advanced_operations/add_responsive_search_ad_full.py

+# If the account does not meet the requirements, set below variable to False.
+_ADD_IMAGE_EXTENSION = True
+
+"""Support function"""


It's not necessary to have this comment here, the PyDocs in each function are sufficient.

BenRKarl · 2023-02-01T16:42:48Z

examples/advanced_operations/add_responsive_search_ad_full.py

+
+
+def create_ad_text_asset(client, text, pinned_field=None):
+    """Create an AdTextAsset."""


This PyDoc needs Args and Returns sections.

BenRKarl · 2023-02-01T16:42:58Z

examples/advanced_operations/add_responsive_search_ad_full.py

+    return ad_text_asset
+
+
+"""6 steps to create a Responsive Search Ad (RSA)."""


No need to have this either.

BenRKarl · 2023-02-01T16:46:43Z

examples/advanced_operations/add_responsive_search_ad_full.py

+# To add image extensions, the account has to follow these requirements:
+# https://support.google.com/google-ads/answer/9566341
+# If the account does not meet the requirements, set below variable to False.
+_ADD_IMAGE_EXTENSION = True


This should be converted into a CLI input (like this) since it can be toggled. These module-level variables should be used for values that are static.

BenRKarl · 2023-02-01T18:47:22Z

examples/advanced_operations/add_responsive_search_ad_full.py

+        # Create the campaign criterion for location targeting.
+        campaign_criterion_operation = client.get_type("CampaignCriterionOperation")
+        campaign_criterion = campaign_criterion_operation.create
+        campaign_criterion.campaign = campaign_service.campaign_path(


Once you update the method to accept a campaign resource name you won't need to do this.

BenRKarl · 2023-02-01T18:47:33Z

examples/advanced_operations/add_responsive_search_ad_full.py

+    for result in campaign_criterion_response.results:
+        print(f'Added campaign criterion "{result.resource_name}".')
+
+    return


No explicit return needed.

BenRKarl · 2023-02-01T19:02:23Z

examples/advanced_operations/add_responsive_search_ad_full.py

+    # Step 6.1 - Add Image Asset.
+
+    # Download image from URL.
+    url = "https://img.cppng.com/download/2020-06/66912-logo-now-google-plus-search-free-transparent-image-hd.png"


We have images hosted specifically for this purpose, for example: https://gaagl.page.link/bjYi

BenRKarl · 2023-02-01T19:04:19Z

examples/advanced_operations/add_responsive_search_ad_full.py

+    for row in mutate_asset_response.results:
+        print(f"\tResource name: {row.resource_name}")
+
+    image_asset_id = mutate_asset_response.results[0].resource_name.split("/")[-1]


No need to split out the ID here, you can just reuse the resource name as-is on line 507.

BenRKarl · 2023-02-01T19:04:31Z

examples/advanced_operations/add_responsive_search_ad_full.py

+        "Created a campaign extension setting with resource name: "
+        f"'{campaign_extension_response.results[0].resource_name}'"
+    )
+    return


No explicit return.

BenRKarl

Just one small change then we're good to go.

BenRKarl · 2023-02-02T19:34:18Z

examples/advanced_operations/add_responsive_search_ad_full.py

+        )
+        ad_resource_name = result.resource_name.split("/")[-1]
+
+    return ad_resource_name


Looks like this value isn't used by the calling code, so no need to even return it at all, just remove everything below the print statement.

jradcliff · 2023-03-10T15:13:01Z

examples/advanced_operations/add_responsive_search_ad_full.py

+    # To add image extensions, the account has to follow these requirements:
+    # https://support.google.com/google-ads/answer/9566341
+    # If the account meets the requirements, set below variable to True.
+    if omit_image_extensions:


This should be if not omit_image_extensions, correct?

On that note, could we make this include_image_extensions and have it default to True instead? That would make the logic more readable and avoid a double negative for the "do something" case. Then the code here would be:

if include_image_extensions:

You are right! Let's change it to include_image_extensions, but I would still have it as False as a default because not all accounts can create them. Therefore, we avoid developers getting errors.

jradcliff · 2023-03-10T16:11:56Z

examples/advanced_operations/add_responsive_search_ad_full.py

+    # The bidding strategy for Maximize Clicks is TargetSpend.
+    # The target_spend_micros is deprecated so don't put any value.
+    # See other bidding strategies you can select in the link below.
+    # https://developers.google.com/google-ads/api/reference/rpc/v11/Campaign#campaign_bidding_strategy


Change v11 to latest so this isn't version dependent.

jradcliff · 2023-03-10T17:39:34Z

examples/advanced_operations/add_responsive_search_ad_full.py

+
+
+def add_images(client, customer_id, campaign_resource_name):
+    # Step 6.1 - Add Image Asset.


Do these numbered steps correspond to upcoming changes to documentation? I noticed they're only present in this method.

jradcliff · 2023-03-10T17:58:06Z

examples/advanced_operations/add_responsive_search_ad_full.py

+    asset.image_asset.file_size = len(image_content)
+
+    # MIME type of the image (IMAGE_JPEG, IMAGE_PNG, etc.).
+    # See more types on the link below.
+    # https://developers.google.com/google-ads/api/reference/rpc/v11/MimeTypeEnum.MimeType
+    asset.image_asset.mime_type = client.enums.MimeTypeEnum.IMAGE_PNG
+    # Use your favorite image library to determine dimensions
+    asset.image_asset.full_size.height_pixels = 1200
+    asset.image_asset.full_size.width_pixels = 1200
+    asset.image_asset.full_size.url = url


Is setting file_size and full_size necessary? We don't set any of those attributes in https://developers.google.com/google-ads/api/samples/upload-image#python, but we do in https://developers.google.com/google-ads/api/samples/upload-image-asset#python.

I just tested by taking them out, and I didn't get any errors. Therefore, we could comment them out or remove them.

Francisco Blasco Garma and others added 15 commits September 3, 2021 10:35

Added the location criterion so the smart campaign created has the lo…

169c645

…cation target set.

updating repo with original repo

185ec08

added listing group that is necessary for the campaign to run.

2459c2b

Merge branch 'main' of https://github.com/googleads/google-ads-python

fa715c0

git add .

changed url expansion opt out to true as it is recommended for retail.

ada93d3

clarify target_roas still needs to be defined even though is optional…

ee5f59e

… to use.

made recommended changes.

e643df9

Merge branch 'main' into master

2214fe7

updating repo with original repo

4af9890

updating repo with original repo

fae3f8a

Merge https://github.com/fblascogarma/google-ads-python

c0c9d2b

'updating repo' git add .

respecting syntax

e4a9629

syntax

78955b3

fixing syntax

e173d18

create example of how to create a full responsive search ad with keyw…

69c4b2f

…ords and geo targetting.

fblascogarma requested a review from a team as a code owner October 24, 2022 22:31

fblascogarma requested review from wihl and laurachevalier4 October 24, 2022 22:31

laurachevalier4 requested review from bobhancock and removed request for laurachevalier4 October 25, 2022 14:05

BenRKarl requested review from BenRKarl and removed request for wihl December 6, 2022 14:56

BenRKarl requested changes Jan 11, 2023

View reviewed changes

fblascogarma added 2 commits January 23, 2023 15:36

Merge branch 'main' of https://github.com/googleads/google-ads-python

e69ef34

git add . .

adding example of full responsive search ad

74974b3

bobhancockg requested changes Jan 24, 2023

View reviewed changes

BenRKarl mentioned this pull request Jan 24, 2023

Customer match lists - upload example does not work #711

Closed

removed leading underscores in method names

348e3d6

BenRKarl requested changes Feb 1, 2023

View reviewed changes

made all requested changes by Ben.

fa639e5

BenRKarl requested changes Feb 2, 2023

View reviewed changes

removed return of ad_resource_name as Ben requested.

46493a5

BenRKarl approved these changes Feb 8, 2023

View reviewed changes

bobhancockg approved these changes Feb 8, 2023

View reviewed changes

BenRKarl merged commit 9f52ec2 into googleads:main Feb 8, 2023

BenRKarl mentioned this pull request Mar 3, 2023

Replace main add_responsive_search_ad example with newer version... #753

Closed

jradcliff reviewed Mar 10, 2023

View reviewed changes

		@@ -0,0 +1,541 @@
		#!/usr/bin/env python
		# Copyright 2022 Google LLC



		# Keywords from user.
		keyword_text_exact_1 = "example of exact match"



		def create_ad_text_asset(client, text, pinned_field=None):
		"""Create an AdTextAsset."""

		return ad_text_asset


		"""6 steps to create a Responsive Search Ad (RSA)."""



		def add_images(client, customer_id, campaign_resource_name):
		# Step 6.1 - Add Image Asset.

Adding a full example of how to create a Responsive Search Ad (with keywords and geo targeting) #715

Adding a full example of how to create a Responsive Search Ad (with keywords and geo targeting) #715

Uh oh!

Conversation

fblascogarma commented Oct 24, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fblascogarma commented Jan 23, 2023

Uh oh!

bobhancockg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fblascogarma commented Jan 24, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BenRKarl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

jradcliff Mar 10, 2023 •

edited

Loading

jradcliff Mar 10, 2023 •

edited

Loading