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.billing;
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.v13.errors.GoogleAdsError;
import com.google.ads.googleads.v13.errors.GoogleAdsException;
import com.google.ads.googleads.v13.resources.BillingSetup;
import com.google.ads.googleads.v13.services.GoogleAdsRow;
import com.google.ads.googleads.v13.services.GoogleAdsServiceClient;
import com.google.ads.googleads.v13.services.GoogleAdsServiceClient.SearchPagedResponse;
import com.google.ads.googleads.v13.services.SearchGoogleAdsRequest;
import java.io.FileNotFoundException;
import java.io.IOException;
/** Gets all BillingSetup objects available for the specified customerId. */
public class GetBillingSetup {
private static final int PAGE_SIZE = 1_000;
private static class GetBillingSetupParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private Long customerId;
}
public static void main(String[] args) {
GetBillingSetupParams params = new GetBillingSetupParams();
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 GetBillingSetup().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 customer ID for which to retrieve BillingSetups.
*/
private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
// Defines a GAQL query to retrieve all billing setup information.
String searchQuery =
"SELECT billing_setup.id, "
+ " billing_setup.status, "
+ " billing_setup.payments_account, "
+ " billing_setup.payments_account_info.payments_account_id, "
+ " billing_setup.payments_account_info.payments_account_name, "
+ " billing_setup.payments_account_info.payments_profile_id, "
+ " billing_setup.payments_account_info.payments_profile_name, "
+ " billing_setup.payments_account_info.secondary_payments_profile_id "
+ "FROM billing_setup";
// Creates a request that will retrieve all billing setups using pages of the specified
// page size.
SearchGoogleAdsRequest request =
SearchGoogleAdsRequest.newBuilder()
.setCustomerId(String.valueOf(customerId))
.setPageSize(PAGE_SIZE)
.setQuery(searchQuery)
.build();
try (GoogleAdsServiceClient googleAdsServiceClient =
googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
// Issues the search request.
SearchPagedResponse response = googleAdsServiceClient.search(request);
// Iterates over all rows in all pages and prints the requested field values for the billing
// setup in each row.
for (GoogleAdsRow googleAdsRow : response.iterateAll()) {
BillingSetup billingSetup = googleAdsRow.getBillingSetup();
System.out.printf(
"Billing setup with ID '%d', "
+ "status '%s', "
+ "payments_account '%s', "
+ "payments_account_id '%s', "
+ "payments_account_name '%s', "
+ "payments_profile_id '%s', "
+ "payments_profile_name '%s', "
+ "secondary_payments_profile_id '%s'.%n",
billingSetup.getId(),
billingSetup.getStatus(),
billingSetup.getPaymentsAccount(),
billingSetup.getPaymentsAccountInfo().getPaymentsAccountId(),
billingSetup.getPaymentsAccountInfo().getPaymentsAccountName(),
billingSetup.getPaymentsAccountInfo().getPaymentsProfileId(),
billingSetup.getPaymentsAccountInfo().getPaymentsProfileName(),
billingSetup.getPaymentsAccountInfo().getSecondaryPaymentsProfileId());
}
}
}
}
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.V14.Errors;
using Google.Ads.GoogleAds.V14.Resources;
using Google.Ads.GoogleAds.V14.Services;
using Google.Api.Gax;
using System;
using System.Collections.Generic;
using static Google.Ads.GoogleAds.V14.Enums.BillingSetupStatusEnum.Types;
namespace Google.Ads.GoogleAds.Examples.V14
{
/// <summary>
/// This code example gets all BillingSetup objects available for the specified customer ID.
/// </summary>
public class GetBillingSetup : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="GetBillingSetup"/> 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>
/// 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);
GetBillingSetup codeExample = new GetBillingSetup();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(), options.CustomerId);
}
/// <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 all BillingSetup objects available for the specified " +
"customer ID.";
/// <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>
public void Run(GoogleAdsClient client, long customerId)
{
// Get the GoogleAdsServiceClient.
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V14.GoogleAdsService);
// Define a GAQL query to retrieve all billing setup information.
string searchQuery = @"
SELECT
billing_setup.id,
billing_setup.status,
billing_setup.payments_account,
billing_setup.payments_account_info.payments_account_id,
billing_setup.payments_account_info.payments_account_name,
billing_setup.payments_account_info.payments_profile_id,
billing_setup.payments_account_info.payments_profile_name,
billing_setup.payments_account_info.secondary_payments_profile_id
FROM billing_setup";
// Creates a request that will retrieve all billing setups using pages of the specified
// page size.
SearchGoogleAdsRequest request = new SearchGoogleAdsRequest()
{
PageSize = PAGE_SIZE,
Query = searchQuery,
CustomerId = customerId.ToString()
};
try
{
PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> searchPagedResponse =
googleAdsService.Search(request);
foreach (GoogleAdsRow googleAdsRow in searchPagedResponse)
{
BillingSetup billingSetup = googleAdsRow.BillingSetup;
Console.WriteLine($"Billing setup with ID '{billingSetup.Id}'has status " +
$"'{billingSetup.Status}'.");
// A missing billing setup will have no payments account information.
if (billingSetup.HasPaymentsAccount)
{
Console.WriteLine(
$"\tPayments account: {billingSetup.PaymentsAccount}\n" +
"\tPayments account Id: " +
$"{billingSetup.PaymentsAccountInfo.PaymentsAccountId}\n" +
"\tPayments profile id: " +
$"{billingSetup.PaymentsAccountInfo.PaymentsProfileId}\n");
// A pending billing setup will not have values for certain fields.
if (billingSetup.Status != BillingSetupStatus.Pending)
{
Console.WriteLine(
"\tPayments account name: " +
$"{billingSetup.PaymentsAccountInfo.PaymentsAccountName}\n" +
"\tPayments profile name: " +
$"{billingSetup.PaymentsAccountInfo.PaymentsProfileName}\n" +
"\tSecondary payments profile id: " +
$"{billingSetup.PaymentsAccountInfo.SecondaryPaymentsProfileId}");
}
}
else
{
Console.WriteLine("Payments account details missing or incomplete.");
}
}
}
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\Billing;
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\V14\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V14\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V14\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\V14\Enums\BillingSetupStatusEnum\BillingSetupStatus;
use Google\Ads\GoogleAds\V14\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V14\Services\GoogleAdsRow;
use Google\ApiCore\ApiException;
/** This sample gets all BillingSetup objects available for the specified customer ID. */
class GetBillingSetup
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
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
]);
// 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)
{
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
// Creates a query that retrieves the billing setups.
$query = 'SELECT billing_setup.id, '
. ' billing_setup.status, '
. ' billing_setup.payments_account_info.payments_account_id, '
. ' billing_setup.payments_account_info.payments_account_name, '
. ' billing_setup.payments_account_info.payments_profile_id, '
. ' billing_setup.payments_account_info.payments_profile_name, '
. ' billing_setup.payments_account_info.secondary_payments_profile_id '
. 'FROM billing_setup';
// 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 billing setup in each row.
foreach ($response->iterateAllElements() as $googleAdsRow) {
/** @var GoogleAdsRow $googleAdsRow */
$paymentAccountInfo = $googleAdsRow->getBillingSetup()->getPaymentsAccountInfo();
if (is_null($paymentAccountInfo)) {
printf(
'Found the billing setup with ID %1$d, %3$s'
. ' status \'%2$d\' with no payment account info. %3$s',
$googleAdsRow->getBillingSetup()->getId(),
$googleAdsRow->getBillingSetup()->getStatus(),
PHP_EOL
);
continue;
}
printf(
'Found the billing setup with ID %1$d, %8$s'
. ' status \'%2$s\', %8$s'
. ' payments account ID \'%3$s\', %8$s'
. ' payments account name \'%4$s\', %8$s'
. ' payments profile ID \'%5$s\', %8$s'
. ' payments profile name \'%6$s\', %8$s'
. ' secondary payments profile ID \'%7$s\'.%8$s',
$googleAdsRow->getBillingSetup()->getId(),
BillingSetupStatus::name($googleAdsRow->getBillingSetup()->getStatus()),
$paymentAccountInfo->getPaymentsAccountId(),
$paymentAccountInfo->getPaymentsAccountName(),
$paymentAccountInfo->getPaymentsProfileId(),
$paymentAccountInfo->getPaymentsProfileName(),
$paymentAccountInfo->getSecondaryPaymentsProfileId()
? $paymentAccountInfo->getSecondaryPaymentsProfileId()
: 'None',
PHP_EOL
);
}
}
}
GetBillingSetup::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.
"""Gets all billing setup objects available for the specified customer ID."""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
def main(client, customer_id):
ga_service = client.get_service("GoogleAdsService")
query = """
SELECT
billing_setup.id,
billing_setup.status,
billing_setup.payments_account,
billing_setup.payments_account_info.payments_account_id,
billing_setup.payments_account_info.payments_account_name,
billing_setup.payments_account_info.payments_profile_id,
billing_setup.payments_account_info.payments_profile_name,
billing_setup.payments_account_info.secondary_payments_profile_id
FROM billing_setup"""
stream = ga_service.search_stream(customer_id=customer_id, query=query)
print("Found the following billing setup results:")
for batch in stream:
for row in batch.results:
billing_setup = row.billing_setup
pai = billing_setup.payments_account_info
if pai.secondary_payments_profile_id:
secondary_payments_profile_id = (
pai.secondary_payments_profile_id
)
else:
secondary_payments_profile_id = "None"
print(
f"Billing setup with ID {billing_setup.id}, "
f'status "{billing_setup.status.name}", '
f'payments_account "{billing_setup.payments_account}" '
f"payments_account_id {pai.payments_account_id}, "
f'payments_account_name "{pai.payments_account_name}", '
f"payments_profile_id {pai.payments_profile_id}, "
f'payments_profile_name "{pai.payments_profile_name}", '
"secondary_payments_profile_id "
f"{secondary_payments_profile_id}."
)
if __name__ == "__main__":
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client = GoogleAdsClient.load_from_storage(version="v14")
parser = argparse.ArgumentParser(
description="Lists all billing setup objects 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 = parser.parse_args()
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'\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 retrieves all BillingSetup objects available for the specified
# customerId.
require 'optparse'
require 'google/ads/google_ads'
def get_billing_setup(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
ga_service = client.service.google_ads
search_query = <<~QUERY
SELECT billing_setup.id,
billing_setup.status,
billing_setup.payments_account,
billing_setup.payments_account_info.payments_account_id,
billing_setup.payments_account_info.payments_account_name,
billing_setup.payments_account_info.payments_profile_id,
billing_setup.payments_account_info.payments_profile_name,
billing_setup.payments_account_info.secondary_payments_profile_id
FROM billing_setup
QUERY
response = ga_service.search(
customer_id: customer_id,
query: search_query,
page_size: PAGE_SIZE,
)
response.each do |row|
billing_setup = row.billing_setup
payments_account_info = billing_setup.payments_account_info
puts sprintf('Billing setup with ID "%s", status "%s",'\
' payments_account "%s", payments_account_id "%s",'\
' payments_account_name "%s", payments_profile_id "%s",'\
' payments_profile_name "%s", secondary_payments_profile_id "%s"',
billing_setup.id,
billing_setup.status,
billing_setup.payments_account,
payments_account_info ? payments_account_info.payments_account_id : "N/A",
payments_account_info ? payments_account_info.payments_account_name : "N/A",
payments_account_info ? payments_account_info.payments_profile_id : "N/A",
payments_account_info ? payments_account_info.payments_profile_name : "N/A",
payments_account_info ? payments_account_info.secondary_payments_profile_id : "N/A"
)
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'
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
get_billing_setup(options.fetch(:customer_id).tr("-", ""))
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 sample gets all BillingSetup objects available for the specified customer
# ID.
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::V14::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";
sub get_billing_setup {
my ($api_client, $customer_id) = @_;
# Create a query that retrieves the billing setups.
my $search_query =
"SELECT billing_setup.id, billing_setup.status, " .
"billing_setup.payments_account, " .
"billing_setup.payments_account_info.payments_account_id, " .
"billing_setup.payments_account_info.payments_account_name, " .
"billing_setup.payments_account_info.payments_profile_id, " .
"billing_setup.payments_account_info.payments_profile_name, " .
"billing_setup.payments_account_info.secondary_payments_profile_id " .
"FROM billing_setup";
# Create a search Google Ads request that will retrieve the billing setups
# using pages of the specified page size.
my $search_request =
Google::Ads::GoogleAds::V14::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 billing setup in each row.
while ($iterator->has_next) {
my $google_ads_row = $iterator->next;
my $billing_setup = $google_ads_row->{billingSetup};
my $payment_account_info = $billing_setup->{paymentsAccountInfo};
if (!$payment_account_info) {
printf "Found the billing setup with ID %d, status '%s' " .
"with no payment account info.\n", $billing_setup->{id},
$billing_setup->{status};
next;
}
printf "Found the billing setup with ID %d, status '%s', " .
"payments account '%s', " .
"payments account ID '%s', payments account name '%s', " .
"payments profile ID '%s', payments profile name '%s', " .
"secondary payments profile ID '%s'.\n",
$billing_setup->{id}, $billing_setup->{status},
$billing_setup->{paymentsAccount},
$payment_account_info->{paymentsAccountId},
$payment_account_info->{paymentsAccountName},
$payment_account_info->{paymentsProfileId},
$payment_account_info->{paymentsProfileName},
$payment_account_info->{secondaryPaymentsProfileId}
? $payment_account_info->{secondaryPaymentsProfileId}
: "None";
}
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.
get_billing_setup($api_client, $customer_id =~ s/-//gr);
=pod
=head1 NAME
get_billing_setup
=head1 DESCRIPTION
This sample gets all BillingSetup objects available for the specified customer ID.
=head1 SYNOPSIS
get_billing_setup.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
=cut
