Add Campaign Bid Modifier

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.campaignmanagement;

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.v6.common.InteractionTypeInfo;
import com.google.ads.googleads.v6.enums.InteractionTypeEnum;
import com.google.ads.googleads.v6.enums.ResponseContentTypeEnum.ResponseContentType;
import com.google.ads.googleads.v6.errors.GoogleAdsError;
import com.google.ads.googleads.v6.errors.GoogleAdsException;
import com.google.ads.googleads.v6.resources.CampaignBidModifier;
import com.google.ads.googleads.v6.services.CampaignBidModifierOperation;
import com.google.ads.googleads.v6.services.CampaignBidModifierServiceClient;
import com.google.ads.googleads.v6.services.MutateCampaignBidModifiersRequest;
import com.google.ads.googleads.v6.services.MutateCampaignBidModifiersResponse;
import com.google.ads.googleads.v6.utils.ResourceNames;
import java.io.FileNotFoundException;
import java.io.IOException;

/** Adds a campaign-level bid modifier for call interactions. */
public class AddCampaignBidModifier {

  private static class AddCampaignBidModifierParams extends CodeSampleParams {

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

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

    @Parameter(names = ArgumentNames.BID_MODIFIER_VALUE, required = true)
    private Double bidModifier;
  }

  public static void main(String[] args) {
    AddCampaignBidModifierParams params = new AddCampaignBidModifierParams();
    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");
      params.bidModifier = Double.parseDouble("INSERT_BID_MODIFIER_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 AddCampaignBidModifier()
          .runExample(googleAdsClient, params.customerId, params.campaignId, params.bidModifier);
    } 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 ID of the campaign where the bid modifier will be added.
   * @param bidModifier the value of the bid modifier to add.
   * @throws GoogleAdsException if an API request failed with one or more service errors.
   */
  private void runExample(
      GoogleAdsClient googleAdsClient, long customerId, long campaignId, double bidModifier) {

    String campaignResourceName = ResourceNames.campaign(customerId, campaignId);

    // Constructs a campaign bid modifier.
    CampaignBidModifier campaignBidModifier =
        CampaignBidModifier.newBuilder()
            .setCampaign(campaignResourceName)
            // Makes the bid modifier apply to call interactions.
            .setInteractionType(
                InteractionTypeInfo.newBuilder().setType(InteractionTypeEnum.InteractionType.CALLS))
            // Uses the specified bid modifier value.
            .setBidModifier(bidModifier)
            .build();

    // Constructs an operation to create the campaign bid modifier.
    CampaignBidModifierOperation op =
        CampaignBidModifierOperation.newBuilder().setCreate(campaignBidModifier).build();

    // Constructs a request to add the bid modifier.
    MutateCampaignBidModifiersRequest request =
        MutateCampaignBidModifiersRequest.newBuilder()
            .addOperations(op)
            .setCustomerId(String.valueOf(customerId))
            // Specifies that we want to the request to return the mutated object and not just its
            // resource name.
            .setResponseContentType(ResponseContentType.MUTABLE_RESOURCE)
            .build();

    // Sends the operation in a mutate request.
    try (CampaignBidModifierServiceClient agcServiceClient =
        googleAdsClient.getLatestVersion().createCampaignBidModifierServiceClient()) {
      MutateCampaignBidModifiersResponse response =
          agcServiceClient.mutateCampaignBidModifiers(request);
      /**
       * The resource returned in the response can be accessed directly in the results list. Its
       * fields can be read directly, and it can also be mutated further and used in subsequent
       * requests, without needing to make additional Get or Search requests.
       */
      CampaignBidModifier mutableResource = response.getResults(0).getCampaignBidModifier();
      System.out.printf(
          "Created campaign bid modifier with resource_name "
              + "'%s', criterion ID "
              + "%d, and bid modifier value "
              + "%s, under the campaign with "
              + "resource_name '%s'.%n",
          mutableResource.getResourceName(),
          mutableResource.getCriterionId(),
          mutableResource.getBidModifier(),
          mutableResource.getCampaign());
    }
  }
}

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.V6.Errors;
using Google.Ads.GoogleAds.V6.Common;
using Google.Ads.GoogleAds.V6.Resources;
using Google.Ads.GoogleAds.V6.Services;

using System;
using static Google.Ads.GoogleAds.V6.Enums.InteractionTypeEnum.Types;
using static Google.Ads.GoogleAds.V6.Enums.ResponseContentTypeEnum.Types;

namespace Google.Ads.GoogleAds.Examples.V6
{
    /// <summary>
    /// This code example demonstrates how to add a campaign-level bid modifier for call
    /// interactions.
    /// </summary>
    public class AddCampaignBidModifier : ExampleBase
    {
        /// <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)
        {
            AddCampaignBidModifier codeExample = new AddCampaignBidModifier();
            Console.WriteLine(codeExample.Description);

            // The Google Ads customer ID for which the call is made.
            long customerId = long.Parse("INSERT_CUSTOMER_ID_HERE");

            // ID of the campaign where the bid modifier will be added.
            long campaignId = long.Parse("INSERT_CAMPAIGN_ID_HERE");

            // The value of the bid modifier to add.
            double bidModifierValue = double.Parse("INSERT_BID_MODIFIER_VALUE_HERE");

            codeExample.Run(new GoogleAdsClient(), customerId, campaignId, bidModifierValue);
        }

