Get Account Budgets

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.v4.errors.GoogleAdsError;
import com.google.ads.googleads.v4.errors.GoogleAdsException;
import com.google.ads.googleads.v4.resources.AccountBudget;
import com.google.ads.googleads.v4.services.GoogleAdsRow;
import com.google.ads.googleads.v4.services.GoogleAdsServiceClient;
import com.google.ads.googleads.v4.services.GoogleAdsServiceClient.SearchPagedResponse;
import java.io.FileNotFoundException;
import java.io.IOException;

/** Retrieves all account budgets for a Google Ads customer. */
public class GetAccountBudgets {

  private static class GetAccountBudgetParams extends CodeSampleParams {

    @Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
    private Long customerId;
  }

  public static void main(String[] args) {
    GetAccountBudgetParams params = new GetAccountBudgetParams();
    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;
    try {
      googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
    } catch (FileNotFoundException fnfe) {
      System.err.printf(
          "Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
      return;
    } catch (IOException ioe) {
      System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
      return;
    }

    try {
      new GetAccountBudgets().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);
      }
    }
  }

  /**
   * Runs the example.
   *
   * @param googleAdsClient the Google Ads API client.
   * @param customerId the customer ID for which to retrieve account budgets.
   */
  private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
    String query =
        "SELECT "
            + "account_budget.status, "
            + "account_budget.billing_setup, "
            + "account_budget.approved_spending_limit_micros, "
            + "account_budget.approved_spending_limit_type, "
            + "account_budget.proposed_spending_limit_micros, "
            + "account_budget.proposed_spending_limit_type, "
            + "account_budget.approved_start_date_time, "
            + "account_budget.proposed_start_date_time, "
            + "account_budget.approved_end_date_time, "
            + "account_budget.approved_end_time_type,"
            + "account_budget.proposed_end_date_time, "
            + "account_budget.proposed_end_time_type "
            + "FROM account_budget";
    try (GoogleAdsServiceClient googleAdsServiceClient =
        googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
      // Issues the search request.
      SearchPagedResponse searchPagedResponse =
          googleAdsServiceClient.search(Long.toString(customerId), query);

      // Iterates over all rows in all pages and prints the requested field values for the account
      // budget in each row.
      for (GoogleAdsRow googleAdsRow : searchPagedResponse.iterateAll()) {
        AccountBudget accountBudget = googleAdsRow.getAccountBudget();

        System.out.printf(
            "Account budget '%s' with "
                + "status '%s' "
                + "billing setup '%s' "
                + "amount served %.2f "
                + "total adjustments %.2f "
                + "approved spending limit '%s' "
                + "(proposed '%s') "
                + "approved start time '%s' "
                + "(proposed '%s') "
                + "approved end time '%s' "
                + "(proposed '%s')"
                + ".%n",
            accountBudget.getResourceName(),
            accountBudget.getStatus(),
            accountBudget.getBillingSetup().getValue(),
            accountBudget.getAmountServedMicros().getValue() / 1_000_000.0,
            accountBudget.getTotalAdjustmentsMicros().getValue() / 1_000_000.0,
            accountBudget.hasApprovedSpendingLimitMicros()
                ? String.format(
                    "%.2f", accountBudget.getApprovedSpendingLimitMicros().getValue() / 1_000_000.0)
                : accountBudget.getApprovedSpendingLimitType().name(),
            accountBudget.hasProposedSpendingLimitMicros()
                ? String.format(
                    "%.2f", accountBudget.getProposedSpendingLimitMicros().getValue() / 1_000_000.0)
                : accountBudget.getProposedSpendingLimitType().name(),
            accountBudget.getApprovedStartDateTime().getValue(),
            accountBudget.getProposedStartDateTime().getValue(),
            accountBudget.hasApprovedEndDateTime()
                ? accountBudget.getApprovedEndDateTime().getValue()
                : accountBudget.getApprovedEndTimeType(),
            accountBudget.hasProposedEndDateTime()
                ? accountBudget.getProposedEndDateTime().getValue()
                : accountBudget.getProposedEndTimeType());
      }
    }
  }
}

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 Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V4.Errors;
using Google.Ads.GoogleAds.V4.Resources;
using Google.Ads.GoogleAds.V4.Services;
using Google.Api.Gax;
using System;

