Google Ads API is returning to beta status. Please read our blog post for more details.

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.v2.errors.GoogleAdsException;
import com.google.ads.googleads.v2.utils.ResourceNames;
import com.google.ads.googleads.v2.common.InteractionTypeInfo;
import com.google.ads.googleads.v2.enums.InteractionTypeEnum;
import com.google.ads.googleads.v2.errors.GoogleAdsError;
import com.google.ads.googleads.v2.resources.CampaignBidModifier;
import com.google.ads.googleads.v2.services.CampaignBidModifierOperation;
import com.google.ads.googleads.v2.services.CampaignBidModifierServiceClient;
import com.google.ads.googleads.v2.services.MutateCampaignBidModifierResult;
import com.google.ads.googleads.v2.services.MutateCampaignBidModifiersResponse;
import com.google.common.collect.ImmutableList;
import com.google.protobuf.DoubleValue;
import com.google.protobuf.StringValue;
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, 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;
    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 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);
      }
    }
  }

  /**
   * 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(StringValue.of(campaignResourceName))
            // Makes the bid modifier apply to call interactions.
            .setInteractionType(
                InteractionTypeInfo.newBuilder().setType(InteractionTypeEnum.InteractionType.CALLS))
            // Uses the specified bid modifier value.
            .setBidModifier(DoubleValue.of(bidModifier))
            .build();

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

    // Sends the operation in a mutate request.
    try (CampaignBidModifierServiceClient agcServiceClient =
        googleAdsClient.getLatestVersion().createCampaignBidModifierServiceClient()) {
      MutateCampaignBidModifiersResponse response =
          agcServiceClient.mutateCampaignBidModifiers(
              Long.toString(customerId), ImmutableList.of(op));
      System.out.printf("Added %d campaign bid modifiers:%n", response.getResultsCount());
      for (MutateCampaignBidModifierResult result : response.getResultsList()) {
        System.out.printf("\t%s%n", result.getResourceName());
      }
    }
  }
}
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.V2.Errors;
using Google.Ads.GoogleAds.V2.Common;
using Google.Ads.GoogleAds.V2.Resources;
using Google.Ads.GoogleAds.V2.Services;

using System;
using static Google.Ads.GoogleAds.V2.Enums.InteractionTypeEnum.Types;

namespace Google.Ads.GoogleAds.Examples.V2
{
    /// <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 bidModifier = double.Parse("INSERT_BID_MODIFIER_HERE");

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

        /// <summary>
        /// Returns a description about the code example.
        /// </summary>
        public override string Description
        {
            get
            {
                return "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="bidModifier">The value of the bid modifier to add.</param>
        public void Run(GoogleAdsClient client, long customerId, long campaignId,
            double bidModifier)
        {
            // Get the CampaignBidModifierService.
            CampaignBidModifierServiceClient campaignBidModifierService =
                client.GetService(Services.V2.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 = bidModifier
            };

            // Construct an operation to create the campaign bid modifier.
            CampaignBidModifierOperation op = new CampaignBidModifierOperation()
            {
                Create = campaignBidModifier
            };

            // Send the operation in a mutate request.
            try
            {
                MutateCampaignBidModifiersResponse response =
                    campaignBidModifierService.MutateCampaignBidModifiers(customerId.ToString(),
                        new CampaignBidModifierOperation[] { op });
                Console.WriteLine("Added {0} campaign bid modifiers:", response.Results.Count);
                foreach (MutateCampaignBidModifierResult result in response.Results)
                {
                    Console.WriteLine($"\t{result.ResourceName}");
                }
            }
            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\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\V2\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V2\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V2\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Util\V2\ResourceNames;
use Google\Ads\GoogleAds\V2\Common\InteractionTypeInfo;
use Google\Ads\GoogleAds\V2\Enums\InteractionTypeEnum;
use Google\Ads\GoogleAds\V2\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V2\Resources\CampaignBidModifier;
use Google\Ads\GoogleAds\V2\Services\CampaignBidModifierOperation;
use Google\ApiCore\ApiException;
use Google\Protobuf\DoubleValue;
use Google\Protobuf\StringValue;

/**
 * This example demonstrates how to add a campaign-level bid modifier for call interactions.
 */
class AddCampaignBidModifier
{
    const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
    const CAMPAIGN_ID = 'INSERT_CAMPAIGN_ID_HERE';
    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
                );
            }
        } 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 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' => new StringValue(
                ['value' => ResourceNames::forCampaign($customerId, $campaignId)]
            ),
            // Use the specified bid modifier value.
            'bid_modifier' => new DoubleValue(['value' => $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.
        $campaignBidModifierServiceClient = $googleAdsClient->getCampaignBidModifierServiceClient();
        $response = $campaignBidModifierServiceClient->mutateCampaignBidModifiers(
            $customerId,
            [$campaignBidModifierOperation]
        );

        printf("Added %d campaign bid modifier:%s", $response->getResults()->count(), PHP_EOL);

        foreach ($response->getResults() as $addedCampaignBidModifier) {
            /** @var CampaignBidModifier $addedCampaignBidModifier */
            print $addedCampaignBidModifier->getResourceName() . 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.
"""

from __future__ import absolute_import

import argparse
import six
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='v2')
    campaign_bm_service = client.get_service('CampaignBidModifierService',
                                             version='v2')

    # 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.value = campaign_service.campaign_path(
        customer_id, campaign_id)

    # Set the bid modifier.
    campaign_bid_modifier.bid_modifier.value = bid_modifier_value

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

    # Add the campaign bid modifier.
    try:
        campaign_bm_response = (
            campaign_bm_service.mutate_campaign_bid_modifiers(
                customer_id, [campaign_bid_modifier_operation]))
    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)

    print('Created campaign bid modifier: %s.'
          % campaign_bm_response.results[0].resource_name)


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=six.text_type,
                        required=True, help='The Google Ads customer ID.')
    parser.add_argument('-i', '--campaign_id', type=six.text_type,
                        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
  response = campaign_bid_modifier_service.mutate_campaign_bid_modifiers(
    customer_id,
    [operation]
  )

  puts sprintf('Added %d campaign bid modifiers:', response.results.size)
  response.results.each do |added_campaign_bid_modifier|
    puts sprintf("\t%s", added_campaign_bid_modifier.resource_name)
  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('-A', '--campaign-id CAMPAIGN-ID', String, 'Campaign ID') do |v|
      options[:campaign_id] = v
    end

    opts.on('-B', '--bid-modifier BID-MODIFIER', 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
  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