Get Campaign Criterion Bid Modifier Simulations

Stay organized with collections Save and categorize content based on your preferences.

Java

// Copyright 2020 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.planning;

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.v11.common.BidModifierSimulationPoint;
import com.google.ads.googleads.v11.errors.GoogleAdsError;
import com.google.ads.googleads.v11.errors.GoogleAdsException;
import com.google.ads.googleads.v11.resources.CampaignCriterionSimulation;
import com.google.ads.googleads.v11.services.GoogleAdsRow;
import com.google.ads.googleads.v11.services.GoogleAdsServiceClient;
import com.google.ads.googleads.v11.services.SearchGoogleAdsStreamRequest;
import com.google.ads.googleads.v11.services.SearchGoogleAdsStreamResponse;
import com.google.api.gax.rpc.ServerStream;
import java.io.FileNotFoundException;
import java.io.IOException;

/**
 * Gets all available criterion bid modifier simulations for a given campaign. To get campaigns, run
 * GetCampaigns.java.
 */
public class GetCampaignCriterionBidModifierSimulations {

  private static class GetCampaignCriterionBidModifierSimulationsParams extends CodeSampleParams {

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

    @Parameter(names = ArgumentNames.CAMPAIGN_ID, required = true)
    private Long campaignId;
  }

  public static void main(String[] args) throws IOException {
    GetCampaignCriterionBidModifierSimulationsParams params =
        new GetCampaignCriterionBidModifierSimulationsParams();
    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");
      params.campaignId = Long.parseLong("INSERT_CAMPAIGN_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 GetCampaignCriterionBidModifierSimulations()
          .runExample(googleAdsClient, params.customerId, params.campaignId);
    } 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 campaignId the campaign ID to get the criterion bid modifier simulations.
   * @throws GoogleAdsException if an API request failed with one or more service errors.
   */
  private void runExample(GoogleAdsClient googleAdsClient, long customerId, long campaignId) {
    try (GoogleAdsServiceClient googleAdsServiceClient =
        googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
      // Creates a query that retrieves the criterion bid modifier simulations.
      String query =
          String.format(
              "SELECT campaign_criterion_simulation.criterion_id, "
                  + "campaign_criterion_simulation.start_date, "
                  + "campaign_criterion_simulation.end_date, "
                  + "campaign_criterion_simulation.bid_modifier_point_list.points "
                  + "FROM campaign_criterion_simulation "
                  + "WHERE campaign_criterion_simulation.type = BID_MODIFIER "
                  + "AND campaign_criterion_simulation.campaign_id = %d",
              campaignId);
      // Constructs the SearchGoogleAdsStreamRequest.
      SearchGoogleAdsStreamRequest request =
          SearchGoogleAdsStreamRequest.newBuilder()
              .setCustomerId(Long.toString(customerId))
              .setQuery(query)
              .build();

      // Creates and issues a search Google Ads stream request.
      ServerStream<SearchGoogleAdsStreamResponse> stream =
          googleAdsServiceClient.searchStreamCallable().call(request);

      // Iterates over all rows in all messages and prints the requested field values for
      // the campaign criterion bid modifier simulation in each row.
      for (SearchGoogleAdsStreamResponse response : stream) {
        for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
          CampaignCriterionSimulation simulation = googleAdsRow.getCampaignCriterionSimulation();
          System.out.printf(
              "Found campaign-level criterion bid modifier simulation for "
                  + "criterion with ID %d, start date '%s', end date '%s', and points:%n'",
              simulation.getCriterionId(), simulation.getStartDate(), simulation.getEndDate());
          for (BidModifierSimulationPoint point :
              simulation.getBidModifierPointList().getPointsList()) {
            System.out.printf(
                " bid modifier: %.2f => clicks: %d, cost: %d, impressions: %d, "
                    + "parent clicks: %d, parent cost: %d, parent impressions: %d, "
                    + "parent required budget: %d%n",
                point.getBidModifier(),
                point.getClicks(),
                point.getCostMicros(),
                point.getImpressions(),
                point.getParentClicks(),
                point.getParentCostMicros(),
                point.getParentImpressions(),
                point.getParentRequiredBudgetMicros());
          }
        }
      }
    }
  }
}

      

C#

// Copyright 2020 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.V11.Common;
using Google.Ads.GoogleAds.V11.Errors;
using Google.Ads.GoogleAds.V11.Resources;
using Google.Ads.GoogleAds.V11.Services;
using System;
using System.Collections.Generic;

