Get Account Budget Proposals

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

/**
 * Gets all account budget proposals. To add an account budget proposal, run
 * AddAccountBudgetProposal.java.
 */
public class GetAccountBudgetProposals {

  private static final int PAGE_SIZE = 1_000;

  private static class GetAccountBudgetProposalsParams extends CodeSampleParams {

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

  public static void main(String[] args) {
    GetAccountBudgetProposalsParams params = new GetAccountBudgetProposalsParams();
    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 GetAccountBudgetProposals().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 AccountBudgetProposals.
   */
  private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
    // Constructs a GAQL query which will retrieve AccountBudgetProposals.
    String queryString =
        "SELECT account_budget_proposal.id, "
            + "  account_budget_proposal.account_budget, "
            + "  account_budget_proposal.billing_setup, "
            + "  account_budget_proposal.status, "
            + "  account_budget_proposal.proposed_name, "
            + "  account_budget_proposal.proposed_notes, "
            + "  account_budget_proposal.proposed_purchase_order_number, "
            + "  account_budget_proposal.proposal_type, "
            + "  account_budget_proposal.approval_date_time, "
            + "  account_budget_proposal.creation_date_time "
            + "FROM account_budget_proposal";

    // Creates a request that will retrieve all account budget proposals using pages of the
    // specified page size.
    SearchGoogleAdsRequest request =
        SearchGoogleAdsRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setPageSize(PAGE_SIZE)
            .setQuery(queryString)
            .build();

    try (GoogleAdsServiceClient googleAdsServiceClient =
        googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
      // Issues the search request.
      SearchPagedResponse searchPagedResponse = googleAdsServiceClient.search(request);

      // 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()) {
        AccountBudgetProposal proposal = googleAdsRow.getAccountBudgetProposal();
        System.out.printf(
            "Account budget proposal with "
                + "ID '%s' "
                + "status '%s' "
                + "account_budget '%s' "
                + "billing_setup '%s' "
                + "proposed_name '%s' "
                + "proposed_notes '%s' "
                + "proposed_po_number '%s' "
                + "proposal_type '%s' "
                + "approval_date_time '%s' "
                + "creation_date_time '%s'.%n",
            proposal.getId().getValue(),
            proposal.getStatus().name(),
            proposal.getAccountBudget().getValue(),
            proposal.getBillingSetup().getValue(),
            proposal.getProposedName().getValue(),
            proposal.getProposedNotes().getValue(),
            proposal.getProposedPurchaseOrderNumber().getValue(),
            proposal.getProposalType().name(),
            proposal.getApprovalDateTime().getValue(),
            proposal.getCreationDateTime().getValue());
      }
    }
  }
}
C#
// 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
//
//     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.V1.Errors;
using Google.Ads.GoogleAds.V1.Resources;
using Google.Ads.GoogleAds.V1.Services;
using Google.Api.Gax;
using System;

namespace Google.Ads.GoogleAds.Examples.V1
{
    /// <summary>
    /// This code example gets all account budget proposals. To add an account budget proposal, run
    /// AddAccountBudgetProposal.cs.
    /// </summary>
    public class GetAccountBudgetProposals : 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)
        {
            GetAccountBudgetProposals codeExample = new GetAccountBudgetProposals();
            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 code example gets all account budget proposals. To add an account " +
                    "budget proposal, run AddAccountBudgetProposal.cs.";
            }
        }

        /// <summary>
        /// Runs the code example.
        /// </summary>
        /// <param name="client">The Google Ads client.</param>
        /// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
        public void Run(GoogleAdsClient client, long customerId)
        {
            // Get the GoogleAdsServiceClient.
            GoogleAdsServiceClient googleAdsService = client.GetService(
                Services.V1.GoogleAdsService);

            // Construct a GAQL query which will retrieve AccountBudgetProposals.
            String searchQuery =
                @"SELECT account_budget_proposal.id,
                     account_budget_proposal.account_budget,
                     account_budget_proposal.billing_setup,
                     account_budget_proposal.status,
                     account_budget_proposal.proposed_name,
                     account_budget_proposal.proposed_notes,
                     account_budget_proposal.proposed_purchase_order_number,
                     account_budget_proposal.proposal_type,
                     account_budget_proposal.approval_date_time,
                     account_budget_proposal.creation_date_time
                 FROM
                     account_budget_proposal";

            // Creates a request that will retrieve all account budget proposals using pages of the
            // specified page size.
            SearchGoogleAdsRequest request = new SearchGoogleAdsRequest()
            {
                PageSize = PAGE_SIZE,
                Query = searchQuery,
                CustomerId = customerId.ToString()
            };

            try
            {
                // Issues 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 account budget in each row.
                foreach (GoogleAdsRow googleAdsRow in searchPagedResponse)
                {
                    AccountBudgetProposal proposal = googleAdsRow.AccountBudgetProposal;
                    Console.WriteLine($"Account budget proposal with ID '{proposal.Id}' " +
                        $"status '{proposal.Status}', account_budget '{proposal.AccountBudget}' " +
                        $"billing_setup '{proposal.BillingSetup}', " +
                        $"proposed_name '{proposal.ProposedName}', " +
                        $"proposed_notes '{proposal.ProposedNotes}', " +
                        $"proposed_po_number '{proposal.ProposedPurchaseOrderNumber}', " +
                        $"proposal_type '{proposal.ProposalType}', " +
                        $"approval_date_time '{proposal.ApprovalDateTime}', " +
                        $"creation_date_time '{proposal.CreationDateTime}'.");
                }
            }
            catch (GoogleAdsException e)
            {
                Console.WriteLine("Failure:");
                Console.WriteLine($"Message: {e.Message}");
                Console.WriteLine($"Failure: {e.Failure}");
                Console.WriteLine($"Request ID: {e.RequestId}");
            }
        }
    }
}
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\V1\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V1\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V1\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\V1\Enums\AccountBudgetProposalStatusEnum\AccountBudgetProposalStatus;
use Google\Ads\GoogleAds\V1\Enums\AccountBudgetProposalTypeEnum\AccountBudgetProposalType;
use Google\Ads\GoogleAds\V1\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V1\Services\GoogleAdsRow;
use Google\ApiCore\ApiException;