        /// <summary>
        /// Returns a description about the code example.
        /// </summary>
        public override string Description =>
            "This code example demonstrates how to add a campaign-level bid modifier for call " +
            "interactions.";

        /// <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">ID of the campaign where the bid modifier will be added.
        /// </param>
        /// <param name="bidModifierValue">The value of the bid modifier to add.</param>
        public void Run(GoogleAdsClient client, long customerId, long campaignId,
            double bidModifierValue)
        {
            // Get the CampaignBidModifierService.
            CampaignBidModifierServiceClient campaignBidModifierService =
                client.GetService(Services.V6.CampaignBidModifierService);

            String campaignResourceName = ResourceNames.Campaign(customerId, campaignId);

            // Construct a campaign bid modifier.
            CampaignBidModifier campaignBidModifier = new CampaignBidModifier()
            {
                Campaign = campaignResourceName,
                InteractionType = new InteractionTypeInfo()
                {
                    Type = InteractionType.Calls
                },
                BidModifier = bidModifierValue
            };
            // Construct an operation to create the campaign bid modifier.
            CampaignBidModifierOperation op = new CampaignBidModifierOperation()
            {
                Create = campaignBidModifier
            };

            // Construct a request, and set the ResponseContentType field to
            // ResponseContentType.MutableResource, so that the response contains
            // the mutated object and not just its resource name.
            MutateCampaignBidModifiersRequest request = new MutateCampaignBidModifiersRequest()
            {
                CustomerId = customerId.ToString(),
                ResponseContentType = ResponseContentType.MutableResource,
                Operations = { op }
            };

            // Send the operation in a mutate request.
            try
            {
                MutateCampaignBidModifiersResponse response =
                    campaignBidModifierService.MutateCampaignBidModifiers(request);
                Console.WriteLine("Added {0} campaign bid modifiers:", response.Results.Count);

                // The resource returned in the response can be accessed directly in the
                // results list. Its fields can be read directly, and it can also be mutated
                // further and used in subsequent requests, without needing to make
                // additional Get or Search requests.

                foreach (MutateCampaignBidModifierResult result in response.Results)
                {
                    Console.WriteLine($"\tCreated campaign bid modifier with " +
                        $"resource name '{result.ResourceName}', " +
                        $"criterion ID '{result.CampaignBidModifier.CriterionId}', " +
                        $"and bid modifier value {result.CampaignBidModifier.BidModifier}, " +
                        $"under the campaign with resource_name " +
                        $"'{result.CampaignBidModifier.Campaign}'");
                }
            }
            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\CampaignManagement;

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\V6\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V6\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V6\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Util\V6\ResourceNames;
use Google\Ads\GoogleAds\V6\Common\InteractionTypeInfo;
use Google\Ads\GoogleAds\V6\Enums\InteractionTypeEnum;
use Google\Ads\GoogleAds\V6\Enums\ResponseContentTypeEnum\ResponseContentType;
use Google\Ads\GoogleAds\V6\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V6\Resources\CampaignBidModifier;
use Google\Ads\GoogleAds\V6\Services\CampaignBidModifierOperation;
use Google\ApiCore\ApiException;

/**
 * This example demonstrates how to add a campaign-level bid modifier for call interactions.
 */
class AddCampaignBidModifier
{
    private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
    private const CAMPAIGN_ID = 'INSERT_CAMPAIGN_ID_HERE';
    private const BID_MODIFIER_VALUE = 'INSERT_BID_MODIFIER_VALUE_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,
            ArgumentNames::BID_MODIFIER_VALUE => 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,
                $options[ArgumentNames::BID_MODIFIER_VALUE] ?: self::BID_MODIFIER_VALUE
            );
        } 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 ID of the campaign where the bid modifier will be added
     * @param float $bidModifierValue the value of the bid modifier to add
     */
    public static function runExample(
        GoogleAdsClient $googleAdsClient,
        int $customerId,
        int $campaignId,
        float $bidModifierValue
    ) {
        // Creates a campaign bid modifier.
        $campaignBidModifier = new CampaignBidModifier([
            'campaign' => ResourceNames::forCampaign($customerId, $campaignId),
            // Use the specified bid modifier value.
            'bid_modifier' => $bidModifierValue,
            // Make the bid modifier apply to call interactions.
            'interaction_type' => new InteractionTypeInfo(
                ['type' => InteractionTypeEnum\InteractionType::CALLS]
            )
        ]);

        // Creates a campaign bid modifier operation for creating a campaign bid modifier.
        $campaignBidModifierOperation = new CampaignBidModifierOperation();
        $campaignBidModifierOperation->setCreate($campaignBidModifier);

        // Issues a mutate request to add the campaign bid modifier.
        // Here we pass the optional parameter ResponseContentType::MUTABLE_RESOURCE so that the
        // response contains the mutated object and not just its resource name.
        $campaignBidModifierServiceClient = $googleAdsClient->getCampaignBidModifierServiceClient();
        $response = $campaignBidModifierServiceClient->mutateCampaignBidModifiers(
            $customerId,
            [$campaignBidModifierOperation],
            ['responseContentType' => ResponseContentType::MUTABLE_RESOURCE]
        );

        // The resource returned in the response can be accessed directly in the results list.
        // Its fields can be read directly, and it can also be mutated further and used in
        // subsequent requests, without needing to make additional Get or Search requests.
        /** @var CampaignBidModifier $addedCampaignBidModifier */
        $addedCampaignBidModifier = $response->getResults()[0]->getCampaignBidModifier();
        printf(
            "Added campaign bid modifier with resource_name '%s', criterion ID %d, and "
            . "bid modifier value %f, under the campaign with resource name '%s'.%s",
            $addedCampaignBidModifier->getResourceName(),
            $addedCampaignBidModifier->getCriterionId(),
            $addedCampaignBidModifier->getBidModifier(),
            $addedCampaignBidModifier->getCampaign(),
            PHP_EOL
        );
    }
}

AddCampaignBidModifier::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.
"""Demonstrates how to add a campaign-level bid modifier for call interactions.
"""


import argparse
import sys

import google.ads.google_ads.client


def main(client, customer_id, campaign_id, bid_modifier_value):
    campaign_service = client.get_service("CampaignService", version="v6")
    campaign_bm_service = client.get_service(
        "CampaignBidModifierService", version="v6"
    )

