Page Summary
-
This example demonstrates how to add an ad group bid modifier for mobile devices.
-
The code creates an
AdGroupBidModifierobject with the specified ad group ID, bid modifier value, and targets mobile devices. -
An
AdGroupBidModifierOperationis created to define the creation of the ad group bid modifier. -
The operation is sent in a mutate request to the
AdGroupBidModifierServiceto add the bid modifier. -
The code then prints the resource name of the newly added ad group bid modifier.
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.advancedoperations ; 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.common.DeviceInfo ; import com.google.ads.googleads.v22.enums.DeviceEnum.Device ; import com.google.ads.googleads.v22.errors.GoogleAdsError ; import com.google.ads.googleads.v22.errors.GoogleAdsException ; import com.google.ads.googleads.v22.resources.AdGroupBidModifier ; import com.google.ads.googleads.v22.services.AdGroupBidModifierOperation ; import com.google.ads.googleads.v22.services.AdGroupBidModifierServiceClient ; import com.google.ads.googleads.v22.services.MutateAdGroupBidModifierResult ; import com.google.ads.googleads.v22.services.MutateAdGroupBidModifiersResponse ; import com.google.ads.googleads.v22.utils.ResourceNames ; import com.google.common.collect.ImmutableList ; import java.io.FileNotFoundException ; import java.io.IOException ; /** * Demonstrates how to add an ad group bid modifier for mobile devices. To get ad group bid * modifiers, see advancedoperations/GetAdGroupBidModifiers.java. */ public class AddAdGroupBidModifier { private static class AddAdGroupBidModifierParams extends CodeSampleParams { @Parameter ( names = ArgumentNames . CUSTOMER_ID , required = true ) private Long customerId ; @Parameter ( names = ArgumentNames . AD_GROUP_ID , required = true ) private Long adGroupId ; /** Specify the bid modifier value here or the default specified below will be used. */ @Parameter ( names = ArgumentNames . BID_MODIFIER_VALUE ) private Double bidModifier = 1.5 ; } public static void main ( String [] args ) { AddAdGroupBidModifierParams params = new AddAdGroupBidModifierParams (); if ( ! params . parseArguments ( args )) { // Either pass the required parameters for this example on the command line, or insert them // into the code here. See the parameter class definition above for descriptions. params . customerId = Long . parseLong ( "INSERT_CUSTOMER_ID_HERE" ); params . adGroupId = Long . parseLong ( "INSERT_AD_GROUP_ID_HERE" ); // Optional: To use a different bid modifier value from the default (1.5), uncomment // the line below and insert the desired bid modifier value. // params.bidModifier = Double.parseDouble("INSERT_BID_MODIFIER_VALUE_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 AddAdGroupBidModifier () . runExample ( googleAdsClient , params . customerId , params . adGroupId , params . bidModifier ); } catch ( GoogleAdsException gae ) { // GoogleAdsException is the base class for most exceptions thrown by an API request. // Instances of this exception have a message and a GoogleAdsFailure that contains a // collection of GoogleAdsErrors that indicate the underlying causes of the // GoogleAdsException. System . err . printf ( "Request ID %s failed due to GoogleAdsException. Underlying errors:%n" , gae . getRequestId ()); int i = 0 ; for ( GoogleAdsError googleAdsError : gae . getGoogleAdsFailure (). getErrorsList ()) { System . err . printf ( " Error %d: %s%n" , i ++ , googleAdsError ); } System . exit ( 1 ); } } /** * Runs the example. * * @param googleAdsClient the Google Ads API client. * @param customerId the client customer ID. * @param adGroupId the ID of the ad group. * @param bidModifier the bid modifier value to set * @throws GoogleAdsException if an API request failed with one or more service errors. */ private void runExample ( GoogleAdsClient googleAdsClient , long customerId , long adGroupId , double bidModifier ) { // Creates an ad group bid modifier for mobile devices with the specified ad group ID and // bid modifier value. AdGroupBidModifier adGroupBidModifier = AdGroupBidModifier . newBuilder () . setAdGroup ( ResourceNames . adGroup ( customerId , adGroupId )) . setBidModifier ( bidModifier ) . setDevice ( DeviceInfo . newBuilder (). setType ( Device . MOBILE )) . build (); // Creates an ad group bid modifier operation for creating an ad group bid modifier. AdGroupBidModifierOperation adGroupBidModifierOperation = AdGroupBidModifierOperation . newBuilder (). setCreate ( adGroupBidModifier ). build (); // Issues a mutate request to add the ad group bid modifier. try ( AdGroupBidModifierServiceClient adGroupBidModifierServiceClient = googleAdsClient . getLatestVersion (). createAdGroupBidModifierServiceClient ()) { MutateAdGroupBidModifiersResponse response = adGroupBidModifierServiceClient . mutateAdGroupBidModifiers ( Long . toString ( customerId ), ImmutableList . of ( adGroupBidModifierOperation )); System . out . printf ( "Added %d ad group bid modifiers:%n" , response . getResultsCount ()); for ( MutateAdGroupBidModifierResult mutateAdGroupBidModifierResult : response . getResultsList ()) { System . out . printf ( "\t%s%n" , mutateAdGroupBidModifierResult . 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.Common ; using Google.Ads.GoogleAds.V22.Errors ; using Google.Ads.GoogleAds.V22.Resources ; using Google.Ads.GoogleAds.V22.Services ; using System ; using System.Collections.Generic ; using static Google . Ads . GoogleAds . V22 . Enums . DeviceEnum . Types ; namespace Google.Ads.GoogleAds.Examples.V22 { /// <summary> /// This code example demonstrates how to add an ad group bid modifier for mobile devices. /// To get ad group bid modifiers, see GetAdGroupBidModifiers.cs. /// </summary> public class AddAdGroupBidModifier : ExampleBase { /// <summary> /// Command line options for running the <see cref="AddAdGroupBidModifier"/> example. /// </summary> public class Options : OptionsBase { /// <summary> /// The Google Ads customer ID for which the call is made. /// </summary> [Option("customerId", Required = true, HelpText = "The Google Ads customer ID for which the call is made.")] public long CustomerId { get ; set ; } /// <summary> /// ID of the ad group where the bid modifier will be added. /// </summary> [Option("adGroupId", Required = true, HelpText = "ID of the ad group where the bid modifier will be added.")] public long AdGroupId { get ; set ; } /// <summary> /// The value of the bid modifier to add. /// </summary> [Option("bidModifierValue", Required = true, HelpText = "The value of the bid modifier to add.")] public double BidModifierValue { 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 ); AddAdGroupBidModifier codeExample = new AddAdGroupBidModifier (); Console . WriteLine ( codeExample . Description ); codeExample . Run ( new GoogleAdsClient (), options . CustomerId , options . AdGroupId , options . BidModifierValue ); } /// <summary> /// Returns a description about the code example. /// </summary> public override string Description = > "This code example demonstrates how to add an ad group bid modifier for mobile " + "devices. To get ad group bid modifiers, see GetAdGroupBidModifiers.cs." ; /// <summary> /// Runs the code example. /// </summary> /// <param name="client">The Google Ads client.</param> /// <param name="customerId">The Google Ads customer ID for which the call is made.</param> /// <param name="adGroupId">ID of the ad group where the bid modifier will be added. /// </param> /// <param name="bidModifierValue">The value of the bid modifier to add.</param> public void Run ( GoogleAdsClient client , long customerId , long adGroupId , double bidModifierValue ) { // Get the AdGroupBidModifierService. AdGroupBidModifierServiceClient adGroupBidModifierService = client . GetService ( Services . V22 . AdGroupBidModifierService ); // Creates an ad group bid modifier for mobile devices with the specified ad group // ID and bid modifier value. AdGroupBidModifier adGroupBidModifier = new AdGroupBidModifier () { AdGroup = ResourceNames . AdGroup ( customerId , adGroupId ), BidModifier = bidModifierValue , Device = new DeviceInfo () { Type = Device . Mobile } }; // Creates an ad group bid modifier operation for creating an ad group bid modifier. AdGroupBidModifierOperation adGroupBidModifierOperation = new AdGroupBidModifierOperation () { Create = adGroupBidModifier }; // Send the operation in a mutate request. try { MutateAdGroupBidModifiersResponse response = adGroupBidModifierService . MutateAdGroupBidModifiers ( customerId . ToString (), new AdGroupBidModifierOperation [] { adGroupBidModifierOperation }); Console . WriteLine ( "Added {0} ad group bid modifiers:" , response . Results . Count ); foreach ( MutateAdGroupBidModifierResult result in response . Results ) { Console . WriteLine ( $"\t{result.ResourceName}" ); } } catch ( GoogleAdsException e ) { Console . WriteLine ( "Failure:" ); Console . WriteLine ( $"Message: {e.Message}" ); Console . WriteLine ( $"Failure: {e.Failure}" ); Console . WriteLine ( $"Request ID: {e.RequestId}" ); throw ; } } } }
PHP
< ?php /** * Copyright 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\AdvancedOperations; require __DIR__ . '/../../vendor/autoload.php'; use GetOpt\GetOpt; use Google\Ads\GoogleAds\Examples\Utils\ArgumentNames; use Google\Ads\GoogleAds\Examples\Utils\ArgumentParser; use Google\Ads\GoogleAds\Lib\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\Util\V22\ResourceNames; use Google\Ads\GoogleAds\V22\Common\DeviceInfo; use Google\Ads\GoogleAds\V22\Enums\DeviceEnum\Device; use Google\Ads\GoogleAds\V22\Errors\GoogleAdsError; use Google\Ads\GoogleAds\V22\Resources\AdGroupBidModifier; use Google\Ads\GoogleAds\V22\Services\AdGroupBidModifierOperation; use Google\Ads\GoogleAds\V22\Services\MutateAdGroupBidModifiersRequest; use Google\ApiCore\ApiException; /** * This example demonstrates how to add an ad group bid modifier for mobile devices. To get ad * group bid modifiers, see AdvancedOperations/GetAdGroupBidModifiers.php */ class AddAdGroupBidModifier { private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE'; private const AD_GROUP_ID = 'INSERT_AD_GROUP_ID_HERE'; // Specify the bid modifier value here or the default specified below will be used. private const BID_MODIFIER_VALUE = 1.5; 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, ArgumentNames::BID_MODIFIER_VALUE => GetOpt::OPTIONAL_ARGUMENT ]); // Generate a refreshable OAuth2 credential for authentication. $oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build(); // Construct a Google Ads client configured from a properties file and the // OAuth2 credentials above. $googleAdsClient = (new GoogleAdsClientBuilder())->fromFile() ->withOAuth2Credential($oAuth2Credential) ->build(); try { self::runExample( $googleAdsClient, $options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID, $options[ArgumentNames::AD_GROUP_ID] ?: self::AD_GROUP_ID, $options[ArgumentNames::BID_MODIFIER_VALUE] ?: self::BID_MODIFIER_VALUE ); } 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 an ad group bid modifier to * @param float $bidModifierValue the bid modifier value to set */ public static function runExample( GoogleAdsClient $googleAdsClient, int $customerId, int $adGroupId, float $bidModifierValue ) { // Creates an ad group bid modifier for mobile devices with the specified ad group ID and // bid modifier value. $adGroupBidModifier = new AdGroupBidModifier([ 'ad_group' => ResourceNames::forAdGroup($customerId, $adGroupId), 'bid_modifier' => $bidModifierValue, 'device' => new DeviceInfo(['type' => Device::MOBILE]) ]); // Creates an ad group bid modifier operation for creating an ad group bid modifier. $adGroupBidModifierOperation = new AdGroupBidModifierOperation(); $adGroupBidModifierOperation->setCreate($adGroupBidModifier); // Issues a mutate request to add the ad group bid modifier. $adGroupBidModifierServiceClient = $googleAdsClient->getAdGroupBidModifierServiceClient(); $response = $adGroupBidModifierServiceClient->mutateAdGroupBidModifiers( MutateAdGroupBidModifiersRequest::build($customerId, [$adGroupBidModifierOperation]) ); printf("Added %d ad group bid modifier:%s", $response->getResults()->count(), PHP_EOL); foreach ($response->getResults() as $addedAdGroupBidModifier) { /** @var AdGroupBidModifier $addedAdGroupBidModifier */ print $addedAdGroupBidModifier->getResourceName() . PHP_EOL; } } } AddAdGroupBidModifier::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 demonstrates how to add an ad group bid modifier for mobile devices. To get ad group bid modifiers, run get_ad_group_bid_modifiers.py """ import argparse import sys from google.ads.googleads.client import GoogleAdsClient from google.ads.googleads.errors import GoogleAdsException from google.ads.googleads.v22.enums.types.device import DeviceEnum from google.ads.googleads.v22.resources.types.ad_group_bid_modifier import ( AdGroupBidModifier , ) from google.ads.googleads.v22.services.services.ad_group_bid_modifier_service import ( AdGroupBidModifierServiceClient , ) from google.ads.googleads.v22.services.services.ad_group_service import ( AdGroupServiceClient , ) from google.ads.googleads.v22.services.types.ad_group_bid_modifier_service import ( AdGroupBidModifierOperation , MutateAdGroupBidModifiersResponse , ) def main ( client : GoogleAdsClient , customer_id : str , ad_group_id : str , bid_modifier_value : float , ) - > None : ad_group_service : AdGroupServiceClient = client . get_service ( "AdGroupService" ) ad_group_bm_service : AdGroupBidModifierServiceClient = client . get_service ( "AdGroupBidModifierService" ) # Create ad group bid modifier for mobile devices with the specified ad # group ID and bid modifier value. ad_group_bid_modifier_operation : AdGroupBidModifierOperation = ( client . get_type ( "AdGroupBidModifierOperation" ) ) ad_group_bid_modifier : AdGroupBidModifier = ( ad_group_bid_modifier_operation . create ) # Set the ad group. ad_group_bid_modifier . ad_group = ad_group_service . ad_group_path ( customer_id , ad_group_id ) # Set the bid modifier. ad_group_bid_modifier . bid_modifier = bid_modifier_value # Sets the device. device_enum : DeviceEnum = client . enums . DeviceEnum ad_group_bid_modifier . device . type_ = device_enum . MOBILE # Add the ad group bid modifier. ad_group_bm_response : MutateAdGroupBidModifiersResponse = ( ad_group_bm_service . mutate_ad_group_bid_modifiers ( customer_id = customer_id , operations = [ ad_group_bid_modifier_operation ], ) ) print ( "Created ad group bid modifier: " f " { ad_group_bm_response . results [ 0 ] . resource_name } ." ) if __name__ == "__main__" : parser = argparse . ArgumentParser ( description = ( "Adds an ad group bid modifier to the specified ad group " "ID, for the given customer ID." ) ) # The following argument(s) should be provided to run the example. parser . add_argument ( "-c" , "--customer_id" , type = str , required = True , help = "The Google Ads customer ID." , ) parser . add_argument ( "-a" , "--ad_group_id" , type = str , required = True , help = "The ad group ID." ) parser . add_argument ( "-b" , "--bid_modifier_value" , type = float , required = False , default = 1.5 , help = "The bid modifier value." , ) 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 , args . ad_group_id , args . bid_modifier_value , ) 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 example demonstrates how to add an ad group bid modifier for mobile # devices. To get ad group bid modifiers, # see advanced_operations/get_ad_group_bid_modifier.rb require 'optparse' require 'google/ads/google_ads' def add_ad_group_bid_modifier ( customer_id , ad_group_id , bid_modifier_value ) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google :: Ads :: GoogleAds :: GoogleAdsClient . new # Creates an ad group bid modifier for mobile devices with the specified # ad group ID and bid modifier value. ad_group_bid_modifier = client . resource . ad_group_bid_modifier do | mod | # Sets the ad group. mod . ad_group = client . path . ad_group ( customer_id , ad_group_id ) # Sets the Bid Modifier. mod . bid_modifier = bid_modifier_value # Sets the Device. mod . device = client . resource . device_info do | device | device . type = :MOBILE end end # Create the operation. operation = client . operation . create_resource . ad_group_bid_modifier ( ad_group_bid_modifier ) # Add the ad group ad. response = client . service . ad_group_bid_modifier . mutate_ad_group_bid_modifiers ( customer_id : customer_id , operations : [ operation ] ) puts "Added #{ response . results . size } ad group bid modifiers:" response . results . each do | added_ad_group_bid_modifier | puts " \t #{ added_ad_group_bid_modifier . resource_name } " 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' options [ :ad_group_id ] = 'INSERT_AD_GROUP_ID_HERE' options [ :bid_modifier_value ] = 1 . 5 OptionParser . new do | opts | opts . banner = sprintf ( 'Usage: %s [options]' , File . basename ( __FILE__ )) opts . separator '' opts . separator 'Options:' opts . on ( '-C' , '--customer-id CUSTOMER-ID' , String , 'Customer ID' ) do | v | options [ :customer_id ] = v end opts . on ( '-A' , '--ad-group-id AD-GROUP-ID' , String , 'AdGroup ID' ) do | v | options [ :ad_group_id ] = v end opts . on ( '-B' , '--bid-modifier-value BID-MODIFIER-VALUE' , String , 'Bid Modifier Value' ) do | v | options [ :bid_modifier_value ] = v end opts . separator '' opts . separator 'Help:' opts . on_tail ( '-h' , '--help' , 'Show this message' ) do puts opts exit end end . parse! begin add_ad_group_bid_modifier ( options . fetch ( :customer_id ) . tr ( "-" , "" ), options [ :ad_group_id ] , options [ :bid_modifier_value ]. to_f ) 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 ( " \t On 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 ( " \t Type: %s \n\t Code: %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 add an ad group bid modifier for mobile devices. # To get ad group bid modifiers, see advanced_operations/get_ad_group_bid_modifiers.pl. use strict ; use warnings ; use utf8 ; use FindBin qw($Bin) ; use lib "$Bin/../../lib" ; use Google::Ads::GoogleAds::Client ; use Google::Ads::GoogleAds::Utils::GoogleAdsHelper ; use Google::Ads::GoogleAds::V22::Resources::AdGroupBidModifier ; use Google::Ads::GoogleAds::V22::Common::DeviceInfo ; use Google::Ads::GoogleAds::V22::Enums::DeviceEnum qw(MOBILE) ; use Google::Ads::GoogleAds::V22::Services::AdGroupBidModifierService::AdGroupBidModifierOperation ; use Google::Ads::GoogleAds::V22::Utils::ResourceNames ; use Getopt::Long qw(:config auto_help) ; use Pod::Usage ; use Cwd qw(abs_path) ; # The following parameter(s) should be provided to run the example. You can # either specify these by changing the INSERT_XXX_ID_HERE values below, or on # the command line. # # Parameters passed on the command line will override any parameters set in # code. # # Running the example with -h will print the command line usage. my $customer_id = "INSERT_CUSTOMER_ID_HERE" ; my $ad_group_id = "INSERT_AD_GROUP_ID_HERE" ; # Specify the bid modifier value here or the default specified below will be used. my $bid_modifier_value = 1.5 ; sub add_ad_group_bid_modifier { my ( $api_client , $customer_id , $ad_group_id , $bid_modifier_value ) = @_ ; # Create an ad group bid modifier for mobile devices with the specified ad group ID and # bid modifier value. my $ad_group_bid_modifier = Google::Ads::GoogleAds::V22::Resources:: AdGroupBidModifier - > new ({ adGroup = > Google::Ads::GoogleAds::V22::Utils::ResourceNames:: ad_group ( $customer_id , $ad_group_id ), bidModifier = > $bid_modifier_value , device = > Google::Ads::GoogleAds::V22::Common:: DeviceInfo - > new ({ type = > MOBILE })}); # Create an ad group bid modifier operation. my $ad_group_bid_modifier_operation = Google::Ads::GoogleAds::V22::Services::AdGroupBidModifierService:: AdGroupBidModifierOperation - > new ({ create = > $ad_group_bid_modifier }); # Add the ad group bid modifier. my $ad_group_bid_modifiers_response = $api_client - > AdGroupBidModifierService () - > mutate ({ customerId = > $customer_id , operations = > [ $ad_group_bid_modifier_operation ]}); printf "Created ad group bid modifier '%s'.\n" , $ad_group_bid_modifiers_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 , "ad_group_id=i" = > \ $ad_group_id , "bid_modifier_value=f" = > \ $bid_modifier_value ); # 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 , $bid_modifier_value ); # Call the example. add_ad_group_bid_modifier ( $api_client , $customer_id =~ s/-//g r , $ad_group_id , $bid_modifier_value ); =pod =head1 NAME add_ad_group_bid_modifier =head1 DESCRIPTION This example demonstrates how to add an ad group bid modifier for mobile devices. To get ad group bid modifiers, see advanced_operations/get_ad_group_bid_modifiers.pl. =head1 SYNOPSIS add_ad_group_bid_modifier.pl [options] -help Show the help message. -customer_id The Google Ads customer ID. -ad_group_id The ad group ID. -bid_modifier_value [optional] The bid modifier value. =cut