/**
 * This example gets all account budget proposals. To add an account budget proposal, run
 * AddAccountBudgetProposal.php
 */
class GetAccountBudgetProposals
{
    const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
    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
                );
            }
        } catch (ApiException $apiException) {
            printf(
                "ApiException was thrown with message '%s'.%s",
                $apiException->getMessage(),
                PHP_EOL
            );
        }
    }

    /**
     * Runs the example.
     *
     * @param GoogleAdsClient $googleAdsClient the Google Ads API client
     * @param int $customerId the client customer ID without hyphens
     */
    public static function runExample(GoogleAdsClient $googleAdsClient, $customerId)
    {
        $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
        // Creates a query that retrieves the account budget proposals.
        $query = 'SELECT account_budget_proposal.id, '
            . '  account_budget_proposal.account_budget, '
            . '  account_budget_proposal.billing_setup, '
            . '  account_budget_proposal.status, '
            . '  account_budget_proposal.proposed_name, '
            . '  account_budget_proposal.proposed_notes, '
            . '  account_budget_proposal.proposed_purchase_order_number, '
            . '  account_budget_proposal.proposal_type, '
            . '  account_budget_proposal.approval_date_time, '
            . '  account_budget_proposal.creation_date_time '
            . 'FROM account_budget_proposal';

        // 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 account budget proposal in each row.
        foreach ($response->iterateAllElements() as $googleAdsRow) {
            /** @var GoogleAdsRow $googleAdsRow */
            $accountBudgetProposal = $googleAdsRow->getAccountBudgetProposal();
            printf(
                'Found the account budget proposal with ID %1$d, %11$s'
                . '  status \'%2$s\', %11$s'
                . '  account budget \'%3$s\', %11$s'
                . '  billing setup \'%4$s\', %11$s'
                . '  proposed name \'%5$s\', %11$s'
                . '  proposed notes \'%6$s\', %11$s'
                . '  proposed PO number \'%7$s\'.%11$s'
                . '  proposed type \'%8$s\'.%11$s'
                . '  approval date time \'%9$s\'.%11$s'
                . '  creation date time \'%10$s\'.%11$s',
                $accountBudgetProposal->getIdValue(),
                AccountBudgetProposalStatus::name($accountBudgetProposal->getStatus()),
                $accountBudgetProposal->getAccountBudgetValue(),
                $accountBudgetProposal->getBillingSetupValue(),
                $accountBudgetProposal->getProposedNameValue(),
                $accountBudgetProposal->getProposedNotesValue(),
                $accountBudgetProposal->getProposedPurchaseOrderNumberValue(),
                AccountBudgetProposalType::name($accountBudgetProposal->getProposalType()),
                $accountBudgetProposal->getApprovalDateTimeValue(),
                $accountBudgetProposal->getCreationDateTimeValue(),
                PHP_EOL
            );
        }
    }
}

GetAccountBudgetProposals::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 get all account budget proposals.

