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.errorhandling;
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.v14.common.AdTextAsset;
import com.google.ads.googleads.v14.common.PolicyTopicEntry;
import com.google.ads.googleads.v14.enums.AdGroupAdStatusEnum.AdGroupAdStatus;
import com.google.ads.googleads.v14.errors.ErrorCode.ErrorCodeCase;
import com.google.ads.googleads.v14.errors.GoogleAdsError;
import com.google.ads.googleads.v14.errors.GoogleAdsException;
import com.google.ads.googleads.v14.errors.PolicyFindingDetails;
import com.google.ads.googleads.v14.resources.AdGroupAd;
import com.google.ads.googleads.v14.services.AdGroupAdOperation;
import com.google.ads.googleads.v14.services.AdGroupAdServiceClient;
import com.google.ads.googleads.v14.services.MutateAdGroupAdsResponse;
import com.google.ads.googleads.v14.utils.ResourceNames;
import com.google.common.collect.ImmutableList;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/**
* Demonstrates how to request an exemption for policy violations of a responsive search ad. If the
* request somehow fails with exceptions that are not policy finding errors, the example will stop
* instead of trying sending an exemption request.
*/
public class HandleResponsiveSearchAdPolicyViolations {
private static class HandleResponsiveSearchAdPolicyViolationsParams 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) {
HandleResponsiveSearchAdPolicyViolationsParams params =
new HandleResponsiveSearchAdPolicyViolationsParams();
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");
params.adGroupId = Long.parseLong("INSERT_AD_GROUP_ID");
}
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 HandleResponsiveSearchAdPolicyViolations()
.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 client to use.
* @param customerId the customer ID.
* @param adGroupId the ad group ID.
*/
public void runExample(GoogleAdsClient googleAdsClient, long customerId, long adGroupId) {
// Creates an ad group ad for the specified ad group.
AdGroupAd.Builder adGroupAdBuilder =
AdGroupAd.newBuilder()
.setAdGroup(ResourceNames.adGroup(customerId, adGroupId))
.setStatus(AdGroupAdStatus.PAUSED);
adGroupAdBuilder
.getAdBuilder()
// Sets the final URLS.
.addFinalUrls("https://www.example.com")
// Adds a responsive search ad.
.getResponsiveSearchAdBuilder()
.addAllHeadlines(
ImmutableList.of(
AdTextAsset.newBuilder()
.setText("Cruise to Mars #" + getShortPrintableDateTime())
.build(),
AdTextAsset.newBuilder().setText("Best Space Cruise Line").build(),
AdTextAsset.newBuilder().setText("Experience the Stars").build()))
.addAllDescriptions(
ImmutableList.of(
// Intentionally uses an ad text that violates policy - too many exclamation marks.
AdTextAsset.newBuilder().setText("Buy your tickets now!!!!!!!").build(),
AdTextAsset.newBuilder().setText("Visit the Red Planet").build()));
// Constructs an operation to send to the API.
AdGroupAdOperation operation =
AdGroupAdOperation.newBuilder().setCreate(adGroupAdBuilder.build()).build();
// Connects to the API. Note that we could use try-with-resources, however doing so would
// require that we either (1) need to reconnect to the API for requesting the exemption, or (2)
// introduce a doubly nested try-catch structure here.
AdGroupAdServiceClient client =
googleAdsClient.getLatestVersion().createAdGroupAdServiceClient();
try {
// Sends the request which we expect to fail with policy violations.
client.mutateAdGroupAds(String.valueOf(customerId), ImmutableList.of(operation));
} catch (GoogleAdsException ex) {
// Retrieves the ignorable policy topics.
List<String> ignorablePolicyTopics = fetchIgnorablePolicyTopics(ex);
// Requests an exemption to add the creative with the known violations.
requestExemption(ignorablePolicyTopics, client, operation, customerId);
} finally {
// Disconnects the API connection. Very important!
client.close();
}
}
/**
* Collects all ignorable policy topics that will be sent for exemption request later.
*
* @param gae the Google Ads exception.
* @return the ignorable policy topics.
*/
private List<String> fetchIgnorablePolicyTopics(GoogleAdsException gae) {
System.out.println("Google Ads failure details:");
// Creates a list to store the result.
List<String> ignorableTopics = new ArrayList<>();
// Searches all errors for ignorable policy topics.
for (GoogleAdsError error : gae.getGoogleAdsFailure().getErrorsList()) {
// Supports sending exemption request for the policy finding error only.
if (error.getErrorCode().getErrorCodeCase() != ErrorCodeCase.POLICY_FINDING_ERROR) {
throw gae;
}
// Shows some information about the error encountered.
System.out.printf("\t%s: %s%n", error.getErrorCode().getErrorCodeCase(), error.getMessage());
// Checks policy finding details for ignorable policy topics.
if (error.getDetails() != null) {
PolicyFindingDetails policyFindingDetails = error.getDetails().getPolicyFindingDetails();
if (policyFindingDetails != null) {
System.out.println("\tPolicy finding details:");
// Shows all the policy topics for the current error.
for (PolicyTopicEntry policyTopicEntry :
policyFindingDetails.getPolicyTopicEntriesList()) {
// Adds this topic to the result.
ignorableTopics.add(policyTopicEntry.getTopic());
System.out.printf("\t\tPolicy topic name: '%s'%n", policyTopicEntry.getTopic());
System.out.printf("\t\tPolicy topic entry type: '%s'%n", policyTopicEntry.getType());
// For the sake of brevity, we exclude printing "policy topic evidences" and
// "policy topic constraints" here. You can fetch those data by calling:
// - policyTopicEntry.getEvidences()
// - policyTopicEntry.getConstraints()
}
}
}
}
return ignorableTopics;
}
/**
* Sends exemption requests for creating a responsive search ad.
*
* @param ignorablePolicyTopics topics to request exemption for.
* @param client client to use for API access.
* @param operation operation which generated original violations.
* @param customerID the customer ID to operate on.
*/
private void requestExemption(
List<String> ignorablePolicyTopics,
AdGroupAdServiceClient client,
AdGroupAdOperation operation,
long customerID) {
System.out.println(
"Trying to add a responsive search ad again by requesting exemption for its policy"
+ " violations.");
// Converts the operation back to a builder.
AdGroupAdOperation.Builder operationBuilder = operation.toBuilder();
// Adds the exemption request.
operationBuilder
.getPolicyValidationParameterBuilder()
.addAllIgnorablePolicyTopics(ignorablePolicyTopics);
// Sends the request back to the API.
MutateAdGroupAdsResponse response =
client.mutateAdGroupAds(
String.valueOf(customerID), ImmutableList.of(operationBuilder.build()));
// Shows the newly added ad resource name.
System.out.printf(
"Successfully added a responsive search ad with resource name '%s' by requesting a policy"
+ " violation exemption.%n",
response.getResults(0).getResourceName());
}
}
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.V14.Common;
using Google.Ads.GoogleAds.V14.Errors;
using Google.Ads.GoogleAds.V14.Resources;
using Google.Ads.GoogleAds.V14.Services;
using System;
using System.Collections.Generic;
using static Google.Ads.GoogleAds.V14.Enums.AdGroupAdStatusEnum.Types;
namespace Google.Ads.GoogleAds.Examples.V14
{
/// <summary>
/// This code example demonstrates how to request an exemption for policy violations of a
/// responsive search ad. If the request somehow fails with exceptions that are not policy finding
/// errors, the code example will stop instead of trying to send an exemption request.
/// </summary>
public class HandleResponsiveSearchAdPolicyViolations : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="HandleResponsiveSearchAdPolicyViolations"/>
/// example.
/// </summary>
public class Options : OptionsBase
{
/// <summary>
/// The customer ID for which the call is made.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The 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);
HandleResponsiveSearchAdPolicyViolations codeExample =
new HandleResponsiveSearchAdPolicyViolations();
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 demonstrates how to request an exemption for policy violations of " +
"a responsive search ad. If the request somehow fails with exceptions that are not " +
"policy finding errors, the code example will stop instead of trying to send an " +
"exemption request.";
/// <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 AdGroupAdServiceClient.
AdGroupAdServiceClient adGroupAdService = client.GetService(
Services.V14.AdGroupAdService);
string adGroupResourceName = ResourceNames.AdGroup(customerId, adGroupId);
ResponsiveSearchAdInfo responsiveSearchAdInfo = new ResponsiveSearchAdInfo()
{
Headlines = {
new AdTextAsset() { Text = $"Cruise to Mars #{ExampleUtilities.GetShortRandomString()}" },
new AdTextAsset() { Text = "Best Space Cruise Line" },
new AdTextAsset() { Text = "Experience the Stars" }
},
Descriptions = {
// Intentionally use an ad text that violates policy -- having too many exclamation
// marks.
new AdTextAsset() { Text = "Buy your tickets now!!!!!!!" },
new AdTextAsset() { Text = "Visit the Red Planet" }
}
};
// Creates an ad group ad to hold the above ad.
AdGroupAd adGroupAd = new AdGroupAd()
{
AdGroup = adGroupResourceName,
// Set the ad group ad to PAUSED to prevent it from immediately serving.
// Set to ENABLED once you've added targeting and the ad are ready to serve.
Status = AdGroupAdStatus.Paused,
// Sets the responsive search ad info on an Ad.
Ad = new Ad()
{
ResponsiveSearchAd = responsiveSearchAdInfo,
FinalUrls = { "https://www.example.com" }
}
};
// Creates an ad group ad operation.
AdGroupAdOperation operation = new AdGroupAdOperation()
{
Create = adGroupAd
};
try
{
try
{
// Try sending a mutate request to add the ad group ad.
adGroupAdService.MutateAdGroupAds(customerId.ToString(), new[] { operation });
}
catch (GoogleAdsException ex)
{
// The request will always fail because of the policy violation in the
// description of the ad.
var ignorablePolicyTopics = FetchIgnorablePolicyTopics(ex);
// Try sending exemption requests for creating a responsive search ad.
RequestExemption(customerId, adGroupAdService, operation, ignorablePolicyTopics);
}
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
throw;
}
}
/// <summary>
/// Collects all ignorable policy topics that will be sent for exemption request later.
/// </summary>
/// <param name="ex">The API exception from a previous call to add ad group ads.</param>
/// <returns>The ignorable policy topics</returns>
private static string[] FetchIgnorablePolicyTopics(GoogleAdsException ex)
{
List<string> ignorablePolicyTopics = new List<string>(); ;
Console.WriteLine("Google Ads failure details:");
foreach (GoogleAdsError error in ex.Failure.Errors)
{
if (error.ErrorCode.ErrorCodeCase != ErrorCode.ErrorCodeOneofCase.PolicyFindingError)
{
throw ex;
}
if (error.Details != null && error.Details.PolicyFindingDetails != null)
{
PolicyFindingDetails details = error.Details.PolicyFindingDetails;
Console.WriteLine($"- Policy finding details:");
foreach (PolicyTopicEntry entry in details.PolicyTopicEntries)
{
ignorablePolicyTopics.Add(entry.Topic);
Console.WriteLine($" - Policy topic name: '{entry.Topic}'");
Console.WriteLine($" - Policy topic entry type: '{entry.Type}'");
// For the sake of brevity, we exclude printing "policy topic evidences"
// and "policy topic constraints" here. You can fetch those data by
// calling:
// - entry.Evidences
// - entry.Constraints
}
}
}
return ignorablePolicyTopics.ToArray();
}
/// <summary>
/// Sends exemption requests for creating a responsive search ad.
/// </summary>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <param name="service">The ad group ad service.</param>
/// <param name="operation">The ad group ad operation to request exemption for.</param>
/// <param name="ignorablePolicyTopics">The ignorable policy topics.</param>
private static void RequestExemption(long customerId, AdGroupAdServiceClient service,
AdGroupAdOperation operation, string[] ignorablePolicyTopics)
{
Console.WriteLine("Try adding a responsive search ad again by requesting exemption for " +
"its policy violations.");
PolicyValidationParameter validationParameter = new PolicyValidationParameter();
validationParameter.IgnorablePolicyTopics.AddRange(ignorablePolicyTopics);
operation.PolicyValidationParameter = validationParameter;
MutateAdGroupAdsResponse response = service.MutateAdGroupAds(
customerId.ToString(), new[] { operation });
Console.WriteLine($"Successfully added a responsive search ad with resource name " +
$"'{response.Results[0].ResourceName}' by requesting for policy violation " +
$"exemption.");
}
}
}
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\ErrorHandling;
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\V14\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V14\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V14\GoogleAdsException;
use Google\Ads\GoogleAds\Util\V14\ResourceNames;
use Google\Ads\GoogleAds\V14\Common\AdTextAsset;
use Google\Ads\GoogleAds\V14\Common\PolicyTopicEntry;
use Google\Ads\GoogleAds\V14\Common\PolicyValidationParameter;
use Google\Ads\GoogleAds\V14\Common\ResponsiveSearchAdInfo;
use Google\Ads\GoogleAds\V14\Enums\AdGroupAdStatusEnum\AdGroupAdStatus;
use Google\Ads\GoogleAds\V14\Enums\PolicyTopicEntryTypeEnum\PolicyTopicEntryType;
use Google\Ads\GoogleAds\V14\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V14\Resources\Ad;
use Google\Ads\GoogleAds\V14\Resources\AdGroupAd;
use Google\Ads\GoogleAds\V14\Services\AdGroupAdOperation;
use Google\Ads\GoogleAds\V14\Services\Client\AdGroupAdServiceClient;
use Google\Ads\GoogleAds\V14\Services\MutateAdGroupAdsRequest;
use Google\ApiCore\ApiException;
/**
* This example demonstrates how to request an exemption for policy violations of a responsive
* search ad. If the request somehow fails with exceptions that are not policy finding errors, the
* example will stop instead of trying sending an exemption request.
*/
class HandleResponsiveSearchAdPolicyViolations
{
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)
// We set this value to true to show how to use GAPIC v2 source code. You can remove the
// below line if you wish to use the old-style source code. Note that in that case, you
// probably need to modify some parts of the code below to make it work.
// For more information, see
// https://developers.devsite.corp.google.com/google-ads/api/docs/client-libs/php/gapic.
->usingGapicV2Source(true)
->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 a responsive search ad info object.
$responsiveSearchAdInfo = new ResponsiveSearchAdInfo([
'headlines' => [
new AdTextAsset([
'text' => 'Cruise to Mars #' . Helper::getShortPrintableDatetime()
]),
new AdTextAsset(['text' => 'Best Space Cruise Line']),
new AdTextAsset(['text' => 'Experience the Stars'])
],
// Intentionally use an ad text that violates policy -- having too many exclamation
// marks.
'descriptions' => [
new AdTextAsset(['text' => 'Buy your tickets now!!!!!!!']),
new AdTextAsset(['text' => 'Visit the Red Planet'])
]
]);
// Creates an ad group ad to hold the above ad.
$adGroupAd = new AdGroupAd([
'ad_group' => ResourceNames::forAdGroup($customerId, $adGroupId),
// Set the ad group ad to PAUSED to prevent it from immediately serving.
// Set to ENABLED once you've added targeting and the ad are ready to serve.
'status' => AdGroupAdStatus::PAUSED,
// Sets the responsive search ad info on an Ad.
'ad' => new Ad([
'responsive_search_ad' => $responsiveSearchAdInfo,
'final_urls' => ['https://www.example.com']
])
]);
// Creates an ad group ad operation.
$adGroupAdOperation = new AdGroupAdOperation();
$adGroupAdOperation->setCreate($adGroupAd);
$adGroupAdServiceClient = $googleAdsClient->getAdGroupAdServiceClient();
$ignorablePolicyTopics = [];
try {
// Try sending a mutate request to add the ad group ad.
$adGroupAdServiceClient->mutateAdGroupAds(
MutateAdGroupAdsRequest::build($customerId, [$adGroupAdOperation])
);
} catch (GoogleAdsException $googleAdsException) {
// The request will always fail because of the policy violation in the description of
// the ad.
$ignorablePolicyTopics = self::fetchIgnorablePolicyTopics($googleAdsException);
}
// Try sending exemption requests for creating a responsive search ad.
self::requestExemption(
$customerId,
$adGroupAdServiceClient,
$adGroupAdOperation,
$ignorablePolicyTopics
);
}
/**
* Collects all ignorable policy topics that will be sent for exemption request later.
*
* @param GoogleAdsException $googleAdsException the Google Ads exception
* @return string[] the ignorable policy topics
*/
private static function fetchIgnorablePolicyTopics(GoogleAdsException $googleAdsException)
{
$ignorablePolicyTopics = [];
printf("Google Ads failure details:%s", PHP_EOL);
foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) {
/** @var GoogleAdsError $error */
if ($error->getErrorCode()->getErrorCode() !== 'policy_finding_error') {
// This example supports sending exemption request for the policy finding error
// only.
throw $googleAdsException;
}
printf(
"\t%s: %s%s",
$error->getErrorCode()->getErrorCode(),
$error->getMessage(),
PHP_EOL
);
if (
!is_null($error->getDetails())
&& !is_null($error->getDetails()->getPolicyFindingDetails())
) {
$policyFindingDetails = $error->getDetails()->getPolicyFindingDetails();
printf("\tPolicy finding details:%s", PHP_EOL);
foreach ($policyFindingDetails->getPolicyTopicEntries() as $policyTopicEntry) {
/** @var PolicyTopicEntry $policyTopicEntry */
$ignorablePolicyTopics[] = $policyTopicEntry->getTopic();
printf(
"\t\tPolicy topic name: '%s'%s",
$policyTopicEntry->getTopic(),
PHP_EOL
);
printf(
"\t\tPolicy topic entry type: '%s'%s",
PolicyTopicEntryType::name($policyTopicEntry->getType()),
PHP_EOL
);
// For the sake of brevity, we exclude printing "policy topic evidences" and
// "policy topic constraints" here. You can fetch those data by calling:
// - $policyTopicEntry->getEvidences()
// - $policyTopicEntry->getConstraints()
}
}
}
return $ignorablePolicyTopics;
}
/**
* Sends exemption requests for creating a responsive search ad.
*
* @param int $customerId
* @param AdGroupAdServiceClient $adGroupAdServiceClient
* @param AdGroupAdOperation $adGroupAdOperation
* @param string[] $ignorablePolicyTopics
*/
private static function requestExemption(
int $customerId,
AdGroupAdServiceClient $adGroupAdServiceClient,
AdGroupAdOperation $adGroupAdOperation,
array $ignorablePolicyTopics
) {
print "Try adding a responsive search ad again by requesting exemption for its policy"
. " violations." . PHP_EOL;
$adGroupAdOperation->setPolicyValidationParameter(
new PolicyValidationParameter(['ignorable_policy_topics' => $ignorablePolicyTopics])
);
$response = $adGroupAdServiceClient->mutateAdGroupAds(MutateAdGroupAdsRequest::build(
$customerId,
[$adGroupAdOperation]
));
printf(
"Successfully added a responsive search ad with resource name '%s' by requesting"
. " for policy violation exemption.%s",
$response->getResults()[0]->getResourceName(),
PHP_EOL
);
}
}
HandleResponsiveSearchAdPolicyViolations::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.
"""Requests an exemption for policy violations of a responsive search ad.
If the request somehow fails with exceptions that are not policy finding
errors, the example will stop instead of trying sending an exemption request.
"""
import argparse
import sys
import uuid
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
def main(client, customer_id, ad_group_id):
"""Uses Customer Match to create and add users to a new user list.
Args:
client: The Google Ads client.
customer_id: The customer ID for which to add the responsive search ad.
ad_group_id: The ad group ID to which to add a responsive search ad.
"""
ad_group_ad_service_client = client.get_service("AdGroupAdService")
ad_group_ad_operation = create_responsive_search_ad(
client, ad_group_ad_service_client, customer_id, ad_group_id
)
ignorable_policy_topics = []
try:
# Try sending a mutate request to add the ad group ad.
ad_group_ad_service_client.mutate_ad_group_ads(
customer_id=customer_id, operations=[ad_group_ad_operation]
)
except GoogleAdsException as googleads_exception:
# The request will always fail due to the policy violation in the
# ad's description.
ignorable_policy_topics = fetch_ignorable_policy_topics(
client, googleads_exception
)
request_exemption(
customer_id,
ad_group_ad_service_client,
ad_group_ad_operation,
ignorable_policy_topics,
)
def create_responsive_search_ad(
client, ad_group_ad_service_client, customer_id, ad_group_id
):
"""Create a responsive search ad that includes a policy violation.
Args:
client: The GoogleAds client instance.
ad_group_ad_service_client: The AdGroupAdService client instance.
customer_id: The customer ID for which to add the responsive search ad.
ad_group_id: The ad group ID to which to add a responsive search ad.
Returns:
The attempted AdGroupAdOperation instance.
"""
ad_group_resource_name = client.get_service("AdGroupService").ad_group_path(
customer_id, ad_group_id
)
# Creates an operation and ad group ad to create and hold the above ad.
ad_group_ad_operation = client.get_type("AdGroupAdOperation")
ad_group_ad = ad_group_ad_operation.create
ad_group_ad.ad_group = ad_group_resource_name
# Set the ad group ad to PAUSED to prevent it from immediately serving.
# Set to ENABLED once you've added targeting and the ad are ready to serve.
ad_group_ad.status = client.enums.AdGroupAdStatusEnum.PAUSED
# Sets the responsive search ad info on an ad.
responsive_search_ad_info = ad_group_ad.ad.responsive_search_ad
headline_1 = client.get_type("AdTextAsset")
headline_1.text = f"Cruise to Mars #{str(uuid.uuid4())[0:13]}"
headline_2 = client.get_type("AdTextAsset")
headline_2.text = "Best Space Cruise Line"
headline_3 = client.get_type("AdTextAsset")
headline_3.text = "Experience the Stars"
responsive_search_ad_info.headlines.extend(
[headline_1, headline_2, headline_3]
)
# Intentionally use an ad text that violates policy by having too many
# exclamation marks.
description_1 = client.get_type("AdTextAsset")
description_1.text = "Buy your tickets now!!!!!!!"
description_2 = client.get_type("AdTextAsset")
description_2.text = "Visit the Red Planet"
responsive_search_ad_info.descriptions.extend(
[description_1, description_2]
)
ad_group_ad.ad.final_urls.append("https://www.example.com")
return ad_group_ad_operation
def fetch_ignorable_policy_topics(client, googleads_exception):
"""Collects all ignorable policy topics to be sent for exemption request.
Args:
client: The GoogleAds client instance.
googleads_exception: The exception that contains the policy
violation(s).
Returns:
A list of ignorable policy topics.
"""
ignorable_policy_topics = []
print("Google Ads failure details:")
for error in googleads_exception.failure.errors:
if (
error.error_code.policy_finding_error
!= client.get_type(
"PolicyFindingErrorEnum"
).PolicyFindingError.POLICY_FINDING
):
print(
"This example supports sending exemption request for the "
"policy finding error only."
)
raise googleads_exception
print(f"\t{error.error_code.policy_finding_error}: {error.message}")
if (
error.details is not None
and error.details.policy_finding_details is not None
):
policy_finding_details = error.details.policy_finding_details
print("\tPolicy finding details:")
for (
policy_topic_entry
) in policy_finding_details.policy_topic_entries:
ignorable_policy_topics.append(policy_topic_entry.topic)
print(f"\t\tPolicy topic name: '{policy_topic_entry.topic}'")
print(
f"\t\tPolicy topic entry type: '{policy_topic_entry.type_}'"
)
# For the sake of brevity, we exclude printing "policy topic
# evidences" and "policy topic constraints" here. You can fetch
# those data by calling:
# - policy_topic_entry.evidences
# - policy_topic_entry.constraints
return ignorable_policy_topics
def request_exemption(
customer_id,
ad_group_ad_service_client,
ad_group_ad_operation,
ignorable_policy_topics,
):
"""Sends exemption requests for creating a responsive search ad.
Args:
customer_id: The customer ID for which to add the responsive search ad.
ad_group_ad_service_client: The AdGroupAdService client instance.
ad_group_ad_operation: The AdGroupAdOperation that returned policy
violation(s).
ignorable_policy_topics: The extracted list of policy topic entries.
"""
print(
"Attempting to add a responsive search ad again by requesting "
"exemption for its policy violations."
)
ad_group_ad_operation.policy_validation_parameter.ignorable_policy_topics.extend(
ignorable_policy_topics
)
response = ad_group_ad_service_client.mutate_ad_group_ads(
customer_id=customer_id, operations=[ad_group_ad_operation]
)
print(
"Successfully added a responsive search ad with resource name "
f"'{response.results[0].resource_name}' for policy violation "
"exemption."
)
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="v14")
parser = argparse.ArgumentParser(
description="Requests an exemption for responsive search ad policy "
"violations."
)
# 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 to which to add a responsive search ad.",
)
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
# 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.
#
# Requests an exemption for policy violations of a responsive search ad.
#
# If the request somehow fails with exceptions that are not policy finding
# errors, the example will stop instead of trying to send an exemption request.
require 'optparse'
require 'google/ads/google_ads'
require 'date'
def handle_responsive_search_ad_policy_violations(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
ad_group_ad_service = client.service.ad_group_ad
ad_group_ad_operation, ignorable_policy_topics = create_responsive_search_ad(
client,
ad_group_ad_service,
customer_id,
ad_group_id,
)
request_exemption(
client,
customer_id,
ad_group_ad_service,
ad_group_ad_operation,
ignorable_policy_topics,
)
end
def create_responsive_search_ad(client, ad_group_ad_service, customer_id, ad_group_id)
ad_group_ad_operation = client.operation.create_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"
ad.responsive_search_ad = client.resource.responsive_search_ad_info do |rsa|
rsa.headlines << client.resource.ad_text_asset do |ta|
ta.text = "Cruise to Mars ##{(Time.new.to_f * 1000).to_i}"
end
rsa.headlines << client.resource.ad_text_asset do |ta|
ta.text = "Best space cruise line"
end
rsa.headlines << client.resource.ad_text_asset do |ta|
ta.text = "Experience the stars"
end
rsa.descriptions << client.resource.ad_text_asset do |ta|
# Intentionally use an ad text that violates policy -- having too
# many exclamation marks.
ta.text = "Buy your tickets now!!!!!!!"
end
rsa.descriptions << client.resource.ad_text_asset do |ta|
ta.text = "Visit the Red Planet"
end
end
end
end
ignorable_policy_topics = []
begin
ad_group_ad_service.mutate_ad_group_ads(
customer_id: customer_id,
operations: [ad_group_ad_operation],
)
rescue Google::Ads::GoogleAds::Errors::GoogleAdsError => e
ignorable_policy_topics = fetch_ignorable_policy_topics(e)
end
return ad_group_ad_operation, ignorable_policy_topics
end
def fetch_ignorable_policy_topics(exception)
ignorable_policy_topics = []
exception.failure.errors.each do |error|
if error.error_code.policy_finding_error != :POLICY_FINDING
puts "Non-policy finding error found. Aborting."
raise exception
end
puts "#{error.error_code.policy_finding_error}: #{error.message}"
error&.details&.policy_finding_details&.policy_topic_entries.each do |entry|
ignorable_policy_topics << entry.topic
puts "\tPolicy topic name: #{entry.topic}"
puts "\tPolicy topic entry type: #{entry.type}"
end
end
ignorable_policy_topics
end
def request_exemption(
client, customer_id, ad_group_ad_service, ad_group_ad_operation, ignorable_policy_topics)
# Add all the found ignorable policy topics to the operation.
ad_group_ad_operation.policy_validation_parameter =
client.resource.policy_validation_parameter do |pvp|
pvp.ignorable_policy_topics.push(
*ignorable_policy_topics
)
end
response = ad_group_ad_service.mutate_ad_group_ads(
customer_id: customer_id,
operations: [ad_group_ad_operation],
)
puts "Successfully added a responsive search ad with resource name " \
"#{response.results.first.resource_name} for policy violation exception."
end
if __FILE__ == $PROGRAM_NAME
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: ruby %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
handle_responsive_search_ad_policy_violations(
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 demonstrates how to request an exemption for policy violations
# of a responsive search ad. If the request somehow fails with exceptions that are
# not policy finding errors, the example will stop instead of trying sending an
# exemption request.
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::V14::Resources::AdGroupAd;
use Google::Ads::GoogleAds::V14::Resources::Ad;
use Google::Ads::GoogleAds::V14::Common::AdTextAsset;
use Google::Ads::GoogleAds::V14::Common::ResponsiveSearchAdInfo;
use Google::Ads::GoogleAds::V14::Common::PolicyValidationParameter;
use Google::Ads::GoogleAds::V14::Enums::AdGroupStatusEnum qw(PAUSED);
use Google::Ads::GoogleAds::V14::Services::AdGroupAdService::AdGroupAdOperation;
use Google::Ads::GoogleAds::V14::Utils::ResourceNames;
use Getopt::Long qw(:config auto_help);
use Pod::Usage;
use Cwd qw(abs_path);
use Data::Uniqid qw(uniqid);
sub handle_responsive_search_ad_policy_violations {
my ($api_client, $customer_id, $ad_group_id) = @_;
my $ad_group_resource_name =
Google::Ads::GoogleAds::V14::Utils::ResourceNames::ad_group($customer_id,
$ad_group_id);
# Create a responsive search ad info object.
my $responsive_search_ad_info =
Google::Ads::GoogleAds::V14::Common::ResponsiveSearchAdInfo->new({
headlines => [
Google::Ads::GoogleAds::V14::Common::AdTextAsset->new({
text => "Cruise to Mars #" . uniqid()}
),
Google::Ads::GoogleAds::V14::Common::AdTextAsset->new({
text => "Best Space Cruise Line"
}
),
Google::Ads::GoogleAds::V14::Common::AdTextAsset->new({
text => "Experience the Stars"
})
],
descriptions => [
# Intentionally use an ad text that violates policy -- having too many
# exclamation marks.
Google::Ads::GoogleAds::V14::Common::AdTextAsset->new({
text => "Buy your tickets now!!!!!!!"
}
),
Google::Ads::GoogleAds::V14::Common::AdTextAsset->new({
text => "Visit the Red Planet"
})]});
# Create an ad group ad to hold the above ad.
my $ad_group_ad = Google::Ads::GoogleAds::V14::Resources::AdGroupAd->new({
adGroup => $ad_group_resource_name,
# Set the ad group ad to PAUSED to prevent it from immediately serving.
# Set to ENABLED once you've added targeting and the ad are ready to serve.
status => PAUSED,
# Set the responsive search ad info on an ad.
ad => Google::Ads::GoogleAds::V14::Resources::Ad->new({
responsiveSearchAd => $responsive_search_ad_info,
finalUrls => ["https://www.example.com"]})});
# Create an ad group ad operation.
my $ad_group_ad_operation =
Google::Ads::GoogleAds::V14::Services::AdGroupAdService::AdGroupAdOperation
->new({
create => $ad_group_ad
});
# Try sending a mutate request to add the ad group ad.
my $response = $api_client->AdGroupAdService()->mutate({
customerId => $customer_id,
operations => [$ad_group_ad_operation]});
my $ignorable_policy_topics = [];
if ($response->isa("Google::Ads::GoogleAds::GoogleAdsException")) {
# The request will always fail because of the policy violation in the
# description of the ad.
$ignorable_policy_topics = fetch_ignorable_policy_topics($response);
}
# Try sending exemption requests for creating a responsive search ad.
request_exemption($api_client, $customer_id, $ad_group_ad_operation,
$ignorable_policy_topics);
return 1;
}
# Collects all ignorable policy topics that will be sent for exemption request
# later.
sub fetch_ignorable_policy_topics {
my $google_ads_exception = shift;
my $ignorable_policy_topics = [];
printf "Google Ads failure details:\n";
foreach
my $error (@{$google_ads_exception->get_google_ads_failure()->{errors}})
{
if ([keys %{$error->{errorCode}}]->[0] ne "policyFindingError") {
# This example supports sending exemption request for the policy finding
# error only.
die $google_ads_exception->get_message();
}
printf "\t%s: %s\n", [keys %{$error->{errorCode}}]->[0], $error->{message};
if ($error->{details}{policyFindingDetails}) {
my $policy_finding_details = $error->{details}{policyFindingDetails};
printf "\tPolicy finding details:\n";
foreach my $policy_topic_entry (
@{$policy_finding_details->{policyTopicEntries}})
{
push @$ignorable_policy_topics, $policy_topic_entry->{topic};
printf
"\t\tPolicy topic name: '%s'\n",
$policy_topic_entry->{topic};
printf "\t\tPolicy topic entry type: '%s'\n",
$policy_topic_entry->{type};
# For the sake of brevity, we exclude printing "policy topic evidences" and
# "policy topic constraints" here. You can fetch those data by calling:
# - $policy_topic_entry->{evidences}
# - $policy_topic_entry->{constraints}
}
}
}
return $ignorable_policy_topics;
}
# Sends exemption requests for creating a responsive search ad.
sub request_exemption {
my ($api_client, $customer_id, $ad_group_ad_operation,
$ignorable_policy_topics)
= @_;
print
"Try adding a responsive search ad again by requesting exemption for its "
. "policy violations.\n";
$ad_group_ad_operation->{policyValidationParameter} =
Google::Ads::GoogleAds::V14::Common::PolicyValidationParameter->new(
{ignorablePolicyTopics => $ignorable_policy_topics});
my $ad_group_ads_response = $api_client->AdGroupAdService()->mutate({
customerId => $customer_id,
operations => [$ad_group_ad_operation]});
printf
"Successfully added a responsive search ad with resource name '%s' by " .
"requesting for policy violation exemption.\n",
$ad_group_ads_response->{results}[0]{resourceName};
}
# 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(0);
my $customer_id = undef;
my $ad_group_id = undef;
# 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.
handle_responsive_search_ad_policy_violations($api_client,
$customer_id =~ s/-//gr, $ad_group_id);
=pod
=head1 NAME
handle_responsive_search_ad_policy_violations
=head1 DESCRIPTION
This example demonstrates how to request an exemption for policy violations of a
responsive search ad. If the request somehow fails with exceptions that are not policy
finding errors, the example will stop instead of trying sending an exemption request.
=head1 SYNOPSIS
handle_responsive_search_ad_policy_violations.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-ad_group_id The ad group ID.
=cut
