キャンペーンの下書きを追加する

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

import static com.google.ads.googleads.examples.utils.CodeSampleHelper.getPrintableDateTime;

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.errors.GoogleAdsError;
import com.google.ads.googleads.v11.errors.GoogleAdsException;
import com.google.ads.googleads.v11.resources.CampaignDraft;
import com.google.ads.googleads.v11.services.CampaignDraftOperation;
import com.google.ads.googleads.v11.services.CampaignDraftServiceClient;
import com.google.ads.googleads.v11.services.MutateCampaignDraftResult;
import com.google.ads.googleads.v11.services.MutateCampaignDraftsResponse;
import com.google.ads.googleads.v11.utils.ResourceNames;
import com.google.common.collect.ImmutableList;
import java.io.FileNotFoundException;
import java.io.IOException;

/**
 * Adds a campaign draft for a campaign. Make sure you specify a campaign that has a non-shared
 * budget.
 */
public class AddCampaignDraft {

  private static class AddCampaignDraftParams extends CodeSampleParams {

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

    @Parameter(names = ArgumentNames.BASE_CAMPAIGN_ID, required = true)
    private Long baseCampaignId;
  }

  public static void main(String[] args) {
    AddCampaignDraftParams params = new AddCampaignDraftParams();
    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.baseCampaignId = Long.valueOf("INSERT_BASE_CAMPAIGN_ID_HERE");
    }