To add an account budget proposal, run add_account_budget_proposal.py
"""

from __future__ import absolute_import

import argparse
import sys

import six

import google.ads.google_ads.client


_DEFAULT_PAGE_SIZE = 1000


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

    query = ('SELECT account_budget_proposal.id, '
             'account_budget_proposal.account_budget,'
             'account_budget_proposal.billing_setup,'
             'account_budget_proposal.status,'
             'account_budget_proposal.proposed_name,'
             'account_budget_proposal.proposed_notes,'
             'account_budget_proposal.proposed_purchase_order_number,'
             'account_budget_proposal.proposal_type,'
             'account_budget_proposal.approval_date_time,'
             'account_budget_proposal.creation_date_time '
             'FROM account_budget_proposal')

    results = ga_service.search(customer_id, query=query, page_size=page_size)

    try:
        # Use the enum types to determine the enum names from the values.
        proposal_status_enum = client.get_type(
            'AccountBudgetProposalStatusEnum').AccountBudgetProposalStatus
        proposal_type_enum = client.get_type(
            'AccountBudgetProposalTypeEnum').AccountBudgetProposalType

        for row in results:
            budget_proposal = row.account_budget_proposal

            print('Account budget proposal with ID "%s", status "%s", '
                  'account_budget "%s", billing_setup "%s", '
                  'proposed_name "%s", proposed_notes "%s", '
                  'proposed_po_number "%s", proposal_type "%s", '
                  'approval_date_time "%s", creation_date_time "%s"'
                  % (budget_proposal.id.value,
                     proposal_status_enum.Name( budget_proposal.status),
                     budget_proposal.account_budget.value,
                     budget_proposal.billing_setup.value,
                     budget_proposal.proposed_name.value,
                     budget_proposal.proposed_notes.value,
                     budget_proposal.proposed_purchase_order_number.value,
                     proposal_type_enum.Name( budget_proposal.proposal_type),
                     budget_proposal.approval_date_time.value,
                     budget_proposal.creation_date_time.value))
    except google.ads.google_ads.errors.GoogleAdsException as ex:
        print('Request with ID "%s" failed with status "%s" and includes the '
              'following errors:' % (ex.request_id, ex.error.code().name))
        for error in ex.failure.errors:
            print('\tError with message "%s".' % error.message)
            if error.location:
                for field_path_element in error.location.field_path_elements:
                    print('\t\tOn field: %s' % field_path_element.field_name)
        sys.exit(1)


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

    parser = argparse.ArgumentParser(
        description='Lists all account budget proposals.')
    # The following argument(s) should be provided to run the example.
    parser.add_argument('-c', '--customer_id', type=six.text_type,
                        required=True, help='The Google Ads customer ID.')
    args = parser.parse_args()

    main(google_ads_client, args.customer_id, _DEFAULT_PAGE_SIZE)
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 all account budget proposals. To add an account budget
# proposal, run AddAccountBudgetProposal.rb.

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

def get_account_budget_proposals(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(:GoogleAds)

  search_query = <<~QUERY
    SELECT
      account_budget_proposal.id,
      account_budget_proposal.account_budget,
      account_budget_proposal.billing_setup,
      account_budget_proposal.status,
      account_budget_proposal.proposed_name,
      account_budget_proposal.proposed_notes,
      account_budget_proposal.proposed_purchase_order_number,
      account_budget_proposal.proposal_type,
      account_budget_proposal.approval_date_time,
      account_budget_proposal.creation_date_time
   FROM account_budget_proposal
  QUERY

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

  response.each do |row|
    account_budget_proposal = row.account_budget_proposal

    puts sprintf('Account budget proposal with ID %s, status %s, '\
        'account_budget %s, billing_setup %s, proposed_name %s, '\
        'proposed_notes %s, proposed_po_number %s, proposal_type %s, '\
        'approval_date_time %s, creation_date_time %s',
        account_budget_proposal.id,
        account_budget_proposal.account_budget,
        account_budget_proposal.billing_setup,
        account_budget_proposal.status,
        account_budget_proposal.proposed_name,
        account_budget_proposal.proposed_notes,
        account_budget_proposal.proposed_purchase_order_number,
        account_budget_proposal.proposal_type,
        account_budget_proposal.approval_date_time,
        account_budget_proposal.creation_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'
  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.separator ''
    opts.separator 'Help:'

    opts.on_tail('-h', '--help', 'Show this message') do
      puts opts
      exit
    end
  end.parse!

  begin
    get_account_budget_proposals(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
  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'])
  end
end

Send feedback about...

Google Ads API
Google Ads API
Need help? Visit our support page.