Add responsive seard ad
The best way to set up new ads in the API is to use the Add Responsive Search Ad code example in the Basic Operations folder of your client library. The sample handles all the background authentication tasks for you, and walks you through creating responsive search ads.
Java
// Copyright 2019 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.
package com.google.ads.googleads.examples.basicoperations;
import static com.google.ads.googleads.examples.utils.CodeSampleHelper.getShortPrintableDateTime;
import com.beust.jcommander.Parameter;
import com.google.ads.googleads.examples.utils.ArgumentNames;
import com.google.ads.googleads.examples.utils.CodeSampleParams;
import com.google.ads.googleads.lib.GoogleAdsClient;
import com.google.ads.googleads.v12.common.AdTextAsset;
import com.google.ads.googleads.v12.common.ResponsiveSearchAdInfo;
import com.google.ads.googleads.v12.enums.AdGroupAdStatusEnum.AdGroupAdStatus;
import com.google.ads.googleads.v12.enums.ServedAssetFieldTypeEnum.ServedAssetFieldType;
import com.google.ads.googleads.v12.errors.GoogleAdsError;
import com.google.ads.googleads.v12.errors.GoogleAdsException;
import com.google.ads.googleads.v12.resources.Ad;
import com.google.ads.googleads.v12.resources.AdGroupAd;
import com.google.ads.googleads.v12.services.AdGroupAdOperation;
import com.google.ads.googleads.v12.services.AdGroupAdServiceClient;
import com.google.ads.googleads.v12.services.MutateAdGroupAdResult;
import com.google.ads.googleads.v12.services.MutateAdGroupAdsResponse;
import com.google.ads.googleads.v12.utils.ResourceNames;
import com.google.common.collect.ImmutableList;
import java.io.FileNotFoundException;
import java.io.IOException;
/** Adds a responsive search ad to a given ad group. To get ad groups, run GetAdGroups.java. */
public class AddResponsiveSearchAd {
private static class AddResponsiveSearchAdParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private Long customerId;
@Parameter(names = ArgumentNames.AD_GROUP_ID, required = true)
private Long adGroupId;
}
public static void main(String[] args) {
AddResponsiveSearchAdParams params = new AddResponsiveSearchAdParams();
if (!params.parseArguments(args)) {
// Either pass the required parameters for this example on the command line, or insert them
// into the code here. See the parameter class definition above for descriptions.
params.customerId = Long.parseLong("INSERT_CUSTOMER_ID_HERE");
params.adGroupId = Long.parseLong("INSERT_AD_GROUP_ID_HERE");
}
GoogleAdsClient googleAdsClient = null;
try {
googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
System.err.printf(
"Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
System.exit(1);
} catch (IOException ioe) {
System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
System.exit(1);
}
try {
new AddResponsiveSearchAd().runExample(googleAdsClient, params.customerId, params.adGroupId);
} catch (GoogleAdsException gae) {
// GoogleAdsException is the base class for most exceptions thrown by an API request.
// Instances of this exception have a message and a GoogleAdsFailure that contains a
// collection of GoogleAdsErrors that indicate the underlying causes of the
// GoogleAdsException.
System.err.printf(
"Request ID %s failed due to GoogleAdsException. Underlying errors:%n",
gae.getRequestId());
int i = 0;
for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
System.err.printf(" Error %d: %s%n", i++, googleAdsError);
}
System.exit(1);
}
}
/**
* Runs the example.
*
* @param googleAdsClient the Google Ads API client.
* @param customerId the client customer ID.
* @param adGroupId the ad group ID.
* @throws GoogleAdsException if an API request failed with one or more service errors.
*/
private void runExample(GoogleAdsClient googleAdsClient, long customerId, long adGroupId) {
String adGroupResourceName = ResourceNames.adGroup(customerId, adGroupId);
// Sets a pinning to always choose this asset for HEADLINE_1. Pinning is optional; if no
// pinning is set, then headlines and descriptions will be rotated and the ones that
// perform best will be used more often.
AdTextAsset pinnedHeadline =
AdTextAsset.newBuilder()
.setText("Cruise to Mars #" + getShortPrintableDateTime())
.setPinnedField(ServedAssetFieldType.HEADLINE_1)
.build();
// Creates the responsive search ad info.
ResponsiveSearchAdInfo responsiveSearchAdInfo =
ResponsiveSearchAdInfo.newBuilder()
.addHeadlines(pinnedHeadline)
.addHeadlines(createAdTextAsset("Best Space Cruise Line"))
.addHeadlines(createAdTextAsset("Experience the Stars"))
.addDescriptions(createAdTextAsset("Buy your tickets now"))
.addDescriptions(createAdTextAsset("Visit the Red Planet"))
.setPath1("all-inclusive")
.setPath2("deals")
.build();
// Wraps the info in an Ad object.
Ad ad =
Ad.newBuilder()
.setResponsiveSearchAd(responsiveSearchAdInfo)
.addFinalUrls("http://www.example.com")
.build();
// Builds the final ad group ad representation.
AdGroupAd adGroupAd =
AdGroupAd.newBuilder()
.setAdGroup(adGroupResourceName)
.setStatus(AdGroupAdStatus.PAUSED)
.setAd(ad)
.build();
// Creates the operation.
AdGroupAdOperation operation = AdGroupAdOperation.newBuilder().setCreate(adGroupAd).build();
// Creates the AdGroupAdServiceClient.
try (AdGroupAdServiceClient adGroupAdServiceClient =
googleAdsClient.getLatestVersion().createAdGroupAdServiceClient()) {
// Adds the AdGroup.
MutateAdGroupAdsResponse response =
adGroupAdServiceClient.mutateAdGroupAds(
Long.toString(customerId), ImmutableList.of(operation));
for (MutateAdGroupAdResult result : response.getResultsList()) {
System.out.printf(
"Responsive search ad created with resource name: %s.%n", result.getResourceName());
}
}
}
/**
* Creates an AdTextAsset from a given string.
*
* @param text the text string to insert in the AdTextAsset.
* @return AdTextAsset.
*/
private AdTextAsset createAdTextAsset(String text) {
return AdTextAsset.newBuilder().setText(text).build();
}
}
C#
// 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
//
// 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.
using CommandLine;
using Google.Ads.Gax.Examples;
using Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V12.Common;
using Google.Ads.GoogleAds.V12.Enums;
using Google.Ads.GoogleAds.V12.Errors;
using Google.Ads.GoogleAds.V12.Resources;
using Google.Ads.GoogleAds.V12.Services;
using System;
using System.Collections.Generic;
using static Google.Ads.GoogleAds.V12.Enums.ServedAssetFieldTypeEnum.Types;
namespace Google.Ads.GoogleAds.Examples.V12
{
/// <summary>
/// This code example adds a responsive search ad to a given ad group. To get ad groups,
/// run GetAdGroups.cs.
/// </summary>
public class AddResponsiveSearchAd : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="AddResponsiveSearchAd"/> example.
/// </summary>
public class Options : OptionsBase
{
/// <summary>
/// The Google Ads customer ID for which the call is made.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The Google Ads customer ID for which the call is made.")]
public long CustomerId { get; set; }
/// <summary>
/// ID of the ad group to which ads are added.
/// </summary>
[Option("adGroupId", Required = true, HelpText =
"ID of the ad group to which ads are added.")]
public long AdGroupId { get; set; }
}
/// <summary>
/// Main method, to run this code example as a standalone application.
/// </summary>
/// <param name="args">The command line arguments.</param>
public static void Main(string[] args)
{
Options options = ExampleUtilities.ParseCommandLine<Options>(args);
AddResponsiveSearchAd codeExample = new AddResponsiveSearchAd();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(),
options.CustomerId,
options.AdGroupId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"This code example adds a responsive search ad to a given ad group. To get ad " +
"groups, run GetAdGroups.cs.";
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="adGroupId">ID of the ad group to which ads are added.</param>
public void Run(GoogleAdsClient client, long customerId, long adGroupId)
{
// Get the AdGroupAdService.
AdGroupAdServiceClient adGroupAdService =
client.GetService(Services.V12.AdGroupAdService);
// Create the ad.
Ad ad = new Ad()
{
ResponsiveSearchAd = new ResponsiveSearchAdInfo()
{
Headlines =
{
// Sets a pinning to always choose this asset for HEADLINE_1. Pinning is
// optional; if no pinning is set, then headlines and descriptions will be
// rotated and the ones that perform best will be used more often.
new AdTextAsset() {
Text = "Cruise to Mars #" + ExampleUtilities.GetShortRandomString(),
PinnedField = ServedAssetFieldType.Headline1
},
new AdTextAsset() { Text = "Best Space Cruise Line" },
new AdTextAsset() { Text = "Experience the Stars" }
},
Descriptions =
{
new AdTextAsset() { Text = "Buy your tickets now" },
new AdTextAsset() { Text = "Visit the Red Planet" },
},
Path1 = "all-inclusive",
Path2 = "deals"
},
FinalUrls = { "http://www.example.com" }
};
// Builds the final ad group ad representation.
AdGroupAd adGroupAd = new AdGroupAd()
{
AdGroup = ResourceNames.AdGroup(customerId, adGroupId),
Status = AdGroupAdStatusEnum.Types.AdGroupAdStatus.Paused,
Ad = ad
};
// Creates the operation.
AdGroupAdOperation operation = new AdGroupAdOperation()
{
Create = adGroupAd
};
try
{
MutateAdGroupAdsResponse response =
adGroupAdService.MutateAdGroupAds(customerId.ToString(), new[] { operation });
foreach (MutateAdGroupAdResult result in response.Results)
{
Console.WriteLine($"Responsive search ad created with resource name:" +
$" '{result.ResourceName}'.");
}
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
throw;
}
}
}
}
PHP
<?php
/**
* 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.
*/
namespace Google\Ads\GoogleAds\Examples\BasicOperations;
require __DIR__ . '/../../vendor/autoload.php';
use GetOpt\GetOpt;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentNames;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentParser;
use Google\Ads\GoogleAds\Examples\Utils\Helper;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V12\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V12\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V12\GoogleAdsException;
use Google\Ads\GoogleAds\Util\V12\ResourceNames;
use Google\Ads\GoogleAds\V12\Common\AdTextAsset;
use Google\Ads\GoogleAds\V12\Common\ResponsiveSearchAdInfo;
use Google\Ads\GoogleAds\V12\Enums\AdGroupAdStatusEnum\AdGroupAdStatus;
use Google\Ads\GoogleAds\V12\Enums\ServedAssetFieldTypeEnum\ServedAssetFieldType;
use Google\Ads\GoogleAds\V12\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V12\Resources\Ad;
use Google\Ads\GoogleAds\V12\Resources\AdGroupAd;
use Google\Ads\GoogleAds\V12\Services\AdGroupAdOperation;
use Google\ApiCore\ApiException;
/**
* This example adds a responsive search ad to a given ad group. To get ad groups,
* run GetAdGroups.php.
*/
class AddResponsiveSearchAd
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const AD_GROUP_ID = 'INSERT_AD_GROUP_ID_HERE';
public static function main()
{
// Either pass the required parameters for this example on the command line, or insert them
// into the constants above.
$options = (new ArgumentParser())->parseCommandArguments([
ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT
]);
// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();
// Construct a Google Ads client configured from a properties file and the
// OAuth2 credentials above.
$googleAdsClient = (new GoogleAdsClientBuilder())->fromFile()
->withOAuth2Credential($oAuth2Credential)
->build();
try {
self::runExample(
$googleAdsClient,
$options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID,
$options[ArgumentNames::AD_GROUP_ID] ?: self::AD_GROUP_ID
);
} catch (GoogleAdsException $googleAdsException) {
printf(
"Request with ID '%s' has failed.%sGoogle Ads failure details:%s",
$googleAdsException->getRequestId(),
PHP_EOL,
PHP_EOL
);
foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) {
/** @var GoogleAdsError $error */
printf(
"\t%s: %s%s",
$error->getErrorCode()->getErrorCode(),
$error->getMessage(),
PHP_EOL
);
}
exit(1);
} catch (ApiException $apiException) {
printf(
"ApiException was thrown with message '%s'.%s",
$apiException->getMessage(),
PHP_EOL
);
exit(1);
}
}
/**
* Runs the example.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param int $adGroupId the ad group ID to add a responsive search ad to
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $adGroupId
) {
// Creates an ad and sets responsive search ad info.
$ad = new Ad([
'responsive_search_ad' => new ResponsiveSearchAdInfo([
'headlines' => [
// Sets a pinning to always choose this asset for HEADLINE_1. Pinning is
// optional; if no pinning is set, then headlines and descriptions will be
// rotated and the ones that perform best will be used more often.
self::createAdTextAsset(
'Cruise to Mars #' . Helper::getShortPrintableDatetime(),
ServedAssetFieldType::HEADLINE_1
),
self::createAdTextAsset('Best Space Cruise Line'),
self::createAdTextAsset('Experience the Stars')
],
'descriptions' => [
self::createAdTextAsset('Buy your tickets now'),
self::createAdTextAsset('Visit the Red Planet')
],
'path1' => 'all-inclusive',
'path2' => 'deals'
]),
'final_urls' => ['http://www.example.com']
]);
// Creates an ad group ad to hold the above ad.
$adGroupAd = new AdGroupAd([
'ad_group' => ResourceNames::forAdGroup($customerId, $adGroupId),
'status' => AdGroupAdStatus::PAUSED,
'ad' => $ad
]);
// Creates an ad group ad operation.
$adGroupAdOperation = new AdGroupAdOperation();
$adGroupAdOperation->setCreate($adGroupAd);
// Issues a mutate request to add the ad group ad.
$adGroupAdServiceClient = $googleAdsClient->getAdGroupAdServiceClient();
$response = $adGroupAdServiceClient->mutateAdGroupAds($customerId, [$adGroupAdOperation]);
$createdAdGroupAdResourceName = $response->getResults()[0]->getResourceName();
printf(
"Created responsive search ad with resource name '%s'.%s",
$createdAdGroupAdResourceName,
PHP_EOL
);
}
/**
* Creates an ad text asset with the specified text and pin field enum value.
*
* @param string $text the text to be set
* @param int|null $pinField the enum value of the pin field
* @return AdTextAsset the created ad text asset
*/
private static function createAdTextAsset(string $text, int $pinField = null): AdTextAsset
{
$adTextAsset = new AdTextAsset(['text' => $text]);
if (!is_null($pinField)) {
$adTextAsset->setPinnedField($pinField);
}
return $adTextAsset;
}
}
AddResponsiveSearchAd::main();
Python
#!/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 responsive search ad to a given ad group.
To get ad groups, run get_ad_groups.py.
"""
import argparse
import sys
from uuid import uuid4
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
def main(client, customer_id, ad_group_id):
ad_group_ad_service = client.get_service("AdGroupAdService")
ad_group_service = client.get_service("AdGroupService")
# Create the ad group ad.
ad_group_ad_operation = client.get_type("AdGroupAdOperation")
ad_group_ad = ad_group_ad_operation.create
ad_group_ad.status = client.enums.AdGroupAdStatusEnum.PAUSED
ad_group_ad.ad_group = ad_group_service.ad_group_path(
customer_id, ad_group_id
)
# Set responsive search ad info.
ad_group_ad.ad.final_urls.append("http://www.example.com")
# Set a pinning to always choose this asset for HEADLINE_1. Pinning is
# optional; if no pinning is set, then headlines and descriptions will be
# rotated and the ones that perform best will be used more often.
served_asset_enum = client.enums.ServedAssetFieldTypeEnum.HEADLINE_1
pinned_headline = create_ad_text_asset(
client, f"Cruise to Mars #{str(uuid4())[:8]}", served_asset_enum
)
ad_group_ad.ad.responsive_search_ad.headlines.extend(
[
pinned_headline,
create_ad_text_asset(client, "Best Space Cruise Line"),
create_ad_text_asset(client, "Experience the Stars"),
]
)
ad_group_ad.ad.responsive_search_ad.descriptions.extend(
[
create_ad_text_asset(client, "Buy your tickets now"),
create_ad_text_asset(client, "Visit the Red Planet"),
]
)
ad_group_ad.ad.responsive_search_ad.path1 = "all-inclusive"
ad_group_ad.ad.responsive_search_ad.path2 = "deals"
# Send a request to the server to add a responsive search ad.
ad_group_ad_response = ad_group_ad_service.mutate_ad_group_ads(
customer_id=customer_id, operations=[ad_group_ad_operation]
)
for result in ad_group_ad_response.results:
print(
f"Created responsive search ad with resource name "
f'"{result.resource_name}".'
)
def create_ad_text_asset(client, text, pinned_field=None):
"""Create an AdTextAsset."""
ad_text_asset = client.get_type("AdTextAsset")
ad_text_asset.text = text
if pinned_field:
ad_text_asset.pinned_field = pinned_field
return ad_text_asset
if __name__ == "__main__":
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client = GoogleAdsClient.load_from_storage(version="v12")
parser = argparse.ArgumentParser(
description=(
"Adds an expanded text ad to the specified ad group 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(
"-a", "--ad_group_id", type=str, required=True, help="The ad group ID."
)
args = parser.parse_args()
try:
main(googleads_client, args.customer_id, args.ad_group_id)
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)
Ruby
#!/usr/bin/env ruby
# Encoding: utf-8
#
# 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 responsive search ad to an ad group.
require 'optparse'
require 'google/ads/google_ads'
def add_responsive_search_ad(customer_id, ad_group_id)
client = Google::Ads::GoogleAds::GoogleAdsClient.new
responsive_ad_info = client.resource.responsive_search_ad_info do |responsive_ad|
responsive_ad.headlines << client.resource.ad_text_asset do |ata|
ata.text = "Best Space Cruise Line"
end
responsive_ad.headlines << client.resource.ad_text_asset do |ata|
ata.text = "Experience the Stars"
end
responsive_ad.headlines << client.resource.ad_text_asset do |ata|
ata.text = "Explore the Galaxy"
end
responsive_ad.descriptions << client.resource.ad_text_asset do |ata|
ata.text = "Buy your tickets now"
end
responsive_ad.descriptions << client.resource.ad_text_asset do |ata|
ata.text = "Visit the Red Planet"
end
responsive_ad.path1 = "all-inclusive"
responsive_ad.path2 = "deals"
end
ad = client.resource.ad do |ad|
ad.final_urls << "http://www.example.com"
ad.responsive_search_ad = responsive_ad_info
end
ad_group_ad = client.resource.ad_group_ad do |aga|
aga.ad = ad
aga.status = :PAUSED
aga.ad_group = client.path.ad_group(customer_id, ad_group_id)
end
op = client.operation.create_resource.ad_group_ad(ad_group_ad)
response = client.service.ad_group_ad.mutate_ad_group_ads(
customer_id: customer_id,
operations: [op],
)
puts "Created Responsive Search Ad with ID #{response.results.first.resource_name}."
end
if __FILE__ == $0
options = {}
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
options[:customer_id] = 'INSERT_CUSTOMER_ID_HERE'
options[:ad_group_id] = 'INSERT_AD_GROUP_ID_HERE'
OptionParser.new do |opts|
opts.banner = sprintf('Usage: %s [options]', File.basename(__FILE__))
opts.separator ''
opts.separator 'Options:'
opts.on('-C', '--customer-id CUSTOMER-ID', String, 'Customer ID') do |v|
options[:customer_id] = v
end
opts.on('-A', '--ad-group-id AD-GROUP-ID', String, 'Ad Group ID') do |v|
options[:ad_group_id] = v
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
add_responsive_search_ad(
options.fetch(:customer_id).tr("-", ""),
options.fetch(:ad_group_id),
)
rescue Google::Ads::GoogleAds::Errors::GoogleAdsError => e
e.failure.errors.each do |error|
STDERR.printf("Error with message: %s\n", error.message)
if error.location
error.location.field_path_elements.each do |field_path_element|
STDERR.printf("\tOn field: %s\n", field_path_element.field_name)
end
end
error.error_code.to_h.each do |k, v|
next if v == :UNSPECIFIED
STDERR.printf("\tType: %s\n\tCode: %s\n", k, v)
end
end
raise
end
end
Perl
#!/usr/bin/perl -w
#
# Copyright 2019, 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
#
# 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 adds a responsive search ad to a given ad group. To get ad groups,
# run get_ad_groups.pl.
use strict;
use warnings;
use utf8;
use FindBin qw($Bin);
use lib "$Bin/../../lib";
use Google::Ads::GoogleAds::Client;
use Google::Ads::GoogleAds::Utils::GoogleAdsHelper;
use Google::Ads::GoogleAds::V12::Resources::AdGroupAd;
use Google::Ads::GoogleAds::V12::Resources::Ad;
use Google::Ads::GoogleAds::V12::Common::AdTextAsset;
use Google::Ads::GoogleAds::V12::Common::ResponsiveSearchAdInfo;
use Google::Ads::GoogleAds::V12::Enums::ServedAssetFieldTypeEnum qw(HEADLINE_1);
use Google::Ads::GoogleAds::V12::Enums::AdGroupAdStatusEnum qw(PAUSED);
use Google::Ads::GoogleAds::V12::Services::AdGroupAdService::AdGroupAdOperation;
use Google::Ads::GoogleAds::V12::Utils::ResourceNames;
use Getopt::Long qw(:config auto_help);
use Pod::Usage;
use Cwd qw(abs_path);
use Data::Uniqid qw(uniqid);
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
my $customer_id = "INSERT_CUSTOMER_ID_HERE";
my $ad_group_id = "INSERT_AD_GROUP_ID_HERE";
sub add_responsive_search_ad {
my ($api_client, $customer_id, $ad_group_id) = @_;
# Set a pinning to always choose this asset for HEADLINE_1. Pinning is optional;
# if no pinning is set, then headlines and descriptions will be rotated and the
# ones that perform best will be used more often.
my $pinned_headline = Google::Ads::GoogleAds::V12::Common::AdTextAsset->new({
text => "Cruise to Mars #" . uniqid(),
pinnedField => HEADLINE_1
});
# Create a responsive search ad info.
my $responsive_search_ad_info =
Google::Ads::GoogleAds::V12::Common::ResponsiveSearchAdInfo->new({
headlines => [
$pinned_headline,
create_ad_text_asset("Best Space Cruise Line"),
create_ad_text_asset("Experience the Stars")
],
descriptions => [
create_ad_text_asset("Buy your tickets now"),
create_ad_text_asset("Visit the Red Planet")
],
path1 => "all-inclusive",
path2 => "deals"
});
# Create an ad group ad.
my $ad_group_ad = Google::Ads::GoogleAds::V12::Resources::AdGroupAd->new({
adGroup => Google::Ads::GoogleAds::V12::Utils::ResourceNames::ad_group(
$customer_id, $ad_group_id
),
status => PAUSED,
ad => Google::Ads::GoogleAds::V12::Resources::Ad->new({
responsiveSearchAd => $responsive_search_ad_info,
finalUrls => "http://www.example.com"
})});
# Create an ad group ad operation.
my $ad_group_ad_operation =
Google::Ads::GoogleAds::V12::Services::AdGroupAdService::AdGroupAdOperation
->new({create => $ad_group_ad});
# Add the ad group ad.
my $ad_group_ads_response = $api_client->AdGroupAdService()->mutate({
customerId => $customer_id,
operations => [$ad_group_ad_operation]});
printf "Created responsive search ad '%s'.\n",
$ad_group_ads_response->{results}[0]{resourceName};
return 1;
}
# Creates an ad text asset from a given string.
sub create_ad_text_asset {
my $text = shift;
return Google::Ads::GoogleAds::V12::Common::AdTextAsset->new({
text => $text
});
}
# Don't run the example if the file is being included.
if (abs_path($0) ne abs_path(__FILE__)) {
return 1;
}
# Get Google Ads Client, credentials will be read from ~/googleads.properties.
my $api_client = Google::Ads::GoogleAds::Client->new();
# By default examples are set to die on any server returned fault.
$api_client->set_die_on_faults(1);
# Parameters passed on the command line will override any parameters set in code.
GetOptions(
"customer_id=s" => \$customer_id,
"ad_group_id=i" => \$ad_group_id,
);
# Print the help message if the parameters are not initialized in the code nor
# in the command line.
pod2usage(2) if not check_params($customer_id, $ad_group_id);
# Call the example.
add_responsive_search_ad($api_client, $customer_id =~ s/-//gr, $ad_group_id);
=pod
=head1 NAME
add_responsive_search_ad
=head1 DESCRIPTION
This example adds a responsive search ad to a given ad group. To get ad groups,
run get_ad_groups.pl.
=head1 SYNOPSIS
add_responsive_search_ad.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-ad_group_id The ad group ID.
=cut