namespace Google.Ads.GoogleAds.Examples.V4
{
    /// <summary>
    /// This example retrieves all account budgets for a Google Ads customer.
    /// </summary>
    public class GetAccountBudgets : ExampleBase
    {
        /// <summary>
        /// The page size to be used by default.
        /// </summary>
        private const int PAGE_SIZE = 1_000;

        /// <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)
        {
            GetAccountBudgets codeExample = new GetAccountBudgets();
            Console.WriteLine(codeExample.Description);

            // The Google Ads customer ID for which the call is made.
            long customerId = long.Parse("INSERT_CUSTOMER_ID_HERE");
            codeExample.Run(new GoogleAdsClient(), customerId);
        }

        /// <summary>
        /// Returns a description about the code example.
        /// </summary>
        public override string Description
        {
            get
            {
                return "This example retrieves all account budgets for a Google Ads customer.";
            }
        }

        /// <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.V4.GoogleAdsService);

            // Construct a GAQL query which will retrieve AccountBudgetProposals.
            String query =
                @"SELECT
                    account_budget.status,
                    account_budget.billing_setup,
                    account_budget.approved_spending_limit_micros,
                    account_budget.approved_spending_limit_type,
                    account_budget.proposed_spending_limit_micros,
                    account_budget.proposed_spending_limit_type,
                    account_budget.adjusted_spending_limit_micros,
                    account_budget.adjusted_spending_limit_type,
                    account_budget.approved_start_date_time,
                    account_budget.proposed_start_date_time,
                    account_budget.approved_end_date_time,
                    account_budget.approved_end_time_type,
                    account_budget.proposed_end_date_time,
                    account_budget.proposed_end_time_type
                 FROM
                     account_budget";

            try
            {
                // Issues the search request.
                googleAdsService.SearchStream(customerId.ToString(), query,
                    delegate (SearchGoogleAdsStreamResponse resp)
                    {
                        // Displays the results
                        foreach (GoogleAdsRow googleAdsRow in resp.Results)
                        {
                            AccountBudget budget = googleAdsRow.AccountBudget;

                            Console.WriteLine(String.Format("Account budget '{0}' with status '{1}', " +
                                "billing setup '{2}', amount served {3:0.00}, total adjustments " +
                                "{4:0.00}, approved spending limit '{5}' (proposed '{6}', " +
                                "adjusted '{7}'), approved start time '{8}' (proposed '{9}'), " +
                                "approved end time '{10}' (proposed '{11}')",
                                budget.ResourceName,
                                budget.Status,
                                budget.BillingSetup,
                                budget.AmountServedMicros.Value / 1_000_000.0,
                                budget.TotalAdjustmentsMicros.Value / 1_000_000.0,
                                budget.ApprovedSpendingLimitMicros.HasValue
                                    ? String.Format(
                                        "%.2f", budget.ApprovedSpendingLimitMicros.Value / 1_000_000.0)
                                    : budget.ApprovedSpendingLimitType.ToString(),
                                budget.ProposedSpendingLimitMicros.HasValue
                                    ? String.Format(
                                        "%.2f", budget.ProposedSpendingLimitMicros.Value / 1_000_000.0)
                                    : budget.ProposedSpendingLimitType.ToString(),
                                budget.AdjustedSpendingLimitMicros.HasValue
                                    ? String.Format(
                                        "%.2f", budget.AdjustedSpendingLimitMicros.Value / 1_000_000.0)
                                    : budget.AdjustedSpendingLimitType.ToString(),
                                budget.ApprovedStartDateTime,
                                budget.ProposedStartDateTime,
                                String.IsNullOrEmpty(budget.ApprovedEndDateTime)
                                    ? budget.ApprovedEndTimeType.ToString()
                                    : budget.ApprovedEndDateTime,
                                String.IsNullOrEmpty(budget.ProposedEndDateTime)
                                    ? budget.ProposedEndTimeType.ToString()
                                    : budget.ProposedEndDateTime));

                        }
                    }
                );

            }
            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\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V4\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V4\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V4\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\V4\GoogleAdsServerStreamDecorator;
use Google\Ads\GoogleAds\V4\Enums\AccountBudgetStatusEnum\AccountBudgetStatus;
use Google\Ads\GoogleAds\V4\Enums\SpendingLimitTypeEnum\SpendingLimitType;
use Google\Ads\GoogleAds\V4\Enums\TimeTypeEnum\TimeType;
use Google\Ads\GoogleAds\V4\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V4\Services\GoogleAdsRow;
use Google\ApiCore\ApiException;

/** This example retrieves all account budgets for a Google Ads customer. */
class GetAccountBudgets
{
    private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';

