Java
// 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.
package com.google.ads.googleads.examples.remarketing;
import static com.google.ads.googleads.examples.utils.CodeSampleHelper.getPrintableDateTime;
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.v10.common.TagSnippet;
import com.google.ads.googleads.v10.errors.GoogleAdsError;
import com.google.ads.googleads.v10.errors.GoogleAdsException;
import com.google.ads.googleads.v10.resources.RemarketingAction;
import com.google.ads.googleads.v10.services.GoogleAdsRow;
import com.google.ads.googleads.v10.services.GoogleAdsServiceClient;
import com.google.ads.googleads.v10.services.GoogleAdsServiceClient.SearchPagedResponse;
import com.google.ads.googleads.v10.services.MutateRemarketingActionsResponse;
import com.google.ads.googleads.v10.services.RemarketingActionOperation;
import com.google.ads.googleads.v10.services.RemarketingActionServiceClient;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Collections;
/** Adds a new remarketing action to the customer and then retrieves its associated tag snippets. */
public class AddRemarketingAction {
private static class AddRemarketingActionParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private Long customerId;
}
public static void main(String[] args) {
AddRemarketingActionParams params = new AddRemarketingActionParams();
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");
}
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 AddRemarketingAction().runExample(googleAdsClient, params.customerId);
} 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.
* @throws GoogleAdsException if an API request failed with one or more service errors.
*/
private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
// Creates a remarketing action with the specified name.
RemarketingAction remarketingAction =
RemarketingAction.newBuilder()
.setName("Remarketing action #" + getPrintableDateTime())
.build();
// Creates a remarketing action operation.
RemarketingActionOperation operation =
RemarketingActionOperation.newBuilder().setCreate(remarketingAction).build();
// Issues a mutate request to add the remarketing action and prints out some information.
String remarketingActionResourceName;
try (RemarketingActionServiceClient conversionActionServiceClient =
googleAdsClient.getLatestVersion().createRemarketingActionServiceClient()) {
MutateRemarketingActionsResponse response =
conversionActionServiceClient.mutateRemarketingActions(
Long.toString(customerId), Collections.singletonList(operation));
remarketingActionResourceName = response.getResults(0).getResourceName();
System.out.printf(
"Added remarketing action with resource name '%s'.%n", remarketingActionResourceName);
}
// Creates a query that retrieves the previously created remarketing action with its generated
// tag snippets.
String query =
String.format(
"SELECT remarketing_action.id,"
+ " remarketing_action.name,"
+ " remarketing_action.tag_snippets "
+ "FROM remarketing_action "
+ "WHERE remarketing_action.resource_name = '%s'",
remarketingActionResourceName);
try (GoogleAdsServiceClient googleAdsServiceClient =
googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
// Issues a search request.
SearchPagedResponse searchPagedResponse =
googleAdsServiceClient.search(Long.toString(customerId), query);
// There is only one row because we limited the search using the resource name, which is
// unique.
GoogleAdsRow googleAdsRow = searchPagedResponse.iterateAll().iterator().next();
// Prints some attributes of the remarketing action. The ID and tag snippets are generated by
// the API.
RemarketingAction newRemarketingAction = googleAdsRow.getRemarketingAction();
System.out.printf(
"Remarketing action has ID %d and name '%s'.%n%n",
newRemarketingAction.getId(), newRemarketingAction.getName());
System.out.println("It has the following generated tag snippets:");
for (TagSnippet tagSnippet : newRemarketingAction.getTagSnippetsList()) {
System.out.printf(
"Tag snippet with code type '%s' and code page format '%s' has the following global"
+ " site tag:%n%s%n",
tagSnippet.getType(), tagSnippet.getPageFormat(), tagSnippet.getGlobalSiteTag());
System.out.printf("and the following event snippet:%n%s%n%n", tagSnippet.getEventSnippet());
}
}
}
}
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.V10.Common;
using Google.Ads.GoogleAds.V10.Errors;
using Google.Ads.GoogleAds.V10.Resources;
using Google.Ads.GoogleAds.V10.Services;
using System;
using System.Collections.Generic;
using System.Linq;
namespace Google.Ads.GoogleAds.Examples.V10
{
/// <summary>
/// This code example adds a new remarketing action to the customer and then retrieves its
/// associated tag snippets.
/// </summary>
public class AddRemarketingAction : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="AddRemarketingAction"/> example.
/// </summary>
public class Options : OptionsBase
{
/// <summary>
/// The Google Ads customer ID for which the conversion action is added.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The Google Ads customer ID for which the conversion action is added.")]
public long CustomerId { 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 = new Options();
CommandLine.Parser.Default.ParseArguments<Options>(args).MapResult(
delegate (Options o)
{
options = o;
return 0;
}, delegate (IEnumerable<Error> errors)
{
// The Google Ads customer ID for which the conversion action is added.
options.CustomerId = long.Parse("INSERT_CUSTOMER_ID_HERE");
return 0;
});
AddRemarketingAction codeExample = new AddRemarketingAction();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(), options.CustomerId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"This code example adds a new remarketing action to the customer and then retrieves " +
"its associated tag snippets.";
/// <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 conversion action is
/// added.</param>
public void Run(GoogleAdsClient client, long customerId)
{
// Get the RemarketingActionService.
RemarketingActionServiceClient remarketingActionService =
client.GetService(Services.V10.RemarketingActionService);
// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService =
client.GetService(Services.V10.GoogleAdsService);
try
{
// Creates a remarketing action with the specified name.
RemarketingAction remarketingAction = new RemarketingAction()
{
Name = $"Remarketing action # {ExampleUtilities.GetRandomString()}"
};
// Creates a remarketing action operation.
RemarketingActionOperation remarketingActionOperation =
new RemarketingActionOperation()
{
Create = remarketingAction
};
// Issues a mutate request to add the remarketing action and prints out
// some information.
MutateRemarketingActionsResponse response =
remarketingActionService.MutateRemarketingActions(
customerId.ToString(), new[] { remarketingActionOperation });
string remarketingActionResourceName = response.Results[0].ResourceName;
Console.WriteLine($"Added remarketing action with resource name " +
$"'{remarketingActionResourceName}'.");
// Creates a query that retrieves the previously created remarketing action
// with its generated tag snippets.
var query = $"SELECT remarketing_action.id, remarketing_action.name, " +
$"remarketing_action.tag_snippets FROM remarketing_action " +
$"WHERE remarketing_action.resource_name = '{remarketingActionResourceName}'";
// Issues a search request and retrieve the results. There is only one row
// because we limited the search using the resource name, which is unique.
RemarketingAction result = googleAdsService.Search(customerId.ToString(), query)
.First()
.RemarketingAction;
// Display the result.
Console.WriteLine($"Remarketing action has ID {result.Id} and name" +
$" '{result.Id}'.");
Console.WriteLine("It has the following generated tag snippets:");
foreach (TagSnippet tagSnippet in result.TagSnippets)
{
Console.WriteLine($"Tag snippet with code type '{tagSnippet.Type}' and code " +
$"page format '{tagSnippet.PageFormat}' has the following global site " +
$"tag:{tagSnippet.GlobalSiteTag} \n\nand the following event snippet:" +
$"{tagSnippet.EventSnippet}.");
}
}
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 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.
*/
namespace Google\Ads\GoogleAds\Examples\Remarketing;
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\V10\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V10\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V10\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\V10\Common\TagSnippet;
use Google\Ads\GoogleAds\V10\Enums\TrackingCodePageFormatEnum\TrackingCodePageFormat;
use Google\Ads\GoogleAds\V10\Enums\TrackingCodeTypeEnum\TrackingCodeType;
use Google\Ads\GoogleAds\V10\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V10\Resources\RemarketingAction;
use Google\Ads\GoogleAds\V10\Services\GoogleAdsRow;
use Google\Ads\GoogleAds\V10\Services\RemarketingActionOperation;
use Google\ApiCore\ApiException;
/**
* This example adds a new remarketing action to the customer and then retrieves its associated
* tag snippets.
*/
class AddRemarketingAction
{
private const PAGE_SIZE = 1000;
private const CUSTOMER_ID = 'INSERT_CUSTOMER_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
]);
// 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
);
} 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
*/
public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
// Creates a remarketing action with the specified name.
$remarketingAction = new RemarketingAction([
'name' => 'Remarketing action #' . Helper::getPrintableDatetime()
]);
// Creates a remarketing action operation.
$remarketingActionOperation =
new RemarketingActionOperation(['create' => $remarketingAction]);
// Issues a mutate request to add the remarketing action and prints out some information.
$remarketingActionServiceClient = $googleAdsClient->getRemarketingActionServiceClient();
$response = $remarketingActionServiceClient->mutateRemarketingActions(
$customerId,
[$remarketingActionOperation]
);
$remarketingActionResourceName = $response->getResults()[0]->getResourceName();
printf(
"Added remarketing action with resource name '%s'.%s",
$remarketingActionResourceName,
PHP_EOL
);
// Creates a query that retrieves the previously created remarketing action with its
// generated tag snippets.
$query =
"SELECT remarketing_action.id, "
. "remarketing_action.name, "
. "remarketing_action.tag_snippets "
. "FROM remarketing_action "
. "WHERE remarketing_action.resource_name = '$remarketingActionResourceName'";
// Issues a search request by specifying page size.
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
$response =
$googleAdsServiceClient->search($customerId, $query, ['pageSize' => self::PAGE_SIZE]);
// There is only one row because we limited the search using the resource name, which is
// unique.
/** @var GoogleAdsRow $googleAdsRow */
$googleAdsRow = $response->iterateAllElements()->current();
// Prints some attributes of the remarketing action. The ID and tag snippets are generated
// by the API.
printf(
"Remarketing action has ID %d and name '%s'.%s%s",
$googleAdsRow->getRemarketingAction()->getId(),
$googleAdsRow->getRemarketingAction()->getName(),
PHP_EOL,
PHP_EOL
);
print 'It has the following generated tag snippets:' . PHP_EOL;
foreach ($googleAdsRow->getRemarketingAction()->getTagSnippets() as $tagSnippet) {
/** @var TagSnippet $tagSnippet */
printf(
"Tag snippet with code type '%s' and code page format '%s' has the following"
. " global site tag:%s%s%s",
TrackingCodeType::name($tagSnippet->getType()),
TrackingCodePageFormat::name($tagSnippet->getPageFormat()),
PHP_EOL,
$tagSnippet->getGlobalSiteTag(),
PHP_EOL
);
printf(
"and the following event snippet:%s%s%s%s",
PHP_EOL,
$tagSnippet->getEventSnippet(),
PHP_EOL,
PHP_EOL
);
}
}
}
AddRemarketingAction::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 demonstrates usage of remarketing actions.
A new remarketing action will be created for the specified customer, and its
associated tag snippets will be retrieved.
"""
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, page_size):
remarketing_action_resource_name = _add_remarketing_action(
client, customer_id
)
print(f'Created remarketing action "{remarketing_action_resource_name}".')
queried_remarketing_action = _query_remarketing_action(
client, customer_id, remarketing_action_resource_name, page_size
)
_print_remarketing_action_attributes(queried_remarketing_action)
def _add_remarketing_action(client, customer_id):
remarketing_action_service = client.get_service("RemarketingActionService")
remarketing_action_operation = client.get_type("RemarketingActionOperation")
remarketing_action = remarketing_action_operation.create
remarketing_action.name = f"Remarketing action #{uuid4()}"
try:
remarketing_action_response = (
remarketing_action_service.mutate_remarketing_actions(
customer_id=customer_id,
operations=[remarketing_action_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)
return remarketing_action_response.results[0].resource_name
def _query_remarketing_action(client, customer_id, resource_name, page_size):
"""Retrieves the previously created remarketing action with tag snippets.
Args:
client: the Google Ads client
customer_id: the Google Ads customer ID
resource_name: the resource name of the remarketing action to query
page_size: the number of rows to return per page
Returns:
the found remarketing action
"""
query = f"""
SELECT
remarketing_action.id,
remarketing_action.name,
remarketing_action.tag_snippets
FROM remarketing_action
WHERE remarketing_action.resource_name = '{resource_name}'"""
googleads_service_client = client.get_service("GoogleAdsService")
search_request = client.get_type("SearchGoogleAdsRequest")
search_request.customer_id = customer_id
search_request.query = query
search_request.page_size = page_size
results = googleads_service_client.search(search_request)
try:
return list(results)[0].remarketing_action
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)
def _print_remarketing_action_attributes(remarketing_action):
print(
f"Remarketing action has ID {remarketing_action.id} and name "
f'"{remarketing_action.name}". \nIt has the following '
"generated tag snippets:\n"
)
for tag_snippet in remarketing_action.tag_snippets:
tracking_code_type = tag_snippet.type_.name
tracking_code_page_format = tag_snippet.page_format.name
print("=" * 80)
print(
f'Tag snippet with code type "{tracking_code_type}", and code '
f'page format "{tracking_code_page_format}" has the following:\n'
)
print("-" * 80)
print(f"Global site tag: \n\n{tag_snippet.global_site_tag}")
print("-" * 80)
print(f"Event snippet: \n\n{tag_snippet.event_snippet}")
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="v10")
parser = argparse.ArgumentParser(
description="Adds a remarketing action for specified customer."
)
# 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.",
)
# The following argument(s) are optional.
parser.add_argument(
"-p",
"--page_size",
type=int,
default=1000,
help="Number of pages to be returned in the response.",
)
args = parser.parse_args()
main(googleads_client, args.customer_id, args.page_size)
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 new remarketing action to the customer and then retrieves
# its associated tag snippets.
require 'optparse'
require 'google/ads/google_ads'
require 'date'
def add_remarketing_action(customer_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
# Step 1: Create a remarketing action.
operation = client.operation.create_resource.remarketing_action do |action|
action.name = "Remarketing action ##{(Time.new.to_f * 100).to_i}"
end
response = client.service.remarketing_action.mutate_remarketing_actions(
customer_id: customer_id,
operations: [operation],
)
remarketing_action_resource_name = response.results.first.resource_name
# Step 2: Look up the remarketing action we created to get some extra
# information about it, like its tag snippets.
query = <<~EOQUERY
SELECT
remarketing_action.id,
remarketing_action.name,
remarketing_action.tag_snippets
FROM
remarketing_action
WHERE
remarketing_action.resource_name = "#{remarketing_action_resource_name}"
EOQUERY
response = client.service.google_ads.search(
customer_id: customer_id,
query: query,
)
action = response.first.remarketing_action
puts "Remarking action has ID #{action.id} and name '#{action.name}.'"
puts "It has the following generated tag snippets:"
action.tag_snippets.each do |ts|
puts "Tag snippet with code type '#{ts.type}' and code page format " \
"'#{ts.page_format}' has the following global site tag:\n#{ts.global_site_tag}"
puts "and the following event snippet:\n#{ts.event_snippet}"
end
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'
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.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
add_remarketing_action(options.fetch(:customer_id).tr("-", ""))
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 new remarketing action to the customer and then retrieves
# its associated tag snippets.
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::V10::Resources::RemarketingAction;
use
Google::Ads::GoogleAds::V10::Services::RemarketingActionService::RemarketingActionOperation;
use Getopt::Long qw(:config auto_help);
use Pod::Usage;
use Cwd qw(abs_path);
use Data::Uniqid qw(uniqid);
use constant PAGE_SIZE => 1000;
# 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";
sub add_remarketing_action {
my ($api_client, $customer_id) = @_;
# Create a remarketing action with the specified name.
my $remarketing_action =
Google::Ads::GoogleAds::V10::Resources::RemarketingAction->new({
name => "Remarketing action #" . uniqid()});
# Create a remarketing action operation.
my $remarketing_action_operation =
Google::Ads::GoogleAds::V10::Services::RemarketingActionService::RemarketingActionOperation
->new({
create => $remarketing_action
});
# Issue a mutate request to add the remarketing action and print out some information.
my $remarketing_actions_response =
$api_client->RemarketingActionService()->mutate({
customerId => $customer_id,
operations => [$remarketing_action_operation]});
my $remarketing_action_resource_name =
$remarketing_actions_response->{results}[0]{resourceName};
printf
"Added remarketing action with resource name '%s'.\n",
$remarketing_action_resource_name;
# Create a query that retrieves the previously created remarketing action with
# its generated tag snippets.
my $search_query =
sprintf "SELECT remarketing_action.id, remarketing_action.name, " .
"remarketing_action.tag_snippets FROM remarketing_action " .
"WHERE remarketing_action.resource_name = '%s'",
$remarketing_action_resource_name;
# Issue a search request by specifying page size.
my $search_response = $api_client->GoogleAdsService()->search({
customerId => $customer_id,
query => $search_query,
pageSize => PAGE_SIZE
});
# There is only one row because we limited the search using the resource name,
# which is unique.
my $google_ads_row = $search_response->{results}[0];
# Print some attributes of the remarketing action. The ID and tag snippets are
# generated by the API.
printf
"Remarketing action has ID %d and name '%s'.\n\n",
$google_ads_row->{remarketingAction}{id},
$google_ads_row->{remarketingAction}{name};
print "It has the following generated tag snippets:\n";
foreach my $tag_snippet (@{$google_ads_row->{remarketingAction}{tagSnippets}})
{
printf "Tag snippet with code type '%s' and code page format '%s' " .
"has the following global site tag:\n%s\n",
$tag_snippet->{type},
$tag_snippet->{pageFormat},
$tag_snippet->{globalSiteTag};
printf "and the following event snippet:\n%s\n\n",
$tag_snippet->{eventSnippet};
}
return 1;
}
# 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);
# 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);
# Call the example.
add_remarketing_action($api_client, $customer_id =~ s/-//gr);
=pod
=head1 NAME
add_remarketing_action
=head1 DESCRIPTION
This example adds a new remarketing action to the customer and then retrieves its
associated tag snippets.
=head1 SYNOPSIS
add_remarketing_action.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
=cut