namespace Google.Ads.GoogleAds.Examples.V11
{
    /// <summary>
    /// This example gets all available criterion bid modifier simulations for a given campaign.
    /// To get campaigns, run GetCampaigns.cs.
    /// </summary>
    public class GetCampaignCriterionBidModifierSimulations : ExampleBase
    {
        /// <summary>
        /// Command line options for running the <see cref="GetCampaignCriterionBidModifierSimulations"/>
        /// 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 campaign ID to get the criterion bid modifier simulations.
            /// </summary>
            [Option("campaignId", Required = true, HelpText =
                "The campaign ID to get the criterion bid modifier simulations.")]
            public long CampaignId { 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);

            GetCampaignCriterionBidModifierSimulations codeExample =
                new GetCampaignCriterionBidModifierSimulations();
            Console.WriteLine(codeExample.Description);
            codeExample.Run(new GoogleAdsClient(), options.CustomerId, options.CampaignId);
        }

        /// <summary>
        /// Returns a description about the code example.
        /// </summary>
        public override string Description =>
            "This example gets all available criterion bid modifier simulations for a given " +
            "campaign. To get campaigns, run GetCampaigns.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>
        /// <param name="campaignId">The campaign ID to get the criterion bid modifier
        ///     simulations.</param>
        public void Run(GoogleAdsClient client, long customerId, long campaignId)
        {
            // Get the GoogleAdsService.
            GoogleAdsServiceClient googleAdsService = client.GetService(
                Services.V11.GoogleAdsService);

            // Creates a query that retrieves the criterion bid modifier simulations.
            string query = $@"
                SELECT
                    campaign_criterion_simulation.criterion_id,
                    campaign_criterion_simulation.start_date,
                    campaign_criterion_simulation.end_date,
                    campaign_criterion_simulation.bid_modifier_point_list.points
                FROM campaign_criterion_simulation
                WHERE campaign_criterion_simulation.type = BID_MODIFIER
                AND campaign_criterion_simulation.campaign_id = {campaignId}";

            try
            {
                // Issue a search request.
                googleAdsService.SearchStream(customerId.ToString(), query,
                    delegate (SearchGoogleAdsStreamResponse response)
                    {
                        // Iterates over all rows in all messages and prints the requested field
                        // values for the campaign criterion bid modifier simulation in each row.
                        foreach (GoogleAdsRow googleAdsRow in response.Results)
                        {
                            CampaignCriterionSimulation simulation =
                                googleAdsRow.CampaignCriterionSimulation;
                            Console.WriteLine($@"Found campaign-level criterion bid modifier
                                simulation for criterion with ID
                                {simulation.CriterionId}, start date
                                {simulation.StartDate}, end date
                                {simulation.EndDate}, and points:");
                            foreach (BidModifierSimulationPoint point in
                                simulation.BidModifierPointList.Points)
                            {
                                Console.WriteLine($"\tbid modifier: {point.BidModifier:F} " +
                                    $"=> clicks: {point.Clicks}, " +
                                    $"cost: {point.CostMicros}, " +
                                    $"impressions: {point.Impressions}, " +
                                    $"parent clicks: {point.ParentClicks}, " +
                                    $"parent cost: {point.ParentCostMicros}, " +
                                    $"parent impressions: {point.ParentImpressions}, " +
                                    $"parent required budget: {point.ParentRequiredBudgetMicros}");
                            }

                            Console.WriteLine();
                        }
                    }
                );
            }
            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 2020 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\Planning;

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\V11\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V11\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V11\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V11\GoogleAdsServerStreamDecorator;
use Google\Ads\GoogleAds\V11\Common\BidModifierSimulationPoint;
use Google\Ads\GoogleAds\V11\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V11\Services\GoogleAdsRow;
use Google\ApiCore\ApiException;

/**
 * This example gets all available criterion bid modifier simulations for a given campaign.
 * To get campaigns, run GetCampaigns.php.
 */
class GetCampaignCriterionBidModifierSimulations
{
    private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
    private const CAMPAIGN_ID = 'INSERT_CAMPAIGN_ID_HERE';

    public static function main()
    {
        // Either pass the required parameters for this example on the command line, or insert them
        // into the constants above.
        $options = (new ArgumentParser())->parseCommandArguments([
            ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
            ArgumentNames::CAMPAIGN_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,
                $options[ArgumentNames::CAMPAIGN_ID] ?: self::CAMPAIGN_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 $campaignId the campaign ID to get the criterion bid modifier simulations
     */
    public static function runExample(
        GoogleAdsClient $googleAdsClient,
        int $customerId,
        int $campaignId
    ) {
        $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();

        // Creates a query that retrieves the criterion bid modifier simulations.
        $query = sprintf(
            'SELECT campaign_criterion_simulation.criterion_id, ' .
            'campaign_criterion_simulation.start_date, ' .
            'campaign_criterion_simulation.end_date, ' .
            'campaign_criterion_simulation.bid_modifier_point_list.points ' .
            'FROM campaign_criterion_simulation ' .
            'WHERE campaign_criterion_simulation.type = BID_MODIFIER ' .
            'AND campaign_criterion_simulation.campaign_id = %d',
            $campaignId
        );

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

        // Iterates over all rows in all messages and prints the requested field values for
        // the campaign criterion bid modifier simulation in each row.
        foreach ($stream->iterateAllElements() as $googleAdsRow) {
            /** @var GoogleAdsRow $googleAdsRow */
            $simulation = $googleAdsRow->getCampaignCriterionSimulation();
            printf(
                'Found campaign-level criterion bid modifier simulation for ' .
                'criterion with ID %d, start date "%s", end date "%s", and points:%s',
                $simulation->getCriterionId(),
                $simulation->getStartDate(),
                $simulation->getEndDate(),
                PHP_EOL
            );
            foreach ($simulation->getBidModifierPointList()->getPoints() as $point) {
                /** @var BidModifierSimulationPoint $point */
                printf(
                    '  bid modifier: %.2f => clicks: %d, cost: %d, impressions: %d, ' .
                    'parent clicks: %d, parent cost: %d, parent impressions: %d, ' .
                    'parent required budget: %d%s',
                    $point->getBidModifier(),
                    $point->getClicks(),
                    $point->getCostMicros(),
                    $point->getImpressions(),
                    $point->getParentClicks(),
                    $point->getParentCostMicros(),
                    $point->getParentImpressions(),
                    $point->getParentRequiredBudgetMicros(),
                    PHP_EOL
                );
            }

            print PHP_EOL;
        }
    }
}

GetCampaignCriterionBidModifierSimulations::main();

      

Python

#!/usr/bin/env python
# Copyright 2020 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 available criterion bid modifier simulations for a given campaign.

To get campaigns, run get_campaigns.py.
"""


import argparse
import sys

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


def main(client, customer_id, campaign_id):
    """Gets all available criterion bid modifier simulations for a campaign.

    Args:
      client: The Google Ads client.
      customer_id: The customer ID for which to get the simulations.
      campaign_id: The campaign ID from which to get the simulations.
    """
    googleads_service = client.get_service("GoogleAdsService")

    query = f"""
        SELECT
          campaign_criterion_simulation.criterion_id,
          campaign_criterion_simulation.start_date,
          campaign_criterion_simulation.end_date,
          campaign_criterion_simulation.bid_modifier_point_list.points
        FROM campaign_criterion_simulation
        WHERE
          campaign_criterion_simulation.type = BID_MODIFIER
          AND campaign_criterion_simulation.campaign_id = {campaign_id}"""

    # Issues a search request using streaming.
    stream = googleads_service.search_stream(
        customer_id=customer_id, query=query
    )

    # Iterates over all rows in all messages and prints the requested field
    # values for the ad group criterion CPC bid simulation in each row.
    for batch in stream:
        for row in batch.results:
            simulation = row.campaign_criterion_simulation

            print(
                "Found campaign-level criterion bid modifier simulation "
                f"for criterion with ID {simulation.criterion_id}, start "
                f"date {simulation.start_date}, end date "
                f"{simulation.end_date}, and points:"
            )

            for point in simulation.bid_modifier_point_list.points:
                print(
                    f"\tbid modifier: {'{point.bid_modifier:.2f}'} "
                    f"=> clicks: {point.clicks}, "
                    f"cost: {point.cost_micros}, "
                    f"impressions: {point.impressions}, "
                    f"parent clicks: {point.parent_clicks}, "
                    f"parent cost: {point.parent_cost_micros}, "
                    f"parent impressions: {point.parent_impressions}, "
                    "parent required budget: "
                    f"{point.parent_required_budget_micros}",
                )

            print()


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="v11")

    parser = argparse.ArgumentParser(
        description="Gets all available criterion bid modifier simulations "
        "for a given campaign."
    )
    # 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(
        "-i",
        "--campaign_id",
        type=str,
        required=True,
        help="The campaign ID from which to get available bid simulations.",
    )
    args = parser.parse_args()

    try:
        main(googleads_client, args.customer_id, args.campaign_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 2020 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 available criterion bid modifier simulations for a given
# campaign. To get campaigns, run get_campaigns.rb.

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

def get_campaign_criterion_bid_modifier_simulations(customer_id, campaign_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  # Creates a query that retrieves the criterion bid modifier simulations.
  query = <<~QUERY
    SELECT campaign_criterion_simulation.criterion_id,
           campaign_criterion_simulation.start_date,
           campaign_criterion_simulation.end_date,
           campaign_criterion_simulation.bid_modifier_point_list.points
    FROM campaign_criterion_simulation
    WHERE campaign_criterion_simulation.type = BID_MODIFIER
      AND campaign_criterion_simulation.campaign_id = #{campaign_id}
  QUERY

  # Issues a search stream request.
  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: query,
  )

  # Iterates over all rows in all messages and prints the requested field values
  # for the campaign criterion bid modifier simulation in each row.
  responses.each do |response|
    response.results.each do |row|
      simulation = row.campaign_criterion_simulation
      puts "Found campaign-level criterion bid modifier simulation for "\
        "criterion with ID #{simulation.criterion_id}, " \
        "start date #{simulation.start_date}, " \
        "end date #{simulation.end_date}, and points:"
      simulation.bid_modifier_point_list.points.each do |point|
        puts "  bid modifier: #{point.bid_modifier.round(2)} ==> " \
          "clicks: #{point.clicks}, cost: #{point.cost_micros}, " \
          "impressions: #{point.impressions}, " \
          "parent clicks: #{point.parent_clicks}, " \
          "parent cost micros: #{point.parent_cost_micros}, " \
          "parent impressions: #{point.parent_impressions}, " \
          "parent required budget: #{point.parent_required_budget_micros}"
      end
    end
  end
end

if __FILE__ == $0
  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.on('-c', '--campaign-id CAMPAIGN-ID', String, 'Campaign ID') do |v|
      options[:campaign_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_campaign_criterion_bid_modifier_simulations(
      options.fetch(:customer_id).tr("-", ""),
      options.fetch(:campaign_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 2020, 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 all available criterion bid modifier simulations for a given
# campaign. To get campaigns, run get_campaigns.pl.

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::V11::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";
my $campaign_id = "INSERT_CAMPAIGN_ID_HERE";

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

  # Create a query that retrieves the criterion bid modifier simulations.
  my $search_query =
    "SELECT campaign_criterion_simulation.criterion_id, " .
    "campaign_criterion_simulation.start_date, " .
    "campaign_criterion_simulation.end_date, " .
    "campaign_criterion_simulation.bid_modifier_point_list.points " .
    "FROM campaign_criterion_simulation " .
    "WHERE campaign_criterion_simulation.type = BID_MODIFIER " .
    "AND campaign_criterion_simulation.campaign_id = $campaign_id";

  my $search_stream_request =
    Google::Ads::GoogleAds::V11::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 stream request, iterate over all rows in all messages and
  # print the requested field values for the campaign criterion bid modifier
  # simulation in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      my $simulation     = $google_ads_row->{campaignCriterionSimulation};

      printf "Found campaign-level criterion bid modifier simulation for " .
        "criterion with ID %d, start date '%s', end date '%s', and points:\n",
        $simulation->{criterionId},
        $simulation->{startDate}, $simulation->{endDate};

      foreach my $point (@{$simulation->{bidModifierPointList}{points}}) {
        printf
          "  bid modifier: %.2f => clicks: %d, cost: %d, impressions: %d, " .
          "parent clicks: %d, parent cost: %d, parent impressions: %d, " .
          "parent required budget: %d\n",
          $point->{bidModifier},
          $point->{clicks},
          $point->{costMicros},
          $point->{impressions},
          $point->{parentClicks},
          $point->{parentCostMicros},
          $point->{parentImpressions},
          $point->{parentRequiredBudgetMicros};
      }
    });

  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,
  "campaign_id=i" => \$campaign_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, $campaign_id);

# Call the example.
get_campaign_criterion_bid_modifier_simulations($api_client,
  $customer_id =~ s/-//gr, $campaign_id);

=pod

=head1 NAME

get_campaign_criterion_bid_modifier_simulations

=head1 DESCRIPTION

This example gets all available criterion bid modifier simulations for a given
campaign. To get campaigns, run get_campaigns.pl.

=head1 SYNOPSIS

get_campaign_criterion_bid_modifier_simulations.pl [options]

    -help                       Show the help messacge.
    -customer_id                The Google Ads customer ID.
    -campaign_id                The campaign ID to get the criterion bid modifier
                                simulations.

=cut