    public static function main()
    {
        // Either pass the required parameters for this example on the command line, or insert them
        // into the constants above.
        $options = (new ArgumentParser())->parseCommandArguments([
            ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT
        ]);

        // Generate a refreshable OAuth2 credential for authentication.
        $oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();

        // Construct a Google Ads client configured from a properties file and the
        // OAuth2 credentials above.
        $googleAdsClient = (new GoogleAdsClientBuilder())
            ->fromFile()
            ->withOAuth2Credential($oAuth2Credential)
            ->build();

        try {
            self::runExample(
                $googleAdsClient,
                $options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID
            );
        } catch (GoogleAdsException $googleAdsException) {
            printf(
                "Request with ID '%s' has failed.%sGoogle Ads failure details:%s",
                $googleAdsException->getRequestId(),
                PHP_EOL,
                PHP_EOL
            );
            foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) {
                /** @var GoogleAdsError $error */
                printf(
                    "\t%s: %s%s",
                    $error->getErrorCode()->getErrorCode(),
                    $error->getMessage(),
                    PHP_EOL
                );
            }
            exit(1);
        } catch (ApiException $apiException) {
            printf(
                "ApiException was thrown with message '%s'.%s",
                $apiException->getMessage(),
                PHP_EOL
            );
            exit(1);
        }
    }