    # Create campaign bid modifier for call interactions with the specified
    # campaign ID and bid modifier value.
    campaign_bid_modifier_operation = client.get_type(
        "CampaignBidModifierOperation"
    )
    campaign_bid_modifier = campaign_bid_modifier_operation.create

    # Set the campaign.
    campaign_bid_modifier.campaign = campaign_service.campaign_path(
        customer_id, campaign_id
    )

    # Set the bid modifier.
    campaign_bid_modifier.bid_modifier = bid_modifier_value

    # Sets the interaction type.
    campaign_bid_modifier.interaction_type.type = client.get_type(
        "InteractionTypeEnum", version="v6"
    ).CALLS

    # Add the campaign bid modifier. Here we pass the optional parameter
    # response_content_type=MUTABLE_RESOURCE so that the response contains
    # the mutated object and not just its resource name.
    try:
        campaign_bm_response = campaign_bm_service.mutate_campaign_bid_modifiers(
            customer_id,
            [campaign_bid_modifier_operation],
            response_content_type=client.get_type(
                "ResponseContentTypeEnum", version="v6"
            ).MUTABLE_RESOURCE,
        )
    except google.ads.google_ads.errors.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)

    # The resource returned in the response can be accessed directly in the
    # results list. Its fields can be read directly, and it can also be mutated
    # further and used in subsequent requests, without needing to make
    # additional Get or Search requests.
    mutable_resource = campaign_bm_response.results[0].campaign_bid_modifier
    print(
        "Created campaign bid modifier with resource_name "
        f"'{mutable_resource.resource_name}', criterion ID "
        f"'{mutable_resource.criterion_id}', and bid modifier value "
        f"'{mutable_resource.bid_modifier}', under the campaign with "
        f"resource_name '{mutable_resource.campaign}', "
    )


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=(
            "Adds a bid modifier to the specified campaign ID, for "
            "the given 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.",
    )
    parser.add_argument(
        "-i", "--campaign_id", type=str, required=True, help="The campaign ID."
    )
    parser.add_argument(
        "-b",
        "--bid_modifier_value",
        type=float,
        required=False,
        default=1.5,
        help="The bid modifier value.",
    )
    args = parser.parse_args()

