Add expanded text ad
The best way to set up new ads in the API is to use the Add Expanded Text Ads 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 expanded text ads.
Java
// Copyright 2018 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 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.v2.errors.GoogleAdsException;
import com.google.ads.googleads.v2.utils.ResourceNames;
import com.google.ads.googleads.v2.common.ExpandedTextAdInfo;
import com.google.ads.googleads.v2.enums.AdGroupAdStatusEnum.AdGroupAdStatus;
import com.google.ads.googleads.v2.errors.GoogleAdsError;
import com.google.ads.googleads.v2.resources.Ad;
import com.google.ads.googleads.v2.resources.AdGroupAd;
import com.google.ads.googleads.v2.services.AdGroupAdOperation;
import com.google.ads.googleads.v2.services.AdGroupAdServiceClient;
import com.google.ads.googleads.v2.services.MutateAdGroupAdResult;
import com.google.ads.googleads.v2.services.MutateAdGroupAdsResponse;
import com.google.protobuf.StringValue;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/** Adds expanded text ads to a given ad group. */
public class AddExpandedTextAds {
/** Number of ads being added / updated in this code example. */
private static final int NUMBER_OF_ADS_TO_ADD = 5;
private static class AddExpandedTextAdsParams 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) {
AddExpandedTextAdsParams params = new AddExpandedTextAdsParams();
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;
try {
googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
System.err.printf(
"Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
return;
} catch (IOException ioe) {
System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
return;
}
try {
new AddExpandedTextAds().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);
}
}
}
/**
* 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);
List<AdGroupAdOperation> operations = new ArrayList<>();
for (int i = 0; i < NUMBER_OF_ADS_TO_ADD; i++) {
// Creates the expanded text ad info.
ExpandedTextAdInfo expandedTextAdInfo =
ExpandedTextAdInfo.newBuilder()
.setHeadlinePart1(StringValue.of(String.format("Cruise #%d to Mars", i)))
.setHeadlinePart2(StringValue.of("Best Space Cruise Line"))
.setDescription(StringValue.of("Buy your tickets now!"))
.build();
// Wraps the info in an Ad object.
Ad ad =
Ad.newBuilder()
.setExpandedTextAd(expandedTextAdInfo)
.addFinalUrls(StringValue.of("http://www.example.com"))
.build();
// Builds the final ad group ad representation.
AdGroupAd adGroupAd =
AdGroupAd.newBuilder()
.setAdGroup(StringValue.of(adGroupResourceName))
.setStatus(AdGroupAdStatus.PAUSED)
.setAd(ad)
.build();
AdGroupAdOperation op = AdGroupAdOperation.newBuilder().setCreate(adGroupAd).build();
operations.add(op);
}
try (AdGroupAdServiceClient adGroupAdServiceClient =
googleAdsClient.getLatestVersion().createAdGroupAdServiceClient()) {
MutateAdGroupAdsResponse response =
adGroupAdServiceClient.mutateAdGroupAds(Long.toString(customerId), operations);
for (MutateAdGroupAdResult result : response.getResultsList()) {
System.out.printf(
"Expanded text ad created with resource name: %s%n", result.getResourceName());
}
}
}
}
C#
// 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.
using Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V2.Common;
using Google.Ads.GoogleAds.V2.Errors;
using Google.Ads.GoogleAds.V2.Resources;
using Google.Ads.GoogleAds.V2.Services;
using System;
using System.Collections.Generic;
using static Google.Ads.GoogleAds.V2.Enums.AdGroupAdStatusEnum.Types;
namespace Google.Ads.GoogleAds.Examples.V2
{
/// <summary>
/// This code example adds expanded text ads to a given ad group. To list
/// ad groups, run GetAdGroups.cs.
/// </summary>
public class AddExpandedTextAds : ExampleBase
{
/// <summary>
/// Number of ads being added / updated in this code example.
/// </summary>
private const int NUMBER_OF_ADS = 5;
/// <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)
{
AddExpandedTextAds codeExample = new AddExpandedTextAds();
Console.WriteLine(codeExample.Description);
//The customer ID for which the call is made.
long customerId = long.Parse("INSERT_CUSTOMER_ID_HERE");
//ID of the ad group to which ads are added.
long adGroupId = long.Parse("INSERT_ADGROUP_ID_HERE");
codeExample.Run(new GoogleAdsClient(), customerId, adGroupId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description
{
get
{
return "This code example adds expanded text ads to a given ad group. To list " +
"ad groups, run GetAdGroups.cs.";
}
}
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The 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.V2.AdGroupAdService);
List<AdGroupAdOperation> operations = new List<AdGroupAdOperation>();
for (int i = 0; i < NUMBER_OF_ADS; i++)
{
// Create the ad group ad object.
AdGroupAd adGroupAd = new AdGroupAd
{
AdGroup = ResourceNames.AdGroup(customerId, adGroupId),
// Optional: Set the status.
Status = AdGroupAdStatus.Paused,
Ad = new Ad
{
FinalUrls = { "http://www.example.com/" + i },
ExpandedTextAd = new ExpandedTextAdInfo
{
Description = "Buy your tickets now!",
HeadlinePart1 = "Cruise #" + i.ToString() + " to Mars",
HeadlinePart2 = "Best Space Cruise Line",
Path1 = "path1",
Path2 = "path2"
}
}
};
// Create the operation.
operations.Add(new AdGroupAdOperation
{
Create = adGroupAd
});
}
try
{
// Create the ads.
MutateAdGroupAdsResponse response = adGroupAdService.MutateAdGroupAds(
customerId.ToString(), operations);
// Display the results.
foreach (MutateAdGroupAdResult result in response.Results)
{
Console.WriteLine("Expanded text ad created with resource name: {0}",
result.ResourceName);
}
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
}
}
}
}
PHP
<?php
/**
* Copyright 2018 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\Lib\V2\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V2\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V2\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Util\V2\ResourceNames;
use Google\Ads\GoogleAds\V2\Common\ExpandedTextAdInfo;
use Google\Ads\GoogleAds\V2\Enums\AdGroupAdStatusEnum\AdGroupAdStatus;
use Google\Ads\GoogleAds\V2\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V2\Resources\Ad;
use Google\Ads\GoogleAds\V2\Resources\AdGroupAd;
use Google\Ads\GoogleAds\V2\Services\AdGroupAdOperation;
use Google\ApiCore\ApiException;
use Google\Protobuf\StringValue;
/** This example demonstrates how to add expanded text ads to a given ad group. */
class AddExpandedTextAds
{
const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
const AD_GROUP_ID = 'INSERT_AD_GROUP_ID_HERE';
// Specify the number of ads to be added in this example.
const NUMBER_OF_ADS_TO_ADD = 2;
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
);
}
} catch (ApiException $apiException) {
printf(
"ApiException was thrown with message '%s'.%s",
$apiException->getMessage(),
PHP_EOL
);
}
}
/**
* 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 expanded text ads to
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $adGroupId
) {
$adGroupResourceName =
new StringValue(['value' => ResourceNames::forAdGroup($customerId, $adGroupId)]);
$operations = [];
for ($i = 0; $i < self::NUMBER_OF_ADS_TO_ADD; $i++) {
// Creates the expanded text ad info.
$expandedTextAdInfo = new ExpandedTextAdInfo([
'headline_part1' => new StringValue(['value' => 'Cruise to Mars #' . uniqid()]),
'headline_part2' => new StringValue(['value' => 'Best Space Cruise Line']),
'description' => new StringValue(['value' => 'Buy your tickets now!'])
]);
// Sets the expanded text ad info on an Ad.
$ad = new Ad([
'expanded_text_ad' => $expandedTextAdInfo,
'final_urls' => [new StringValue(['value' => 'http://www.example.com'])]
]);
// Creates an ad group ad to hold the above ad.
$adGroupAd = new AdGroupAd([
'ad_group' => $adGroupResourceName,
'status' => AdGroupAdStatus::PAUSED,
'ad' => $ad
]);
// Creates an ad group ad operation and add it to the operations array.
$adGroupAdOperation = new AdGroupAdOperation();
$adGroupAdOperation->setCreate($adGroupAd);
$operations[] = $adGroupAdOperation;
}
// Issues a mutate request to add the ad group ads.
$adGroupAdServiceClient = $googleAdsClient->getAdGroupAdServiceClient();
$response = $adGroupAdServiceClient->mutateAdGroupAds($customerId, $operations);
foreach ($response->getResults() as $addedAdGroupAd) {
/** @var AdGroupAd $addedAdGroupAd */
printf(
"Expanded text ad was created with resource name: '%s'%s",
$addedAdGroupAd->getResourceName(),
PHP_EOL
);
}
}
}
AddExpandedTextAds::main();
Python
#!/usr/bin/env python
# Copyright 2018 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 an expanded text ad.
To get expanded text ads, run get_expanded_text_ads.py.
"""
import argparse
import sys
import uuid
import google.ads.google_ads.client
def main(client, customer_id, ad_group_id, number_of_ads):
ad_group_ad_service = client.get_service('AdGroupAdService', version='v2')
ad_group_service = client.get_service('AdGroupService', version='v2')
ad_group_ad_operations = []
for i in range(number_of_ads):
# Create ad group ad.
ad_group_ad_operation = client.get_type('AdGroupAdOperation', version='v2')
ad_group_ad = ad_group_ad_operation.create
ad_group_ad.ad_group.value = ad_group_service.ad_group_path(
customer_id, ad_group_id)
ad_group_ad.status = client.get_type('AdGroupAdStatusEnum',
version='v2').PAUSED
# Set expanded text ad info
final_url = ad_group_ad.ad.final_urls.add()
final_url.value = 'http://www.example.com'
ad_group_ad.ad.expanded_text_ad.description.value = 'Buy your tickets now!'
ad_group_ad.ad.expanded_text_ad.headline_part1.value = (
'Cruise {} to Mars {}'.format(i, str(uuid.uuid4())[:8]))
ad_group_ad.ad.expanded_text_ad.headline_part2.value = (
'Best space cruise line')
ad_group_ad.ad.expanded_text_ad.path1.value = 'all-inclusive'
ad_group_ad.ad.expanded_text_ad.path2.value = 'deals'
ad_group_ad_operations.append(ad_group_ad_operation)
try:
ad_group_ad_response = ad_group_ad_service.mutate_ad_group_ads(
customer_id, ad_group_ad_operations)
except google.ads.google_ads.errors.GoogleAdsException as ex:
print('Request with ID "{}" failed with status "{}" and includes the '
'following errors:'.format(ex.request_id, ex.error.code().name))
for error in ex.failure.errors:
print('\tError with message "{}".'.format(error.message))
if error.location:
for field_path_element in error.location.field_path_elements:
print('\t\tOn field: {}'.format(field_path_element.field_name))
sys.exit(1)
for result in ad_group_ad_response.results:
print('Created ad group ad {}.'.format(result.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 = (google.ads.google_ads.client.GoogleAdsClient
.load_from_storage())
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.')
parser.add_argument('-n', '--number_of_ads', type=int,
required=False, default=1, help='The number of ads.')
args = parser.parse_args()
main(google_ads_client, args.customer_id, args.ad_group_id, args.number_of_ads)
Ruby
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright 2018 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 an expanded text ad. To get expanded text ads,
# run get_expanded_text_ads.rb.
require 'optparse'
require 'google/ads/google_ads'
require 'date'
def add_expanded_text_ads(customer_id, ad_group_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
# Create an ad group ad.
ad_group_ad = client.resource.ad_group_ad do |aga|
aga.ad_group = client.path.ad_group(customer_id, ad_group_id)
aga.status = :PAUSED
aga.ad = client.resource.ad do |ad|
ad.final_urls << "http://www.example.com"
# Set expanded text ad info
ad.expanded_text_ad = client.resource.expanded_text_ad_info do |eta|
eta.description = "Buy your tickets now!"
eta.headline_part1 = "Cruise to Mars #{(Time.new.to_f * 100).to_i}"
eta.headline_part2 = "Best Space Cruise Line"
eta.path1 = "all-inclusive"
eta.path2 = "deals"
end
end
end
# Create the operation.
ad_group_ad_operation = client.operation.create_resource.ad_group_ad(ad_group_ad)
# Add the ad group ad.
response = client.service.ad_group_ad.mutate_ad_group_ads(
customer_id, [ad_group_ad_operation])
puts "Created expanded text ad #{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, 'AdGroup 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_expanded_text_ads(options.fetch(:customer_id).tr("-", ""), options[: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
rescue Google::Gax::RetryError => e
STDERR.printf("Error: '%s'\n\tCause: '%s'\n\tCode: %d\n\tDetails: '%s'\n" \
"\tRequest-Id: '%s'\n", e.message, e.cause.message, e.cause.code,
e.cause.details, e.cause.metadata['request-id'])
end
end