    /**
     * Runs the example.
     *
     * @param GoogleAdsClient $googleAdsClient the Google Ads API client
     * @param int $customerId the customer ID
     */
    public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
    {
        $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
        // Creates a query that retrieves the account budgets.
        $query = 'SELECT account_budget.status, '
            . 'account_budget.billing_setup, '
            . 'account_budget.approved_spending_limit_micros, '
            . 'account_budget.approved_spending_limit_type, '
            . 'account_budget.proposed_spending_limit_micros, '
            . 'account_budget.proposed_spending_limit_type, '
            . 'account_budget.adjusted_spending_limit_micros, '
            . 'account_budget.adjusted_spending_limit_type, '
            . 'account_budget.approved_start_date_time, '
            . 'account_budget.proposed_start_date_time, '
            . 'account_budget.approved_end_date_time, '
            . 'account_budget.approved_end_time_type,'
            . 'account_budget.proposed_end_date_time, '
            . 'account_budget.proposed_end_time_type '
            . 'FROM account_budget';

        // Issues a search request by specifying page size.
        $stream = $googleAdsServiceClient->searchStream($customerId, $query);
        /** @var GoogleAdsServerStreamDecorator $stream */

        // Iterates over all rows in all pages and prints the requested field values for
        // the account budget in each row.
        foreach ($stream->iterateAllElements() as $googleAdsRow) {
            /** @var GoogleAdsRow $googleAdsRow */
            $accountBudget = $googleAdsRow->getAccountBudget();
            printf(
                'Found the account budget \'%s\' with status \'%s\', billing setup '
                . '\'%s\', amount served %.2f, total adjustments %.2f,%s'
                . '  approved spending limit \'%s\' (proposed \'%s\', adjusted \'%s\'),%s'
                . '  approved start time \'%s\' (proposed \'%s\'),%s'
                . '  approved end time \'%s\' (proposed \'%s\').%s',
                $accountBudget->getResourceName(),
                AccountBudgetStatus::name($accountBudget->getStatus()),
                $accountBudget->getBillingSetup()
                    ? $accountBudget->getBillingSetupUnwrapped() : 'none',
                $accountBudget->getAmountServedMicros()
                    ? $accountBudget->getAmountServedMicrosUnwrapped() / 1000000.0
                    : 0.0,
                $accountBudget->getTotalAdjustmentsMicros()
                    ? $accountBudget->getTotalAdjustmentsMicrosUnwrapped() / 1000000.0
                    : 0.0,
                PHP_EOL,
                $accountBudget->getApprovedSpendingLimitMicros()
                    ? sprintf(
                        '%.2f',
                        $accountBudget->getApprovedSpendingLimitMicrosUnwrapped() / 1000000.0
                    ) : SpendingLimitType::name($accountBudget->getApprovedSpendingLimitType()),
                $accountBudget->getProposedSpendingLimitMicros()
                    ? sprintf(
                        '%.2f',
                        $accountBudget->getProposedSpendingLimitMicrosUnwrapped() / 1000000.0
                    ) : SpendingLimitType::name($accountBudget->getProposedSpendingLimitType()),
                $accountBudget->getAdjustedSpendingLimitMicros()
                    ? sprintf(
                        '%.2f',
                        $accountBudget->getAdjustedSpendingLimitMicrosUnwrapped() / 1000000.0
                    ) : SpendingLimitType::name($accountBudget->getAdjustedSpendingLimitType()),
                PHP_EOL,
                $accountBudget->getApprovedStartDateTime()
                    ? $accountBudget->getApprovedStartDateTimeUnwrapped()
                    : 'none',
                $accountBudget->getProposedStartDateTime()
                    ? $accountBudget->getProposedStartDateTimeUnwrapped()
                    : 'none',
                PHP_EOL,
                $accountBudget->getApprovedEndDateTime()
                    ? $accountBudget->getApprovedEndDateTimeUnwrapped()
                    : TimeType::name($accountBudget->getApprovedEndTimeType()),
                $accountBudget->getProposedEndDateTime()
                    ? $accountBudget->getProposedEndDateTimeUnwrapped()
                    : TimeType::name($accountBudget->getProposedEndTimeType()),
                PHP_EOL
            );
        }
    }
}

GetAccountBudgets::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 illustrates how to get all account budgets for a Google Ads customer."""


import argparse
import sys

from google.ads.google_ads.client import GoogleAdsClient
from google.ads.google_ads.errors import GoogleAdsException


def main(client, customer_id):
    ga_service = client.get_service('GoogleAdsService', version='v4')

    query = ('SELECT account_budget.status, '
             'account_budget.billing_setup, '
             'account_budget.approved_spending_limit_micros, '
             'account_budget.approved_spending_limit_type, '
             'account_budget.proposed_spending_limit_micros, '
             'account_budget.proposed_spending_limit_type, '
             'account_budget.adjusted_spending_limit_micros, '
             'account_budget.adjusted_spending_limit_type, '
             'account_budget.approved_start_date_time, '
             'account_budget.proposed_start_date_time, '
             'account_budget.approved_end_date_time, '
             'account_budget.approved_end_time_type, '
             'account_budget.proposed_end_date_time, '
             'account_budget.proposed_end_time_type '
             'FROM account_budget')

    response = ga_service.search_stream(customer_id, query=query)

    try:
        # Use the enum type to determine the enum names from the values.
        budget_status_enum = client.get_type(
            'AccountBudgetStatusEnum', version='v4').AccountBudgetStatus

        for batch in response:
            for row in batch.results:
                budget = row.account_budget
                approved_spending_limit = (
                    _micros_to_currency(budget.approved_spending_limit_micros.value)
                    if budget.approved_spending_limit_micros
                    else budget.approved_spending_limit_type.name)
                proposed_spending_limit = (
                    _micros_to_currency(budget.proposed_spending_limit_micros.value)
                    if budget.proposed_spending_limit_micros
                    else budget.proposed_spending_limit_type.name)
                adjusted_spending_limit = (
                    _micros_to_currency(budget.adjusted_spending_limit_micros.value)
                    if budget.adjusted_spending_limit_micros
                    else budget.adjusted_spending_limit_type.name)
                approved_end_date_time = (
                    budget.approved_end_date_time.value
                    if budget.approved_end_date_time
                    else budget.approved_end_date_time_type)
                proposed_end_date_time = (
                    budget.proposed_end_date_time.value
                    if budget.proposed_end_date_time
                    else budget.proposed_end_date_time_type)

                print(f'Account budget "{budget.resource_name}", '
                      f'with status "{budget_status_enum.Name(budget.status)}" ',
                      f'billing setup "{budget.billing_setup.value}", '
                      f'amount served {_micros_to_currency(budget.amount_served_micros.value):.2f}, '
                      f'total adjustments {_micros_to_currency(budget.total_adjustments_micros.value):.2f}, '
                      f'approved spending limit "{approved_spending_limit}" '
                      f'(proposed "{proposed_spending_limit}" -- '
                      f'adjusted "{adjusted_spending_limit}"), '
                      f'approved start time "{budget.approved_start_date_time.value}" '
                      f'(proposed "{budget.proposed_start_date_time.value}"), '
                      f'approved end time "{approved_end_date_time}" '
                      f'(proposed "{proposed_end_date_time}").')
    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)


def _micros_to_currency(micros):
    return micros / 1000000.0


if __name__ == '__main__':
    # GoogleAdsClient will read the google-ads.yaml configuration file in the
    # home directory if none is specified.
    google_ads_client = GoogleAdsClient.load_from_storage()

    parser = argparse.ArgumentParser(
        description=('Lists all account budgets for given Google Ads 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.')
    args = parser.parse_args()

    main(google_ads_client, args.customer_id)

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 account budgets for a Google Ads customer.

require 'optparse'
require 'google/ads/google_ads'

def get_account_budgets(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
      account_budget.status,
      account_budget.billing_setup,
      account_budget.approved_spending_limit_micros,
      account_budget.approved_spending_limit_type,
      account_budget.proposed_spending_limit_micros,
      account_budget.proposed_spending_limit_type,
      account_budget.approved_start_date_time,
      account_budget.proposed_start_date_time,
      account_budget.approved_end_date_time,
      account_budget.approved_end_time_type,
      account_budget.proposed_end_date_time,
      account_budget.proposed_end_time_type
    FROM account_budget
  QUERY

  response = ga_service.search(
    customer_id,
    search_query,
    page_size: PAGE_SIZE
  )

  # Iterates over all rows in all pages and prints the requested field values
  # for the account budget in each row.
  response.each do |row|
    account_budget = row.account_budget

    total_adjustments_micros = 0
    unless account_budget.total_adjustments_micros.nil?
      total_adjustments_micros =
          account_budget.total_adjustments_micros.value / 1_000_000.0
    end

    amount_served_micros = 0
    unless account_budget.amount_served_micros.nil?
      amount_served_micros =
          account_budget.amount_served_micros.value / 1_000_000.0
    end

    approved_spending_limit_micros = account_budget.approved_spending_limit_type
    unless account_budget.approved_spending_limit_micros.nil?
      approved_spending_limit_micros =
          account_budget.approved_spending_limit_micros.value / 1_000_000.0
    end

    proposed_spending_limit_micros = account_budget.proposed_spending_limit_type
    unless account_budget.proposed_spending_limit_micros.nil?
      proposed_spending_limit_micros =
          account_budget.proposed_spending_limit_micros.value / 1_000_000.0
    end

    approved_end_date_time = account_budget.approved_end_time_type
    unless account_budget.approved_end_date_time.nil?
      approved_end_date_time = account_budget.approved_end_date_time
    end

    proposed_end_date_time = account_budget.proposed_end_time_type
    unless account_budget.proposed_end_date_time.nil?
      proposed_end_date_time = account_budget.proposed_end_date_time
    end

    puts sprintf('Account budget "%s" with status "%s", billing_setup "%s", '\
        'amount served %.2f, total adjustments %.2f, '\
        'approved spending limit "%s" (proposed "%s"), '\
        'approved start time "%s" (proposed "%s"), '\
        'approved end time "%s" (proposed "%s")',
        account_budget.resource_name,
        account_budget.status,
        account_budget.billing_setup,
        amount_served_micros,
        total_adjustments_micros,
        approved_spending_limit_micros,
        proposed_spending_limit_micros,
        account_budget.approved_start_date_time,
        account_budget.proposed_start_date_time,
        approved_end_date_time,
        proposed_end_date_time
    )
  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_account_budgets(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
  rescue Google::Gax::RetryError => e
    STDERR.printf("Error: '%s'\n\tCause: '%s'\n\tCode: %d\n\tDetails: '%s'\n" \
        "\tRequest-Id: '%s'\n", e.message, e.cause.message, e.cause.code,
                  e.cause.details, e.cause.metadata['request-id'])
    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 retrieves all account budgets for a Google Ads customer.

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::SearchStreamHandler;
use
  Google::Ads::GoogleAds::V4::Services::GoogleAdsService::SearchGoogleAdsStreamRequest;

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";

sub get_account_budgets {
  my ($api_client, $customer_id) = @_;

  # Create a query that retrieves the account budgets.
  my $search_query =
    "SELECT account_budget.status, account_budget.billing_setup, " .
    "account_budget.approved_spending_limit_micros, " .
    "account_budget.approved_spending_limit_type, " .
    "account_budget.proposed_spending_limit_micros, " .
    "account_budget.proposed_spending_limit_type, " .
    "account_budget.adjusted_spending_limit_micros, " .
    "account_budget.adjusted_spending_limit_type, " .
    "account_budget.approved_start_date_time, " .
    "account_budget.proposed_start_date_time, " .
    "account_budget.approved_end_date_time, " .
    "account_budget.approved_end_time_type, " .
    "account_budget.proposed_end_date_time, " .
    "account_budget.proposed_end_time_type FROM account_budget";

  # Create a search Google Ads stream request that will retrieve the account
  # budgets.
  my $search_stream_request =
    Google::Ads::GoogleAds::V4::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      => $search_query,
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $search_stream_handler =
    Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
      service => $google_ads_service,
      request => $search_stream_request
    });

  # Issue a search request and process the stream response to print the requested
  # field values for the account budget in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      my $account_budget = $google_ads_row->{accountBudget};

      printf
        "Found the account budget '%s' with status '%s', billing setup '%s', "
        . "amount served %.2f, total adjustments %.2f,\n"
        . "  approved spending limit '%s' (proposed '%s', adjusted '%s'),\n"
        . "  approved start time '%s' (proposed '%s'),\n"
        . "  approved end time '%s' (proposed '%s').\n",
        $account_budget->{resourceName}, $account_budget->{status},
        $account_budget->{billingSetup} ? $account_budget->{billingSetup}
        : "none",
        $account_budget->{amountServedMicros}
        ? $account_budget->{amountServedMicros} / 1000000.0
        : 0.0,
        $account_budget->{totalAdjustmentsMicros}
        ? $account_budget->{totalAdjustmentsMicros} / 1000000.0
        : 0.0,
        $account_budget->{approvedSpendingLimitMicros} ? sprintf "%.2f",
        $account_budget->{approvedSpendingLimitMicros} / 1000000.0
        : $account_budget->{approvedSpendingLimitType},
        $account_budget->{proposedSpendingLimitMicros} ? sprintf "%.2f",
        $account_budget->{proposedSpendingLimitMicros} / 1000000.0
        : $account_budget->{proposedSpendingLimitType},
        $account_budget->{adjustedSpendingLimitMicros} ? sprintf "%.2f",
        $account_budget->{adjustedSpendingLimitMicros} / 1000000.0
        : $account_budget->{adjustedSpendingLimitType},
        $account_budget->{approvedStartDateTime}
        ? $account_budget->{approvedStartDateTime}
        : "none",
        $account_budget->{proposedStartDateTime}
        ? $account_budget->{proposedStartDateTime}
        : "none",
        $account_budget->{approvedEndDateTime}
        ? $account_budget->{approvedEndDateTime}
        : $account_budget->{approvedEndTimeType},
        $account_budget->{proposedEndDateTime}
        ? $account_budget->{proposedEndDateTime}
        : $account_budget->{proposedEndTimeType};
    });

  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_account_budgets($api_client, $customer_id =~ s/-//gr);

=pod

=head1 NAME

get_account_budgets

=head1 DESCRIPTION

This example retrieves all account budgets for a Google Ads customer.

=head1 SYNOPSIS

get_account_budgets.pl [options]

    -help                       Show the help message.
    -customer_id                The Google Ads customer ID.

=cut