Java
This example is not yet available in Java; you can take a look at the other languages.
C#
This example is not yet available in C#; you can take a look at the other languages.
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\Travel;
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\V13\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V13\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V13\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Util\V13\ResourceNames;
use Google\Ads\GoogleAds\V13\Common\HotelCheckInDayInfo;
use Google\Ads\GoogleAds\V13\Common\HotelLengthOfStayInfo;
use Google\Ads\GoogleAds\V13\Enums\DayOfWeekEnum\DayOfWeek;
use Google\Ads\GoogleAds\V13\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V13\Resources\AdGroupBidModifier;
use Google\Ads\GoogleAds\V13\Services\AdGroupBidModifierOperation;
use Google\ApiCore\ApiException;
/**
* This example shows how to add ad group bid modifiers to a hotel ad group based on hotel check-in
* day and hotel length of stay.
*/
class AddHotelAdGroupBidModifiers
{
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,
ArgumentNames::CHECK_IN_DAY_CRITERION_ID => 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
);
} 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
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $adGroupId
) {
$operations = [];
// 1) Creates an ad group bid modifier based on the hotel check-in day.
$checkInDayAdGroupBidModifier = new AdGroupBidModifier([
// Sets the ad group.
'ad_group' => ResourceNames::forAdGroup($customerId, $adGroupId),
'hotel_check_in_day' => new HotelCheckInDayInfo([
'day_of_week' => DayOfWeek::MONDAY
]),
// Sets the bid modifier value to 150%.
'bid_modifier' => 1.5
]);
// Creates an ad group bid modifier operation.
$checkInDayAdGroupBidModifierOperation = new AdGroupBidModifierOperation();
$checkInDayAdGroupBidModifierOperation->setCreate($checkInDayAdGroupBidModifier);
$operations[] = $checkInDayAdGroupBidModifierOperation;
// 2) Creates an ad group bid modifier based on the hotel length of stay.
$lengthOfStayAdGroupBidModifier = new AdGroupBidModifier([
// Sets the ad group.
'ad_group' => ResourceNames::forAdGroup($customerId, $adGroupId),
// Creates the hotel length of stay info.
'hotel_length_of_stay' => new HotelLengthOfStayInfo([
'min_nights' => 3,
'max_nights' => 7,
]),
// Sets the bid modifier value to 170%.
'bid_modifier' => 1.7
]);
// Creates an ad group bid modifier operation.
$lengthOfStayAdGroupBidModifierOperation = new AdGroupBidModifierOperation();
$lengthOfStayAdGroupBidModifierOperation->setCreate(
$lengthOfStayAdGroupBidModifier
);
$operations[] = $lengthOfStayAdGroupBidModifierOperation;
// Issues a mutate request to add an ad group bid modifiers.
$adGroupBidModifierServiceClient = $googleAdsClient->getAdGroupBidModifierServiceClient();
$response = $adGroupBidModifierServiceClient->mutateAdGroupBidModifiers(
$customerId,
$operations
);
// Print out resource names of the added ad group bid modifiers.
printf(
"Added %d hotel ad group bid modifiers:%s",
$response->getResults()->count(),
PHP_EOL
);
foreach ($response->getResults() as $addedAdGroupBidModifier) {
/** @var AdGroupBidModifier $addedAdGroupBidModifier */
print $addedAdGroupBidModifier->getResourceName() . PHP_EOL;
}
}
}
AddHotelAdGroupBidModifiers::main();
Python
#!/usr/bin/env python
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""This example adds an ad group bid modifier to a hotel ad group.
The bid modifiers will be based on hotel check-in day and length of stay.
"""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
def main(client, customer_id, ad_group_id):
ad_group_service = client.get_service("AdGroupService")
ag_bm_service = client.get_service("AdGroupBidModifierService")
# Create ad group bid modifier based on hotel check-in day.
check_in_ag_bm_operation = client.get_type("AdGroupBidModifierOperation")
check_in_ag_bid_modifier = check_in_ag_bm_operation.create
check_in_ag_bid_modifier.hotel_check_in_day.day_of_week = (
client.enums.DayOfWeekEnum.MONDAY
)
check_in_ag_bid_modifier.ad_group = ad_group_service.ad_group_path(
customer_id, ad_group_id
)
# Sets the bid modifier value to 150%.
check_in_ag_bid_modifier.bid_modifier = 1.5
# Create ad group bid modifier based on hotel length of stay info.
los_ag_bm_operation = client.get_type("AdGroupBidModifierOperation")
los_ag_bid_modifier = los_ag_bm_operation.create
los_ag_bid_modifier.ad_group = ad_group_service.ad_group_path(
customer_id, ad_group_id
)
# Creates the hotel length of stay info.
hotel_length_of_stay_info = los_ag_bid_modifier.hotel_length_of_stay
hotel_length_of_stay_info.min_nights = 3
hotel_length_of_stay_info.max_nights = 7
# Sets the bid modifier value to 170%.
los_ag_bid_modifier.bid_modifier = 1.7
# Add the bid modifiers
ag_bm_response = ag_bm_service.mutate_ad_group_bid_modifiers(
customer_id=customer_id,
operations=[check_in_ag_bm_operation, los_ag_bm_operation],
)
# Print out resource names of the added ad group bid modifiers.
print(f"Added {len(ag_bm_response.results)} hotel ad group bid modifiers:")
for result in ag_bm_response.results:
print(result.resource_name)
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="v13")
parser = argparse.ArgumentParser(
description=("Adds an ad group bid modifier to a hotel ad group.")
)
# 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 of the hotel ad group.",
)
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
This example is not yet available in Ruby; you can take a look at the other languages.
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 shows how to add ad group bid modifiers to a hotel ad group based
# on hotel check-in day and hotel length of stay.
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::V13::Resources::AdGroupBidModifier;
use Google::Ads::GoogleAds::V13::Common::HotelCheckInDayInfo;
use Google::Ads::GoogleAds::V13::Common::HotelLengthOfStayInfo;
use Google::Ads::GoogleAds::V13::Enums::DayOfWeekEnum qw(MONDAY);
use
Google::Ads::GoogleAds::V13::Services::AdGroupBidModifierService::AdGroupBidModifierOperation;
use Google::Ads::GoogleAds::V13::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";
sub add_hotel_ad_group_bid_modifiers {
my ($api_client, $customer_id, $ad_group_id) = @_;
# 1) Create an ad group bid modifier based on the hotel check-in day.
my $check_in_day_ad_group_bid_modifier =
Google::Ads::GoogleAds::V13::Resources::AdGroupBidModifier->new({
# Set the ad group.
adGroup => Google::Ads::GoogleAds::V13::Utils::ResourceNames::ad_group(
$customer_id, $ad_group_id
),
hotelCheckInDay =>
Google::Ads::GoogleAds::V13::Common::HotelCheckInDayInfo->new({
dayOfWeek => MONDAY
}
),
# Set the bid modifier value to 150%.
bidModifier => 1.5
});
# Create an ad group bid modifier operation.
my $check_in_day_ad_group_bid_modifier_operation =
Google::Ads::GoogleAds::V13::Services::AdGroupBidModifierService::AdGroupBidModifierOperation
->new({
create => $check_in_day_ad_group_bid_modifier
});
# 2) Create an ad group bid modifier based on the hotel length of stay.
my $length_of_stay_ad_group_bid_modifier =
Google::Ads::GoogleAds::V13::Resources::AdGroupBidModifier->new({
# Set the ad group.
adGroup => Google::Ads::GoogleAds::V13::Utils::ResourceNames::ad_group(
$customer_id, $ad_group_id
),
# Create the hotel length of stay info.
hotelLengthOfStay =>
Google::Ads::GoogleAds::V13::Common::HotelLengthOfStayInfo->new({
minNights => 3,
maxNights => 7
}
),
# Set the bid modifier value to 170%.
bidModifier => 1.7
});
# Create an ad group bid modifier operation.
my $length_of_stay_ad_group_bid_modifier_operation =
Google::Ads::GoogleAds::V13::Services::AdGroupBidModifierService::AdGroupBidModifierOperation
->new({
create => $length_of_stay_ad_group_bid_modifier
});
# 3) Add the ad group bid modifiers.
my $ad_group_bid_modifiers_response =
$api_client->AdGroupBidModifierService()->mutate({
customerId => $customer_id,
operations => [
$check_in_day_ad_group_bid_modifier_operation,
$length_of_stay_ad_group_bid_modifier_operation
]});
# Print out resource names of the added ad group bid modifiers.
my $ad_group_bid_modifier_results =
$ad_group_bid_modifiers_response->{results};
printf "Added %d hotel ad group bid modifiers:\n",
scalar @$ad_group_bid_modifier_results;
foreach my $ad_group_bid_modifier_result (@$ad_group_bid_modifier_results) {
printf "\t%s\n", $ad_group_bid_modifier_result->{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
);
# 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.
add_hotel_ad_group_bid_modifiers($api_client, $customer_id =~ s/-//gr,
$ad_group_id);
=pod
=head1 NAME
add_hotel_ad_group_bid_modifiers
=head1 DESCRIPTION
This example shows how to add ad group bid modifiers to a hotel ad group based on
hotel check-in day and hotel length of stay.
=head1 SYNOPSIS
add_hotel_ad_group_bid_modifiers.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-ad_group_id The hotel ad group ID.
=cut