    GoogleAdsClient googleAdsClient;
    try {
      googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
    } catch (FileNotFoundException fnfe) {
      System.err.printf(
          "Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
      return;
    } catch (IOException ioe) {
      System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
      return;
    }

    try {
      new AddCampaignDraft().runExample(googleAdsClient, params.customerId, params.baseCampaignId);
    } 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 client to use for API calls.
   * @param customerId the customer ID.
   * @param baseCampaignId the original campaign ID from which to create a draft. Must have a shared
   *     budget.
   */
  private void runExample(GoogleAdsClient googleAdsClient, long customerId, long baseCampaignId) {
    // Creates a CampaignDraft object with the provided base campaign ID.
    CampaignDraft draft =
        CampaignDraft.newBuilder()
            .setBaseCampaign(ResourceNames.campaign(customerId, baseCampaignId))
            .setName("Campaign Draft #" + getPrintableDateTime())
            .build();

    // Creates an operation to create the draft campaign.
    CampaignDraftOperation operation = CampaignDraftOperation.newBuilder().setCreate(draft).build();

    // Creates a service client to connect to the API.
    try (CampaignDraftServiceClient campaignDraftServiceClient =
        googleAdsClient.getLatestVersion().createCampaignDraftServiceClient()) {
      // Issues the mutate request.
      MutateCampaignDraftsResponse response =
          campaignDraftServiceClient.mutateCampaignDrafts(
              String.valueOf(customerId), ImmutableList.of(operation));

      // Displays the result.
      for (MutateCampaignDraftResult result : response.getResultsList()) {
        System.out.printf(
            "Created campaign draft with resource name '%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 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;
using System.Linq;

namespace Google.Ads.GoogleAds.Examples.V11
{
    /// <summary>
    /// This code example adds a campaign draft for a campaign. Make sure you specify a
    /// campaign that has a budget with explicitly_shared set to false.
    /// </summary>
    public class AddCampaignDraft : ExampleBase
    {
        /// <summary>
        /// Command line options for running the <see cref="AddCampaignDraft"/> 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>
            /// ID of the base campaign.
            /// </summary>
            [Option("baseCampaignId", Required = true, HelpText =
                "ID of the base campaign.")]
            public long BaseCampaignId { 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);

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

        /// <summary>
        /// Returns a description about the code example.
        /// </summary>
        public override string Description =>
            "This code example adds a campaign draft for a campaign. Make sure you specify a " +
            "campaign that has a budget with explicitly_shared set to false.";

        /// <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="baseCampaignId">ID of the base campaign</param>
        public void Run(GoogleAdsClient client, long customerId, long baseCampaignId)
        {
            try
            {
                string draftResourceName = CreateCampaignDraft(client, customerId, baseCampaignId);
                string draftCampaignResourceName = FetchDraftCampaign(client, customerId,
                    draftResourceName);
                AddLanguageCriteria(client, customerId, draftCampaignResourceName);
            }
            catch (GoogleAdsException e)
            {
                Console.WriteLine("Failure:");
                Console.WriteLine($"Message: {e.Message}");
                Console.WriteLine($"Failure: {e.Failure}");
                Console.WriteLine($"Request ID: {e.RequestId}");
                throw;
            }
        }

        /// <summary>
        /// Creates the campaign draft.
        /// </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="baseCampaignId">The base campaign ID.</param>
        /// <returns></returns>
        private static string CreateCampaignDraft(GoogleAdsClient client, long customerId,
            long baseCampaignId)
        {
            // Get the CampaignDraftService.
            CampaignDraftServiceClient campaignDraftService =
                client.GetService(Services.V11.CampaignDraftService);

            CampaignDraft campaignDraft = new CampaignDraft()
            {
                BaseCampaign = ResourceNames.Campaign(customerId, baseCampaignId),
                Name = "Campaign Draft #" + ExampleUtilities.GetRandomString(),
            };

            CampaignDraftOperation operation = new CampaignDraftOperation()
            {
                Create = campaignDraft
            };

            MutateCampaignDraftsResponse response = campaignDraftService.MutateCampaignDrafts(
                customerId.ToString(), new CampaignDraftOperation[] { operation });

            string draftResourceName = response.Results[0].ResourceName;
            Console.WriteLine($"Campaign with resource ID = '{draftResourceName}' was added.");
            return draftResourceName;
        }

        /// <summary>
        /// Fetches the draft campaign associated with a campaign draft.
        /// </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="draftResourceName">Resource name of the draft.</param>
        /// <returns></returns>
        private static string FetchDraftCampaign(GoogleAdsClient client, long customerId,
            string draftResourceName)
        {
            // Get the GoogleAdsService.
            GoogleAdsServiceClient googleAdsService =
                client.GetService(Services.V11.GoogleAdsService);

            // Once the draft is created, you can modify the draft campaign as if it were
            // a real campaign. For example, you may add criteria, adjust bids, or even
            // include additional ads. Adding a criterion is shown here.
            string query = $@"
                SELECT
                    campaign_draft.draft_campaign
                FROM
                    campaign_draft
                WHERE
                    campaign_draft.resource_name = '{draftResourceName}'";

            // Get the draft campaign resource name.
            string draftCampaignResourceName = googleAdsService.Search(
                customerId.ToString(), query).First().CampaignDraft.DraftCampaign;
            return draftCampaignResourceName;
        }

        /// <summary>
        /// Adds a language criterion to the draft campaign.
        /// </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="draftCampaignResourceName">Resource name of the draft campaign.</param>
        private static void AddLanguageCriteria(GoogleAdsClient client, long customerId,
            string draftCampaignResourceName)
        {
            // Get the CampaignCriterionService.
            CampaignCriterionServiceClient campaignCriterionService =
                client.GetService(Services.V11.CampaignCriterionService);

            // Add a language criterion.
            CampaignCriterionOperation criterionOperation = new CampaignCriterionOperation()
            {
                Create = new CampaignCriterion()
                {
                    Language = new LanguageInfo()
                    {
                        // Spanish
                        LanguageConstant = ResourceNames.LanguageConstant(1003)
                    },
                    Campaign = draftCampaignResourceName
                }
            };

            MutateCampaignCriteriaResponse campaignCriteriaResponse =
                campaignCriterionService.MutateCampaignCriteria(
                    customerId.ToString(),
                    new CampaignCriterionOperation[] { criterionOperation });

            string newCampaignCriterionResource = campaignCriteriaResponse.Results[0].ResourceName;
            Console.WriteLine($"Campaign Criterion with resource ID = " +
                $"'{newCampaignCriterionResource}' was added to campaign with resource ID = " +
                $"'{draftCampaignResourceName}'.");
        }
    }
}

      

PHP

<?php

/**
 * 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
 *
 *     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\Examples\Utils\Helper;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
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\Util\V11\ResourceNames;
use Google\Ads\GoogleAds\V11\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V11\Resources\CampaignDraft;
use Google\Ads\GoogleAds\V11\Services\CampaignDraftOperation;
use Google\ApiCore\ApiException;

/**
 * This example adds a campaign draft for a campaign. Make sure you specify a
 * campaign that has a non-shared budget.
 */
class AddCampaignDraft
{
    private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
    private const BASE_CAMPAIGN_ID = 'INSERT_BASE_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::BASE_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::BASE_CAMPAIGN_ID] ?: self::BASE_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 $baseCampaignId the campaign ID to base the draft on
     */
    public static function runExample(
        GoogleAdsClient $googleAdsClient,
        int $customerId,
        int $baseCampaignId
    ) {
        // Creates a campaign draft.
        $campaignDraft = new CampaignDraft([
            'base_campaign' => ResourceNames::forCampaign($customerId, $baseCampaignId),
            'name' => 'Campaign Draft #' . Helper::getPrintableDatetime()
        ]);

        // Creates a campaign draft operation.
        $campaignDraftOperation = new CampaignDraftOperation();
        $campaignDraftOperation->setCreate($campaignDraft);

        // Issues a mutate request to add the campaign draft.
        $campaignDraftServiceClient = $googleAdsClient->getCampaignDraftServiceClient();
        $response = $campaignDraftServiceClient->mutateCampaignDrafts(
            $customerId,
            [$campaignDraftOperation]
        );

        printf(
            "Added a campaign draft with resource name '%s'.%s",
            $response->getResults()[0]->getResourceName(),
            PHP_EOL
        );
    }
}

AddCampaignDraft::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.
"""This example adds a campaign draft for a campaign.

Make sure you specify a campaign that has a non-shared budget.
"""


import argparse
import sys
from uuid import uuid4

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


def main(client, customer_id, base_campaign_id):
    campaign_service = client.get_service("CampaignService")
    campaign_draft_service = client.get_service("CampaignDraftService")

    # Creates a campaign draft operation.
    campaign_draft_operation = client.get_type("CampaignDraftOperation")
    campaign_draft = campaign_draft_operation.create

    # Creates a campaign draft.
    campaign_draft.base_campaign = campaign_service.campaign_path(
        customer_id, base_campaign_id
    )
    campaign_draft.name = f"Campaign Draft #{uuid4()}"

    # Issues a mutate request to add the campaign draft.
    campaign_draft_response = campaign_draft_service.mutate_campaign_drafts(
        customer_id=customer_id, operations=[campaign_draft_operation]
    )
    print(
        "Created campaign draft: "
        f'"{campaign_draft_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.
    googleads_client = GoogleAdsClient.load_from_storage(version="v11")

    parser = argparse.ArgumentParser(
        description="Adds a campaign draft for the specified base 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",
        "--base_campaign_id",
        type=str,
        required=True,
        help="The base campaign ID.",
    )
    args = parser.parse_args()

    try:
        main(googleads_client, args.customer_id, args.base_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 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
#
#     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 adds a campaign draft for a campaign. Make sure you specify a
# campaign that has a budget with explicitly_shared set to false.

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

def add_campaign_draft(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

  draft_operation = client.operation.create_resource.campaign_draft do |draft|
    draft.base_campaign = client.path.campaign(customer_id, campaign_id)
    draft.name = "Campaign Draft ##{(Time.new.to_f * 1000).to_i}"
  end

  draft_response = client.service.campaign_draft.mutate_campaign_drafts(
    customer_id: customer_id,
    operations: [draft_operation],
  )

  draft_resource_name = draft_response.results.first.resource_name
  puts "Campaign Draft #{draft_resource_name} was created."

  # Once the draft is created, you can modify the draft campaign as if it were
  # a real campaign. For example, you may add criteria, adjust bids, or even
  # include additional ads. Adding a criterion is shown here.
  query = <<~EOQUERY
    SELECT campaign_draft.draft_campaign
    FROM campaign_draft
    WHERE campaign_draft.resource_name = "#{draft_resource_name}"
  EOQUERY
  search_response = client.service.google_ads.search(customer_id: customer_id, query: query)
  draft_campaign_resource_name = search_response.first.campaign_draft.draft_campaign

  criterion_operation = client.operation.create_resource.campaign_criterion do |cc|
    cc.campaign = draft_campaign_resource_name
    cc.language = client.resource.language_info do |li|
      li.language_constant = client.path.language_constant(1003) # Spanish
    end
  end

  criterion_response = client.service.campaign_criterion.mutate_campaign_criteria(
    customer_id: customer_id,
    operations: [criterion_operation],
  )

  puts "Campaign Criterion #{criterion_response.results.first.resource_name}" \
      " created in campaign #{draft_campaign_resource_name}."
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'

  OptionParser.new do |opts|
    opts.banner = sprintf('Usage: add_campaigns.rb [options]')

    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', '--base-campaign-id BASE-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
    add_campaign_draft(
      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 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 adds a campaign draft for a campaign. Make sure you specify a
# campaign that has a non-shared budget.

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::V11::Resources::CampaignDraft;
use
  Google::Ads::GoogleAds::V11::Services::CampaignDraftService::CampaignDraftOperation;
use Google::Ads::GoogleAds::V11::Utils::ResourceNames;

use Getopt::Long qw(:config auto_help);
use Pod::Usage;
use Cwd qw(abs_path);
use Data::Uniqid qw(uniqid);

# 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 $base_campaign_id = "INSERT_BASE_CAMPAIGN_ID_HERE";

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

  # Create a campaign draft.
  my $campaign_draft =
    Google::Ads::GoogleAds::V11::Resources::CampaignDraft->new({
      baseCampaign =>
        Google::Ads::GoogleAds::V11::Utils::ResourceNames::campaign(
        $customer_id, $base_campaign_id
        ),
      name => "Campaign Draft #" . uniqid()});

  # Create a campaign draft operation.
  my $campaign_draft_operation =
    Google::Ads::GoogleAds::V11::Services::CampaignDraftService::CampaignDraftOperation
    ->new({
      create => $campaign_draft
    });

  # Add the campaign draft.
  my $campaign_drafts_response = $api_client->CampaignDraftService()->mutate({
      customerId => $customer_id,
      operations => [$campaign_draft_operation]});

  printf "Added a campaign draft with resource name: '%s'.\n",
    $campaign_drafts_response->{results}[0]{resourceName};

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

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

=pod

=head1 NAME

add_campaign_draft

=head1 DESCRIPTION

This example adds a campaign draft for a campaign. Make sure you specify a campaign
that has a non-shared budget.

=head1 SYNOPSIS

add_campaign_draft.pl [options]

    -help                       Show the help message.
    -customer_id                The Google Ads customer ID.
    -base_campaign_id           The campaign ID to base the draft on.

=cut