Page Summary
-
The code demonstrates how to create a new conversion action in Google Ads using the Google Ads API.
-
It involves setting properties for the conversion action such as name, category, type, status, view-through lookback window, and value settings.
-
A conversion action operation is created with the new conversion action, and this operation is then used to mutate (add) the conversion action via the Conversion Action Service.
-
The example handles potential GoogleAdsException errors during the API call and prints the resource name of the newly added conversion action upon success.
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.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.v22.enums.ConversionActionCategoryEnum.ConversionActionCategory ; import com.google.ads.googleads.v22.enums.ConversionActionStatusEnum.ConversionActionStatus ; import com.google.ads.googleads.v22.enums.ConversionActionTypeEnum.ConversionActionType ; import com.google.ads.googleads.v22.errors.GoogleAdsError ; import com.google.ads.googleads.v22.errors.GoogleAdsException ; import com.google.ads.googleads.v22.resources.ConversionAction ; import com.google.ads.googleads.v22.resources.ConversionAction.ValueSettings ; import com.google.ads.googleads.v22.services.ConversionActionOperation ; import com.google.ads.googleads.v22.services.ConversionActionServiceClient ; import com.google.ads.googleads.v22.services.MutateConversionActionResult ; import com.google.ads.googleads.v22.services.MutateConversionActionsResponse ; import java.io.FileNotFoundException ; import java.io.IOException ; import java.util.Collections ; /** Adds a conversion action. */ public class AddConversionAction { private static class AddConversionActionParams extends CodeSampleParams { @Parameter ( names = ArgumentNames . CUSTOMER_ID , required = true ) private Long customerId ; } public static void main ( String [] args ) { AddConversionActionParams params = new AddConversionActionParams (); 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 AddConversionAction (). 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 ConversionAction. ConversionAction conversionAction = ConversionAction . newBuilder () // Note that conversion action names must be unique. If a conversion action already // exists with the specified conversion_action_name the create operation will fail with // a ConversionActionError.DUPLICATE_NAME error. . setName ( "Earth to Mars Cruises Conversion #" + getPrintableDateTime ()) . setCategory ( ConversionActionCategory . DEFAULT ) . setType ( ConversionActionType . WEBPAGE ) . setStatus ( ConversionActionStatus . ENABLED ) . setViewThroughLookbackWindowDays ( 15L ) . setValueSettings ( ValueSettings . newBuilder () . setDefaultValue ( 23.41 ) . setAlwaysUseDefaultValue ( true ) . build ()) . build (); // Creates the operation. ConversionActionOperation operation = ConversionActionOperation . newBuilder (). setCreate ( conversionAction ). build (); try ( ConversionActionServiceClient conversionActionServiceClient = googleAdsClient . getLatestVersion (). createConversionActionServiceClient ()) { MutateConversionActionsResponse response = conversionActionServiceClient . mutateConversionActions ( Long . toString ( customerId ), Collections . singletonList ( operation )); System . out . printf ( "Added %d conversion actions:%n" , response . getResultsCount ()); for ( MutateConversionActionResult result : response . getResultsList ()) { System . out . printf ( "New conversion action added 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 CommandLine ; using Google.Ads.Gax.Examples ; using Google.Ads.GoogleAds.Lib ; using Google.Ads.GoogleAds.V22.Errors ; using Google.Ads.GoogleAds.V22.Resources ; using Google.Ads.GoogleAds.V22.Services ; using System ; using static Google . Ads . GoogleAds . V22 . Enums . ConversionActionCategoryEnum . Types ; using static Google . Ads . GoogleAds . V22 . Enums . ConversionActionStatusEnum . Types ; using static Google . Ads . GoogleAds . V22 . Enums . ConversionActionTypeEnum . Types ; namespace Google.Ads.GoogleAds.Examples.V22 { /// <summary> /// This code example illustrates adding a conversion action. /// </summary> public class AddConversionAction : ExampleBase { /// <summary> /// Command line options for running the <see cref="AddConversionAction"/> 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 = ExampleUtilities . ParseCommandLine<Options> ( args ); AddConversionAction codeExample = new AddConversionAction (); 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 illustrates adding a conversion action." ; /// <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 ConversionActionService. ConversionActionServiceClient conversionActionService = client . GetService ( Services . V22 . ConversionActionService ); // Note that conversion action names must be unique. // If a conversion action already exists with the specified name the create operation // will fail with a ConversionAction.DUPLICATE_NAME error. string ConversionActionName = "Earth to Mars Cruises Conversion #" + ExampleUtilities . GetRandomString (); // Add a conversion action. ConversionAction conversionAction = new ConversionAction () { Name = ConversionActionName , Category = ConversionActionCategory . Default , Type = ConversionActionType . Webpage , Status = ConversionActionStatus . Enabled , ViewThroughLookbackWindowDays = 15 , ValueSettings = new ConversionAction . Types . ValueSettings () { DefaultValue = 23.41 , AlwaysUseDefaultValue = true } }; // Create the operation. ConversionActionOperation operation = new ConversionActionOperation () { Create = conversionAction }; try { // Create the conversion action. MutateConversionActionsResponse response = conversionActionService . MutateConversionActions ( customerId . ToString (), new ConversionActionOperation [] { operation }); // Display the results. foreach ( MutateConversionActionResult newConversionAction in response . Results ) { Console . WriteLine ( $"New conversion action with resource name = " + $"'{newConversionAction.ResourceName}' was added." ); } } 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 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\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\V22\GoogleAdsClient; use Google\Ads\GoogleAds\Lib\V22\GoogleAdsClientBuilder; use Google\Ads\GoogleAds\Lib\V22\GoogleAdsException; use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder; use Google\Ads\GoogleAds\V22\Enums\ConversionActionCategoryEnum\ConversionActionCategory; use Google\Ads\GoogleAds\V22\Enums\ConversionActionStatusEnum\ConversionActionStatus; use Google\Ads\GoogleAds\V22\Enums\ConversionActionTypeEnum\ConversionActionType; use Google\Ads\GoogleAds\V22\Errors\GoogleAdsError; use Google\Ads\GoogleAds\V22\Resources\ConversionAction; use Google\Ads\GoogleAds\V22\Resources\ConversionAction\ValueSettings; use Google\Ads\GoogleAds\V22\Services\ConversionActionOperation; use Google\Ads\GoogleAds\V22\Services\MutateConversionActionsRequest; use Google\ApiCore\ApiException; /** This example illustrates adding a conversion action. */ class AddConversionAction { 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 conversion action. $conversionAction = new ConversionAction([ // Note that conversion action names must be unique. // If a conversion action already exists with the specified conversion_action_name // the create operation will fail with a ConversionActionError.DUPLICATE_NAME error. 'name' => 'Earth to Mars Cruises Conversion #' . Helper::getPrintableDatetime(), 'category' => ConversionActionCategory::PBDEFAULT, 'type' => ConversionActionType::WEBPAGE, 'status' => ConversionActionStatus::ENABLED, 'view_through_lookback_window_days' => 15, 'value_settings' => new ValueSettings([ 'default_value' => 23.41, 'always_use_default_value' => true ]) ]); // Creates a conversion action operation. $conversionActionOperation = new ConversionActionOperation(); $conversionActionOperation->setCreate($conversionAction); // Issues a mutate request to add the conversion action. $conversionActionServiceClient = $googleAdsClient->getConversionActionServiceClient(); $response = $conversionActionServiceClient->mutateConversionActions( MutateConversionActionsRequest::build($customerId, [$conversionActionOperation]) ); printf("Added %d conversion actions:%s", $response->getResults()->count(), PHP_EOL); foreach ($response->getResults() as $addedConversionAction) { /** @var ConversionAction $addedConversionAction */ printf( "New conversion action added with resource name: '%s'%s", $addedConversionAction->getResourceName(), PHP_EOL ); } } } AddConversionAction::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 illustrates adding a conversion action.""" import argparse import sys import uuid from google.ads.googleads.client import GoogleAdsClient from google.ads.googleads.errors import GoogleAdsException from google.ads.googleads.v22.resources.types.conversion_action import ( ConversionAction , ) from google.ads.googleads.v22.services.services.conversion_action_service import ( ConversionActionServiceClient , ) from google.ads.googleads.v22.services.types.conversion_action_service import ( ConversionActionOperation , MutateConversionActionsResponse , ) def main ( client : GoogleAdsClient , customer_id : str ) - > None : conversion_action_service : ConversionActionServiceClient = ( client . get_service ( "ConversionActionService" ) ) # Create the operation. conversion_action_operation : ConversionActionOperation = client . get_type ( "ConversionActionOperation" ) # Create conversion action. conversion_action : ConversionAction = conversion_action_operation . create # Note that conversion action names must be unique. If a conversion action # already exists with the specified conversion_action_name, the create # operation will fail with a ConversionActionError.DUPLICATE_NAME error. conversion_action . name = f "Earth to Mars Cruises Conversion { uuid . uuid4 () } " conversion_action . type_ = ( client . enums . ConversionActionTypeEnum . UPLOAD_CLICKS ) conversion_action . category = ( client . enums . ConversionActionCategoryEnum . DEFAULT ) conversion_action . status = client . enums . ConversionActionStatusEnum . ENABLED conversion_action . view_through_lookback_window_days = 15 # Create a value settings object. value_settings : ConversionAction . ValueSettings = ( conversion_action . value_settings ) value_settings . default_value = 15.0 value_settings . always_use_default_value = True # Add the conversion action. conversion_action_response : MutateConversionActionsResponse = ( conversion_action_service . mutate_conversion_actions ( customer_id = customer_id , operations = [ conversion_action_operation ], ) ) print ( "Created conversion action " f '" { conversion_action_response . results [ 0 ] . resource_name } ".' ) if __name__ == "__main__" : parser : argparse . ArgumentParser = argparse . ArgumentParser ( description = "Adds a conversion 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." , ) args : argparse . Namespace = parser . parse_args () # GoogleAdsClient will read the google-ads.yaml configuration file in the # home directory if none is specified. googleads_client : GoogleAdsClient = GoogleAdsClient . load_from_storage ( version = "v22" ) try : main ( googleads_client , args . customer_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 ' \t Error with message " { error . message } ".' ) if error . location : for field_path_element in error . location . field_path_elements : print ( f " \t\t On field: { field_path_element . field_name } " ) sys . exit ( 1 )
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 code example illustrates adding a conversion action. require 'optparse' require 'google/ads/google_ads' require 'date' require_relative '../shared/error_handler.rb' def add_conversion_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 # Add a conversion action. conversion_action = client . resource . conversion_action do | ca | ca . name = "Earth to Mars Cruises Conversion #{ ( Time . new . to_f * 100 ) . to_i } " ca . type = :UPLOAD_CLICKS ca . category = :DEFAULT ca . status = :ENABLED ca . view_through_lookback_window_days = 15 # Create a value settings object. ca . value_settings = client . resource . value_settings do | vs | vs . default_value = 15 vs . always_use_default_value = true end end # Create the operation. conversion_action_operation = client . operation . create_resource . conversion_action ( conversion_action ) # Add the ad group ad. response = client . service . conversion_action . mutate_conversion_actions ( customer_id : customer_id , operations : [ conversion_action_operation ] , ) puts "New conversion action with resource name = #{ 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' 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_conversion_action ( options . fetch ( :customer_id ) . tr ( "-" , "" )) rescue Google :: Ads :: GoogleAds :: Errors :: GoogleAdsError = > e GoogleAdsErrorHandler . handle_google_ads_error ( e ) raise # Re-raise the error to maintain original script behavior. 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 illustrates adding a conversion action. 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::V22::Resources::ConversionAction ; use Google::Ads::GoogleAds::V22::Resources::ValueSettings ; use Google::Ads::GoogleAds::V22::Enums::ConversionActionCategoryEnum qw(DEFAULT) ; use Google::Ads::GoogleAds::V22::Enums::ConversionActionTypeEnum qw(WEBPAGE) ; use Google::Ads::GoogleAds::V22::Enums::ConversionActionStatusEnum qw(ENABLED) ; use Google::Ads::GoogleAds::V22::Services::ConversionActionService::ConversionActionOperation ; use Getopt::Long qw(:config auto_help) ; use Pod::Usage ; use Cwd qw(abs_path) ; use Data::Uniqid qw(uniqid) ; # The following parameter(s) should be provided to run the example. You can # either specify these by changing the INSERT_XXX_ID_HERE values below, or on # the command line. # # Parameters passed on the command line will override any parameters set in # code. # # Running the example with -h will print the command line usage. my $customer_id = "INSERT_CUSTOMER_ID_HERE" ; sub add_conversion_action { my ( $api_client , $customer_id ) = @_ ; # Note that conversion action names must be unique. # If a conversion action already exists with the specified conversion_action_name, # the create operation fails with error ConversionActionError.DUPLICATE_NAME. my $conversion_action_name = "Earth to Mars Cruises Conversion #" . uniqid (); # Create a conversion action. my $conversion_action = Google::Ads::GoogleAds::V22::Resources:: ConversionAction - > new ({ name = > $conversion_action_name , category = > DEFAULT , type = > WEBPAGE , status = > ENABLED , viewThroughLookbackWindowDays = > 15 , valueSettings = > Google::Ads::GoogleAds::V22::Resources:: ValueSettings - > new ({ defaultValue = > 23.41 , alwaysUseDefaultValue = > "true" })}); # Create a conversion action operation. my $conversion_action_operation = Google::Ads::GoogleAds::V22::Services::ConversionActionService:: ConversionActionOperation - > new ({ create = > $conversion_action }); # Add the conversion action. my $conversion_actions_response = $api_client - > ConversionActionService () - > mutate ({ customerId = > $customer_id , operations = > [ $conversion_action_operation ]}); printf "New conversion action added with resource name: '%s'.\n" , $conversion_actions_response - > { results }[ 0 ]{ resourceName }; 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_conversion_action ( $api_client , $customer_id =~ s/-//g r ); =pod =head1 NAME add_conversion_action =head1 DESCRIPTION This example illustrates adding a conversion action. =head1 SYNOPSIS add_conversion_action.pl [options] -help Show the help message. -customer_id The Google Ads customer ID. =cut