    main(
        google_ads_client,
        args.customer_id,
        args.campaign_id,
        args.bid_modifier_value,
    )

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 demonstrates how to add a campaign-level bid modifier
# for call interactions.

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

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

  operation = client.operation.create_resource.campaign_bid_modifier do |campaign_bid_modifier|
    # Sets the campaign.
    campaign_bid_modifier.campaign = client.path.campaign(customer_id, campaign_id)

    # Sets the Bid Modifier.
    campaign_bid_modifier.bid_modifier = bid_modifier

    # Sets the Interaction Type.
    campaign_bid_modifier.interaction_type = client.resource.interaction_type_info
    campaign_bid_modifier.interaction_type.type = :CALLS
  end

  # Create campaign Bid Modifier Service
  campaign_bid_modifier_service = client.service.campaign_bid_modifier
  # Add the Campaign Bid Modifier
  # Add the campaign bid modifier. Here we pass the optional parameter
  # response_content_type=MUTABLE_RESOURCE so that the response contains
  # the mutated object and not just its resource name.
  response = campaign_bid_modifier_service.mutate_campaign_bid_modifiers(
    customer_id: customer_id,
    operations: [operation],
    response_content_type: :MUTABLE_RESOURCE,
  )

  puts "Added #{response.results.size} campaign bid modifiers:"
  response.results.each do |added_campaign_bid_modifier|
    # The resource returned in the response can be accessed directly in the
    # results list. Its fields can be read directly, and it can also be mutated
    # further and used in subsequent requests, without needing to make
    # additional Get or Search requests.
    mutable_resource = added_campaign_bid_modifier.campaign_bid_modifier
    puts "\tCreated campaign bid modifier with " \
      "resource_name '#{mutable_resource.resource_name}', " \
      "criterion ID #{mutable_resource.criterion_id}, " \
      "bid_modifier #{mutable_resource.bid_modifier}, " \
      "under the campaign with resource_name '#{mutable_resource.campaign}'"
  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'
  options[:campaign_id] = 'INSERT_CAMPAIGN_ID_HERE'
  options[:bid_modifier] = 'INSERT_BID_MODIFIER_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.on('-B', '--bid-modifier-value BID-MODIFIER-VALUE', String,
        'Bid Modifier') do |v|
      options[:bid_modifier] = v.to_f
    end

    opts.separator ''
    opts.separator 'Help:'

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

  begin
    add_campaign_bid_modifier(options.fetch(:customer_id).tr("-", ""),
        options[:campaign_id], options[:bid_modifier])
  rescue Google::Ads::GoogleAds::Errors::GoogleAdsError => e
    e.failure.errors.each do |error|
      STDERR.printf("Error with message: %s\n", error.message)
      if error.location
        error.location.field_path_elements.each do |field_path_element|
          STDERR.printf("\tOn field: %s\n", field_path_element.field_name)
        end
      end
      error.error_code.to_h.each do |k, v|
        next if v == :UNSPECIFIED
        STDERR.printf("\tType: %s\n\tCode: %s\n", k, v)
      end
    end
    raise
  end
