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.v8.errors.GoogleAdsError;
import com.google.ads.googleads.v8.errors.GoogleAdsException;
import com.google.ads.googleads.v8.resources.AdGroup;
import com.google.ads.googleads.v8.resources.AdGroupBidModifier;
import com.google.ads.googleads.v8.resources.Campaign;
import com.google.ads.googleads.v8.services.GoogleAdsRow;
import com.google.ads.googleads.v8.services.GoogleAdsServiceClient;
import com.google.ads.googleads.v8.services.GoogleAdsServiceClient.SearchPagedResponse;
import com.google.ads.googleads.v8.services.SearchGoogleAdsRequest;
import java.io.FileNotFoundException;
import java.io.IOException;
import javax.annotation.Nullable;
/** Gets ad group bid modifiers. */
public class GetAdGroupBidModifiers {
private static final int PAGE_SIZE = 1_000;
private static class GetAdGroupBidModifiersParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private Long customerId;
@Parameter(names = ArgumentNames.AD_GROUP_ID)
private Long adGroupId;
}
public static void main(String[] args) throws IOException {
GetAdGroupBidModifiersParams params = new GetAdGroupBidModifiersParams();
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");
// Optional: Specify an ad group ID to restrict search to only a given ad group.
params.adGroupId = null;
}
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 GetAdGroupBidModifiers().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 Google Ads API client.
* @param customerId the client customer ID.
* @param adGroupId the ad group ID for which ad group bid modiifers will be retrieved. If {@code
* null}, returns all ad group bid modifiers.
* @throws GoogleAdsException if an API request failed with one or more service errors.
*/
private void runExample(
GoogleAdsClient googleAdsClient, long customerId, @Nullable Long adGroupId) {
try (GoogleAdsServiceClient googleAdsServiceClient =
googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
String searchQuery =
"SELECT"
+ " ad_group.id, "
+ " ad_group_bid_modifier.criterion_id,"
+ " campaign.id,"
+ " ad_group_bid_modifier.bid_modifier,"
+ " ad_group_bid_modifier.device.type,"
+ " ad_group_bid_modifier.hotel_date_selection_type.type,"
+ " ad_group_bid_modifier.hotel_advance_booking_window.min_days,"
+ " ad_group_bid_modifier.hotel_advance_booking_window.max_days,"
+ " ad_group_bid_modifier.hotel_length_of_stay.min_nights,"
+ " ad_group_bid_modifier.hotel_length_of_stay.max_nights,"
+ " ad_group_bid_modifier.hotel_check_in_day.day_of_week,"
+ " ad_group_bid_modifier.preferred_content.type "
+ "FROM"
+ " ad_group_bid_modifier";
if (adGroupId != null) {
searchQuery += String.format(" WHERE ad_group.id = %d", adGroupId);
}
searchQuery += " LIMIT 10000";
// Creates a request that will retrieve ad group bid modifiers using pages of the specified
// page size.
SearchGoogleAdsRequest request =
SearchGoogleAdsRequest.newBuilder()
.setCustomerId(Long.toString(customerId))
.setPageSize(PAGE_SIZE)
.setQuery(searchQuery)
.build();
// Issues the search request.
SearchPagedResponse searchPagedResponse = googleAdsServiceClient.search(request);
// Iterates over all rows in all pages and prints the requested field values for the ad group
// bid modifiers in each row.
for (GoogleAdsRow googleAdsRow : searchPagedResponse.iterateAll()) {
AdGroupBidModifier adGroupBidModifier = googleAdsRow.getAdGroupBidModifier();
AdGroup adGroup = googleAdsRow.getAdGroup();
Campaign campaign = googleAdsRow.getCampaign();
System.out.printf(
"Ad group bid modifier with criterion ID %d, bid modifier value %.2f "
+ "was found in an ad group with ID %d of campaign ID %d.%n",
adGroupBidModifier.getCriterionId(),
adGroupBidModifier.getBidModifier(),
adGroup.getId(),
campaign.getId());
// Gets a detailed message specific to the type of criterion.
String criterionDetails = " - Criterion type: " + adGroupBidModifier.getCriterionCase();
switch (adGroupBidModifier.getCriterionCase()) {
case DEVICE:
criterionDetails += "Type: " + adGroupBidModifier.getDevice().getType();
break;
case HOTEL_ADVANCE_BOOKING_WINDOW:
criterionDetails +=
"Min Days: "
+ adGroupBidModifier.getHotelAdvanceBookingWindow().getMinDays()
+ ", Max Days: "
+ adGroupBidModifier.getHotelAdvanceBookingWindow().getMaxDays();
break;
case HOTEL_CHECK_IN_DAY:
criterionDetails +=
"Day of the week: " + adGroupBidModifier.getHotelCheckInDay().getDayOfWeek();
break;
case HOTEL_DATE_SELECTION_TYPE:
criterionDetails +=
"Date selection type: " + adGroupBidModifier.getHotelDateSelectionType().getType();
break;
case HOTEL_LENGTH_OF_STAY:
criterionDetails +=
"Min Nights: "
+ adGroupBidModifier.getHotelLengthOfStay().getMinNights()
+ ", Max Nights: "
+ adGroupBidModifier.getHotelLengthOfStay().getMaxNights();
break;
case PREFERRED_CONTENT:
criterionDetails += "Type: " + adGroupBidModifier.getPreferredContent().getType();
break;
}
System.out.println(criterionDetails);
}
}
}
}
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.GoogleAds.Lib;
using Google.Ads.GoogleAds.V8.Errors;
using Google.Ads.GoogleAds.V8.Resources;
using Google.Ads.GoogleAds.V8.Services;
using Google.Api.Gax;
using System;
using System.Collections.Generic;
using static Google.Ads.GoogleAds.V8.Resources.AdGroupBidModifier;
namespace Google.Ads.GoogleAds.Examples.V8
{
/// <summary>
/// This code example gets ad group bid modifiers.
/// </summary>
public class GetAdGroupBidModifiers : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="GetAdGroupBidModifiers"/> 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>
/// The ad group ID for which ad group bid modiifers will be retrieved.
/// </summary>
[Option("adGroupId", Required = false, HelpText =
"The ad group ID for which ad group bid modiifers will be retrieved.")]
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 = new Options();
CommandLine.Parser.Default.ParseArguments<Options>(args).MapResult(
delegate (Options o)
{
options = o;
return 0;
}, delegate (IEnumerable<Error> errors)
{
// The Google Ads customer ID for which the call is made.
options.CustomerId = long.Parse("INSERT_CUSTOMER_ID_HERE");
// The ad group ID for which ad group bid modiifers will be retrieved.
options.AdGroupId = long.Parse("INSERT_AD_GROUP_ID_HERE");
return 0;
});
GetAdGroupBidModifiers codeExample = new GetAdGroupBidModifiers();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(), options.CustomerId, options.AdGroupId);
}
/// <summary>
/// The page size to be used by default.
/// </summary>
private const int PAGE_SIZE = 1_000;
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description => "This code example gets ad group bid modifiers.";
/// <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">The ad group ID for which ad group bid modiifers will
/// be retrieved.</param>
public void Run(GoogleAdsClient client, long customerId, long? adGroupId)
{
// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService =
client.GetService(Services.V8.GoogleAdsService);
string searchQuery = @"
SELECT
ad_group.id,
ad_group_bid_modifier.criterion_id,
campaign.id,
ad_group_bid_modifier.bid_modifier,
ad_group_bid_modifier.device.type,
ad_group_bid_modifier.hotel_date_selection_type.type,
ad_group_bid_modifier.hotel_advance_booking_window.min_days,
ad_group_bid_modifier.hotel_advance_booking_window.max_days,
ad_group_bid_modifier.hotel_length_of_stay.min_nights,
ad_group_bid_modifier.hotel_length_of_stay.max_nights,
ad_group_bid_modifier.hotel_check_in_day.day_of_week,
ad_group_bid_modifier.hotel_check_in_date_range.start_date,
ad_group_bid_modifier.hotel_check_in_date_range.end_date,
ad_group_bid_modifier.preferred_content.type
FROM
ad_group_bid_modifier";
if (adGroupId != null)
{
searchQuery += $" WHERE ad_group.id = {adGroupId}";
}
searchQuery += " LIMIT 10000";
// Creates a request that will retrieve ad group bid modifiers using pages of the
// specified page size.
SearchGoogleAdsRequest request = new SearchGoogleAdsRequest()
{
CustomerId = customerId.ToString(),
Query = searchQuery,
PageSize = PAGE_SIZE
};
try
{
// Issue the search request.
PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> searchPagedResponse =
googleAdsService.Search(request);
// Iterates over all rows in all pages and prints the requested field values for
// the ad group bid modifiers in each row.
foreach (GoogleAdsRow googleAdsRow in searchPagedResponse)
{
AdGroupBidModifier agBidModifier = googleAdsRow.AdGroupBidModifier;
AdGroup adGroup = googleAdsRow.AdGroup;
Campaign campaign = googleAdsRow.Campaign;
Console.WriteLine("Ad group bid modifier with criterion ID {0}, bid " +
"modifier value {1:0.00} was found in an ad group with ID {2} of " +
"campaign ID {3}.",
agBidModifier.CriterionId,
agBidModifier.BidModifier,
adGroup.Id, campaign.Id);
string criterionDetails = " - Criterion type: " +
$"{agBidModifier.CriterionCase}, ";
switch (agBidModifier.CriterionCase)
{
case CriterionOneofCase.Device:
criterionDetails += $"Type: {agBidModifier.Device.Type}";
break;
case CriterionOneofCase.HotelAdvanceBookingWindow:
criterionDetails +=
$"Min Days: {agBidModifier.HotelAdvanceBookingWindow.MinDays}," +
$"Max Days: {agBidModifier.HotelAdvanceBookingWindow.MaxDays}";
break;
case CriterionOneofCase.HotelCheckInDay:
criterionDetails += $"Day of the week: " +
$"{agBidModifier.HotelCheckInDay.DayOfWeek}";
break;
case CriterionOneofCase.HotelDateSelectionType:
criterionDetails += $"Date selection type: " +
$"{agBidModifier.HotelDateSelectionType.Type}";
break;
case CriterionOneofCase.HotelLengthOfStay:
criterionDetails +=
$"Min Nights: {agBidModifier.HotelLengthOfStay.MinNights}," +
$"Max Nights: {agBidModifier.HotelLengthOfStay.MaxNights}";
break;
case CriterionOneofCase.HotelCheckInDateRange:
criterionDetails +=
$"Start Date: {agBidModifier.HotelCheckInDateRange.StartDate}," +
$"End Date: {agBidModifier.HotelCheckInDateRange.EndDate}";
break;
case CriterionOneofCase.PreferredContent:
criterionDetails +=
$"Type: {agBidModifier.PreferredContent.Type}";
break;
}
Console.WriteLine(criterionDetails);
}
}
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\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V8\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V8\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V8\GoogleAdsException;
use Google\Ads\GoogleAds\V8\Enums\DayOfWeekEnum\DayOfWeek;
use Google\Ads\GoogleAds\V8\Enums\DeviceEnum\Device;
use Google\Ads\GoogleAds\V8\Enums\HotelDateSelectionTypeEnum\HotelDateSelectionType;
use Google\Ads\GoogleAds\V8\Enums\PreferredContentTypeEnum\PreferredContentType;
use Google\Ads\GoogleAds\V8\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V8\Services\GoogleAdsRow;
use Google\ApiCore\ApiException;
/** This example gets ad group bid modifiers. */
class GetAdGroupBidModifiers
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
// Optional: Specify an ad group ID below to restrict search to only a given ad group.
private const AD_GROUP_ID = null;
private const PAGE_SIZE = 1000;
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::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|null $adGroupId the ad group ID for which ad group bid modifiers will be
* retrieved. If `null`, returns from all ad groups
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
?int $adGroupId
) {
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
// Creates a query that retrieves ad group bid modifiers.
$query =
'SELECT ad_group.id, ad_group_bid_modifier.criterion_id, campaign.id, '
. 'ad_group_bid_modifier.bid_modifier, '
. 'ad_group_bid_modifier.device.type, '
. 'ad_group_bid_modifier.hotel_date_selection_type.type, '
. 'ad_group_bid_modifier.hotel_advance_booking_window.min_days, '
. 'ad_group_bid_modifier.hotel_advance_booking_window.max_days, '
. 'ad_group_bid_modifier.hotel_length_of_stay.min_nights, '
. 'ad_group_bid_modifier.hotel_length_of_stay.max_nights, '
. 'ad_group_bid_modifier.hotel_check_in_day.day_of_week, '
. 'ad_group_bid_modifier.hotel_check_in_date_range.start_date, '
. 'ad_group_bid_modifier.hotel_check_in_date_range.end_date, '
. 'ad_group_bid_modifier.preferred_content.type '
. 'FROM ad_group_bid_modifier';
if ($adGroupId !== null) {
$query .= " WHERE ad_group.id = $adGroupId";
}
$query .= " LIMIT 10000";
// Issues a search request by specifying page size.
$response =
$googleAdsServiceClient->search($customerId, $query, ['pageSize' => self::PAGE_SIZE]);
// Iterates over all rows in all pages and prints the requested field values for
// the ad group bid modifier in each row.
foreach ($response->iterateAllElements() as $googleAdsRow) {
/** @var GoogleAdsRow $googleAdsRow */
$adGroupBidModifier = $googleAdsRow->getAdGroupBidModifier();
printf(
"Ad group bid modifier with criterion ID %d, bid modifier value %f "
. "was found in an ad group ID %d of campaign ID %d.%s",
$adGroupBidModifier->getCriterionId(),
$adGroupBidModifier->getBidModifier(),
$googleAdsRow->getAdGroup()->getId(),
$googleAdsRow->getCampaign()->getId(),
PHP_EOL
);
$criterionDetails = ' - Criterion type: ' . $adGroupBidModifier->getCriterion() . ', ';
switch ($adGroupBidModifier->getCriterion()) {
case 'device':
$criterionDetails .= 'Type: ' .
Device::name($adGroupBidModifier->getDevice()->getType());
break;
case 'hotel_advance_booking_window':
$criterionDetails .= 'Min Days: ' .
$adGroupBidModifier->getHotelAdvanceBookingWindow()->getMinDays() . ', ';
$criterionDetails .= 'Max Days: ' .
$adGroupBidModifier->getHotelAdvanceBookingWindow()->getMaxDays();
break;
case 'hotel_check_in_day':
$criterionDetails .= 'Day of the week: ' .
DayOfWeek::name($adGroupBidModifier->getHotelCheckInDay()->getDayOfWeek());
break;
case 'hotel_date_selection_type':
$criterionDetails .= 'Date selection type: ' .
HotelDateSelectionType::name(
$adGroupBidModifier->getHotelDateSelectionType()->getType()
);
break;
case 'hotel_length_of_stay':
$criterionDetails .= 'Min Nights: ' .
$adGroupBidModifier->getHotelLengthOfStay()->getMinNights() . ', ';
$criterionDetails .= 'Max Nights: ' .
$adGroupBidModifier->getHotelLengthOfStay()->getMaxNights();
break;
case 'preferred_content':
$criterionDetails .= 'Type: ' .
PreferredContentType::name(
$adGroupBidModifier->getPreferredContent()->getType()
);
break;
case 'hotel_check_in_date_range':
$criterionDetails .= 'Start Date: ' .
$adGroupBidModifier->getHotelCheckInDateRange()->getStartDate() . ', ';
$criterionDetails .= 'End Date: ' .
$adGroupBidModifier->getHotelCheckInDateRange()->getEndDate();
break;
}
print $criterionDetails . PHP_EOL;
}
}
}
GetAdGroupBidModifiers::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 how to retrieve ad group bid modifiers."""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
_DEFAULT_PAGE_SIZE = 1000
def main(client, customer_id, page_size, ad_group_id=None):
ga_service = client.get_service("GoogleAdsService")
query = """
SELECT
campaign.id,
ad_group.id,
ad_group_bid_modifier.criterion_id,
ad_group_bid_modifier.bid_modifier,
ad_group_bid_modifier.device.type,
ad_group_bid_modifier.hotel_date_selection_type.type,
ad_group_bid_modifier.hotel_advance_booking_window.min_days,
ad_group_bid_modifier.hotel_advance_booking_window.max_days,
ad_group_bid_modifier.hotel_length_of_stay.min_nights,
ad_group_bid_modifier.hotel_length_of_stay.max_nights,
ad_group_bid_modifier.hotel_check_in_day.day_of_week,
ad_group_bid_modifier.hotel_check_in_date_range.start_date,
ad_group_bid_modifier.hotel_check_in_date_range.end_date,
ad_group_bid_modifier.preferred_content.type
FROM ad_group_bid_modifier"""
if ad_group_id:
query += f" WHERE ad_group.id = {ad_group_id}"
# Limit results to 10,000 rows as the number of bid modifiers can be large.
query += " LIMIT 10000"
search_request = client.get_type("SearchGoogleAdsRequest")
search_request.customer_id = customer_id
search_request.query = query
search_request.page_size = _DEFAULT_PAGE_SIZE
results = ga_service.search(request=search_request)
for row in results:
modifier = row.ad_group_bid_modifier
print(
"Ad group bid modifier with criterion ID "
f"'{modifier.criterion_id}', bid modifier value "
f"'{modifier.bid_modifier or 0.00}', device type "
f"'{modifier.device.type_.name}' was found in ad group with ID "
f"'{row.ad_group.id}' of campaign with ID '{row.campaign.id}'."
)
criterion_field = type(modifier).pb(modifier).WhichOneof("criterion")
criterion_details = f" - Criterion type: {criterion_field}, "
if criterion_field == "device":
criterion_details += f"Type: {modifier.device.type_}"
elif criterion_field == "hotel_advance_booking_window":
criterion_details += (
f"Min Days: {modifier.hotel_advance_booking_window.min_days}, "
f"Max Days: {modifier.hotel_advance_booking_window.max_days}"
)
elif criterion_field == "hotel_check_in_day":
criterion_details += (
f"Day of the week: {modifier.hotel_check_in_day.day_of_week}"
)
elif criterion_field == "hotel_date_selection_type":
criterion_details += f"Date selection type: {modifier.hotel_date_selection_type.type_}"
elif criterion_field == "hotel_length_of_stay":
criterion_details += (
f"Min Nights: {modifier.hotel_length_of_stay.min_nights}, "
f"Max Nights: {modifier.hotel_length_of_stay.max_nights}"
)
elif criterion_field == "preferred_content":
criterion_details += f"Type: {modifier.preferred_content.type_}"
else:
criterion_details = " - No Criterion type found."
print(criterion_details)
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="v8")
parser = argparse.ArgumentParser(
description="List ad group bid modifiers 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.",
)
parser.add_argument(
"-a",
"--ad_group_id",
type=str,
required=False,
help=(
"The ad group ID. Specify this to list ad group "
"bid modifiers solely for this ad group ID."
),
)
args = parser.parse_args()
try:
main(
googleads_client,
args.customer_id,
_DEFAULT_PAGE_SIZE,
ad_group_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
#!/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 gets ad group bid modifiers.
require "optparse"
require "google/ads/google_ads"
def get_ad_group_bid_modifiers(customer_id, ad_group_id = nil)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
search_query = <<~QUERY
SELECT ad_group.id,
ad_group_bid_modifier.criterion_id,
ad_group_bid_modifier.bid_modifier,
ad_group_bid_modifier.device.type,
ad_group_bid_modifier.hotel_date_selection_type.type,
ad_group_bid_modifier.hotel_advance_booking_window.min_days,
ad_group_bid_modifier.hotel_advance_booking_window.max_days,
ad_group_bid_modifier.hotel_length_of_stay.min_nights,
ad_group_bid_modifier.hotel_length_of_stay.max_nights,
ad_group_bid_modifier.hotel_check_in_day.day_of_week,
ad_group_bid_modifier.hotel_check_in_date_range.start_date,
ad_group_bid_modifier.hotel_check_in_date_range.end_date,
ad_group_bid_modifier.preferred_content.type,
campaign.id
FROM ad_group_bid_modifier
QUERY
if ad_group_id
search_query << "WHERE ad_group.id = #{ad_group_id}"
end
search_query << " LIMIT 10000"
response = client.service.google_ads.search(
customer_id: customer_id,
query: search_query,
page_size: PAGE_SIZE,
)
response.each do |row|
ad_group_bid_modifier = row.ad_group_bid_modifier
ad_group = row.ad_group
campaign = row.campaign
bid_modifier = '"nil"'
if ad_group_bid_modifier.bid_modifier
bid_modifier = sprintf("%.2f", ad_group_bid_modifier.bid_modifier)
end
puts "Ad group bid modifier with criterion ID #{ad_group_bid_modifier.criterion_id}, bid " \
"modifier value #{bid_modifier} was found in an ad group with ID #{ad_group.id} of " \
"campaign ID #{campaign.id}."
criterion_details = " - Criterion type: #{ad_group_bid_modifier.criterion}, "
case ad_group_bid_modifier.criterion
when :device
criterion_details += "Type: #{ad_group_bid_modifier.device.type}"
when :hotel_advance_booking_window
hotel_advance_booking_window = ad_group_bid_modifier.hotel_advance_booking_window
criterion_details += "Min Days: #{hotel_advance_booking_window.min_days}, " \
"Max Days: #{hotel_advance_booking_window.max_days}"
when :hotel_check_in_day
hotel_check_in_day = ad_group_bid_modifier.hotel_check_in_day
criterion_details += "Day of the week: #{hotel_check_in_day.day_of_week}"
when :hotel_date_selection_type
hotel_date_selection_type = ad_group_bid_modifier.hotel_date_selection_type
criterion_details += "Date selection type: #{hotel_date_selection_type.min_days}"
when :hotel_length_of_stay
hotel_length_of_stay = ad_group_bid_modifier.hotel_length_of_stay
criterion_details += "Min Nights: #{hotel_length_of_stay.min_nights}, " \
"Max Nights: #{hotel_length_of_stay.max_nights}"
when :hotel_check_in_date_range
hotel_check_in_date_range = ad_group_bid_modifier.hotel_check_in_date_range
criterion_details += "Start Date: #{hotel_check_in_date_range.start_date}, " \
"End Date: #{hotel_check_in_date_range.end_date}"
when :preferred_content
criterion_details += "Type: #{ad_group_bid_modifier.preferred_content.type}"
else
criterion_details = ' - No Criterion type found.'
end
puts criterion_details
end
end
if __FILE__ == $0
PAGE_SIZE = 1000
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] = nil
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,
'(Optional) AdGroup 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
get_ad_group_bid_modifiers(options.fetch(:customer_id).tr("-", ""), options[: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 gets ad group bid modifiers.
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::Utils::SearchGoogleAdsIterator;
use
Google::Ads::GoogleAds::V8::Services::GoogleAdsService::SearchGoogleAdsRequest;
use Getopt::Long qw(:config auto_help);
use Pod::Usage;
use Cwd qw(abs_path);
use constant PAGE_SIZE => 1000;
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
my $customer_id = "INSERT_CUSTOMER_ID_HERE";
my $ad_group_id = undef;
sub get_ad_group_bid_modifiers {
my ($api_client, $customer_id, $ad_group_id) = @_;
# Create a query that retrieves ad group bid modifiers.
my $search_query =
"SELECT ad_group.id, ad_group_bid_modifier.criterion_id, campaign.id, " .
"ad_group_bid_modifier.bid_modifier, " .
"ad_group_bid_modifier.device.type, " .
"ad_group_bid_modifier.hotel_date_selection_type.type, " .
"ad_group_bid_modifier.hotel_advance_booking_window.min_days, " .
"ad_group_bid_modifier.hotel_advance_booking_window.max_days, " .
"ad_group_bid_modifier.hotel_length_of_stay.min_nights, " .
"ad_group_bid_modifier.hotel_length_of_stay.max_nights, " .
"ad_group_bid_modifier.hotel_check_in_day.day_of_week, " .
"ad_group_bid_modifier.hotel_check_in_date_range.start_date, " .
"ad_group_bid_modifier.hotel_check_in_date_range.end_date, " .
"ad_group_bid_modifier.preferred_content.type " .
"FROM ad_group_bid_modifier";
if ($ad_group_id) {
$search_query .= " WHERE ad_group.id = $ad_group_id";
}
$search_query .= " LIMIT 10000";
# Create a search Google Ads request that will retrieve all ad group bid modifiers
# using pages of the specified page size.
my $search_request =
Google::Ads::GoogleAds::V8::Services::GoogleAdsService::SearchGoogleAdsRequest
->new({
customerId => $customer_id,
query => $search_query,
pageSize => PAGE_SIZE
});
# Get the GoogleAdsService.
my $google_ads_service = $api_client->GoogleAdsService();
my $iterator = Google::Ads::GoogleAds::Utils::SearchGoogleAdsIterator->new({
service => $google_ads_service,
request => $search_request
});
# Iterate over all rows in all pages and print the requested field values for the
# ad group bid modifier in each row.
while ($iterator->has_next) {
my $google_ads_row = $iterator->next;
my $ad_group_bid_modifier = $google_ads_row->{adGroupBidModifier};
my $ad_group = $google_ads_row->{adGroup};
my $campaign = $google_ads_row->{campaign};
printf
"Ad group bid modifier with criterion ID %d, bid modifier value %s, " .
"was found in an ad group with ID %d of campaign ID %d.\n",
$ad_group_bid_modifier->{criterionId},
$ad_group_bid_modifier->{bidModifier}
? sprintf "%.2f", $ad_group_bid_modifier->{bidModifier}
: "none",
$ad_group->{id},
$campaign->{id};
my $criterion_details = " - Criterion type: '%s', ";
if ($ad_group_bid_modifier->{device}) {
$criterion_details = sprintf $criterion_details, "Device";
$criterion_details .= sprintf "Type: '%s'",
$ad_group_bid_modifier->{device}{type};
} elsif ($ad_group_bid_modifier->{hotelAdvanceBookingWindow}) {
$criterion_details = sprintf $criterion_details,
"HotelAdvanceBookingWindow";
$criterion_details .= sprintf "Min Days: %d, Max Days: %d",
$ad_group_bid_modifier->{hotelAdvanceBookingWindow}{minDays},
$ad_group_bid_modifier->{hotelAdvanceBookingWindow}{maxDays};
} elsif ($ad_group_bid_modifier->{hotelCheckInDateRange}) {
$criterion_details = sprintf $criterion_details, "HotelCheckInDateRange";
$criterion_details .= sprintf "Start Date: %s, End Date: %s",
$ad_group_bid_modifier->{hotelCheckInDateRange}{startDate},
$ad_group_bid_modifier->{hotelCheckInDateRange}{endDate};
} elsif ($ad_group_bid_modifier->{hotelCheckInDay}) {
$criterion_details = sprintf $criterion_details, "HotelCheckInDay";
$criterion_details .= sprintf "Day of the week: %s",
$ad_group_bid_modifier->{hotelCheckInDay}{dayOfWeek};
} elsif ($ad_group_bid_modifier->{HotelDateSelectionType}) {
$criterion_details = sprintf $criterion_details, "HotelDateSelectionType";
$criterion_details .= sprintf "Date selection type: '%s'",
$ad_group_bid_modifier->{hotelDateSelectionType}{type};
} elsif ($ad_group_bid_modifier->{hotelLengthOfStay}) {
$criterion_details = sprintf $criterion_details, "HotelLengthOfStay";
$criterion_details .= sprintf "Min Nights: %d, Max Nights: %d",
$ad_group_bid_modifier->{hotelLengthOfStay}{minNights},
$ad_group_bid_modifier->{hotelLengthOfStay}{maxNights};
} elsif ($ad_group_bid_modifier->{preferredContent}) {
$criterion_details = sprintf $criterion_details, "PreferredContent";
$criterion_details .= sprintf "Type: '%s'",
$ad_group_bid_modifier->{preferredContent}{type};
}
print $criterion_details, "\n";
}
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);
# Call the example.
get_ad_group_bid_modifiers($api_client, $customer_id =~ s/-//gr, $ad_group_id);
=pod
=head1 NAME
get_ad_group_bid_modifiers
=head1 DESCRIPTION
This example gets ad group bid modifiers.
=head1 SYNOPSIS
get_ad_group_bid_modifiers.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-ad_group_id [optional] The ad group ID.
=cut