end

Perl

#!/usr/bin/perl -w
#
# Copyright 2019, Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This example demonstrates how to add a campaign-level bid modifier for call
# interactions.

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::V6::Resources::CampaignBidModifier;
use Google::Ads::GoogleAds::V6::Common::InteractionTypeInfo;
use Google::Ads::GoogleAds::V6::Enums::InteractionTypeEnum qw(CALLS);
use Google::Ads::GoogleAds::V6::Enums::ResponseContentTypeEnum
  qw(MUTABLE_RESOURCE);
use
  Google::Ads::GoogleAds::V6::Services::CampaignBidModifierService::CampaignBidModifierOperation;
use Google::Ads::GoogleAds::V6::Utils::ResourceNames;

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";
my $bid_modifier_value = "INSERT_BID_MODIFIER_VALUE_HERE";

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

  # Create a campaign bid modifier for call interactions with the specified
  # campaign ID and bid modifier value.
  my $campaign_bid_modifier =
    Google::Ads::GoogleAds::V6::Resources::CampaignBidModifier->new({
      campaign => Google::Ads::GoogleAds::V6::Utils::ResourceNames::campaign(
        $customer_id, $campaign_id
      ),
      # Make the bid modifier apply to call interactions.
      interactionType =>
        Google::Ads::GoogleAds::V6::Common::InteractionTypeInfo->new({
          type => CALLS
        }
        ),
      # Set the bid modifier value.
      bidModifier => $bid_modifier_value
    });

  # Create a campaign bid modifier operation.
  my $campaign_bid_modifier_operation =
    Google::Ads::GoogleAds::V6::Services::CampaignBidModifierService::CampaignBidModifierOperation
    ->new({
      create => $campaign_bid_modifier
    });

  # Add the campaign bid modifier. Here we pass the optional parameter
  # responseContentType => MUTABLE_RESOURCE so that the response contains the
  # mutated object and not just its resource name.
  my $campaign_bid_modifiers_response =
    $api_client->CampaignBidModifierService()->mutate({
      customerId          => $customer_id,
      operations          => [$campaign_bid_modifier_operation],
      responseContentType => MUTABLE_RESOURCE
    });

  # The resource returned in the response can be accessed directly in the
  # results list. Its fields can be read directly, and it can also be mutated
  # further and used in subsequent requests, without needing to make additional
  # Get or Search requests.
  my $mutable_resource =
    $campaign_bid_modifiers_response->{results}[0]{campaignBidModifier};

  printf
    "Created campaign bid modifier with resource name '%s', criterion ID %d, "
    . "and bid modifier value %s, under the campaign with resource name '%s'.\n",
    $mutable_resource->{resourceName}, $mutable_resource->{criterionId},
    $mutable_resource->{bidModifier},  $mutable_resource->{campaign};

  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,
  "bid_modifier_value=f" => \$bid_modifier_value
);

# 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, $bid_modifier_value);

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

=pod

=head1 NAME

add_campaign_bid_modifier

=head1 DESCRIPTION

This example demonstrates how to add a campaign-level bid modifier for call interactions.

=head1 SYNOPSIS

add_campaign_bid_modifier.pl [options]

    -help                       Show the help message.
    -customer_id                The Google Ads customer ID.
    -campaign_id                The campaign ID.
    -bid_modifier_value         The bid modifier value.

=cut