AddCampaignTargetingCriteria.cs

// 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.V16.Common;
using Google.Ads.GoogleAds.V16.Errors;
using Google.Ads.GoogleAds.V16.Resources;
using Google.Ads.GoogleAds.V16.Services;
using System;
using System.Collections.Generic;
using static Google.Ads.GoogleAds.V16.Enums.KeywordMatchTypeEnum.Types;
using static Google.Ads.GoogleAds.V16.Enums.ProximityRadiusUnitsEnum.Types;

namespace Google.Ads.GoogleAds.Examples.V16
{
    /// <summary>
    /// This code example illustrates adding campaign targeting criteria.
    /// </summary>
    public class AddCampaignTargetingCriteria : ExampleBase
    {
        /// <summary>
        /// Command line options for running the <see cref="AddCampaignTargetingCriteria"/> 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 campaign to which targeting criteria are added.
            /// </summary>
            [Option("campaignId", Required = true, HelpText =
                "ID of the campaign to which targeting criteria are added.")]
            public long CampaignId { get; set; }

            /// <summary>
            /// The keyword text for which to add a criterion.
            /// </summary>
            [Option("keywordText", Required = true, HelpText =
                "The keyword text for which to add a criterion.")]
            public string KeywordText { get; set; }

            /// <summary>
            /// The locationId for which to add a criterion.
            /// </summary>
            [Option("locationId", Required = true, HelpText =
                "The locationId for which to add a criterion.")]
            public long LocationId { 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);

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

        /// <summary>
        /// Returns a description about the code example.
        /// </summary>
        public override string Description =>
            "This code example illustrates adding campaign targeting criteria.";

        /// <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 to which targeting criteria are added.
        /// </param>
        /// <param name="keywordText">the keyword text for which to add a criterion.</param>
        /// <param name="locationId">the locationId for which to add a criterion.</param>
        public void Run(GoogleAdsClient client, long customerId, long campaignId,
            string keywordText, long locationId)
        {
            // Get the CampaignCriterionService.
            CampaignCriterionServiceClient campaignCriterionService =
                client.GetService(Services.V16.CampaignCriterionService);

            // Set the Campaign Resource Name
            string campaignResourceName = ResourceNames.Campaign(customerId, campaignId);

            // Add a campaign level negative keyword from keywordText.
            CampaignCriterion keywordCriterion = buildNegativeKeywordCriterion(keywordText,
                campaignResourceName);

            // Creates a location constant (provided by GeoTargetConstantService) as a campaign
            // targeting criterion. Please refer to GetGeoTargetConstantsByName.cs for retrieval
            // of location constants.
            CampaignCriterion locationCriterion = buildLocationCriterion(locationId,
                campaignResourceName);

            // Add a proximity criterion
            CampaignCriterion proximityCriterion = buildProximityCriterion(campaignResourceName);

            // Create the operations.
            CampaignCriterionOperation negativeCriterionOperation =
                new CampaignCriterionOperation()
                {
                    Create = keywordCriterion
                };

            CampaignCriterionOperation locationCriterionOperation =
                new CampaignCriterionOperation()
                {
                    Create = locationCriterion
                };

            CampaignCriterionOperation proximityCriterionOperation =
                new CampaignCriterionOperation()
                {
                    Create = proximityCriterion
                };

            CampaignCriterionOperation[] operations = new CampaignCriterionOperation[] {
                negativeCriterionOperation,
                locationCriterionOperation,
                proximityCriterionOperation
            };

            try
            {
                // Create the campaign criterion.
                MutateCampaignCriteriaResponse response =
                    campaignCriterionService.MutateCampaignCriteria(customerId.ToString(),
                        operations);

                // Display the results.
                foreach (MutateCampaignCriterionResult criterionResult in response.Results)
                {
                    Console.WriteLine($"New campaign criterion with resource name = " +
                        $"'{criterionResult.ResourceName}' was added to campaign " +
                        "ID {campaignId}.");
                }
            }
            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 a negative keyword as a campaign targeting criterion.
        /// </summary>
        /// <param name="keywordText">the keyword text to exclude.</param>
        /// <param name="campaignResourceName">the campaign where the keyword will be excluded.
        /// </param>
        /// <returns>a campaign criterion object with the negative keyword targeting.</returns>
        private CampaignCriterion buildNegativeKeywordCriterion(string keywordText,
            string campaignResourceName)
        {
            return new CampaignCriterion()
            {
                Campaign = campaignResourceName,
                Negative = true,
                Keyword = new KeywordInfo()
                {
                    MatchType = KeywordMatchType.Broad,
                    Text = keywordText
                }
            };
        }

        /// <summary>
        /// Creates a negative keyword as a campaign targeting criterion.
        /// </summary>
        /// <param name="locationId">the location to target.</param>
        /// <param name="campaignResourceName">the campaign where the keyword will be excluded.
        /// </param>
        /// <returns>a campaign criterion object with the specified locationId and resource name.
        /// </returns>
        // [START add_campaign_targeting_criteria]
        private CampaignCriterion buildLocationCriterion(long locationId,
            string campaignResourceName)
        {
            GeoTargetConstantName location = new GeoTargetConstantName(locationId.ToString());
            return new CampaignCriterion()
            {
                Campaign = campaignResourceName,
                Location = new LocationInfo()
                {
                    GeoTargetConstant = location.ToString()
                }
            };
        }
        // [END add_campaign_targeting_criteria]

        /// <summary>
        /// Creates a proximity Criterion.
        /// </summary>
        /// <param name="campaignResourceName">the campaign where the proximity will be added.
        /// </param>
        /// <returns>a campaign criterion object with the specified locationId and resource name.
        /// </returns>
        // [START add_campaign_targeting_criteria_1]
        private CampaignCriterion buildProximityCriterion(string campaignResourceName)
        {
            ProximityInfo proximity = new ProximityInfo()
            {
                Address = new AddressInfo()
                {
                    StreetAddress = "38 avenue de l'Opéra",
                    CityName = "Paris",
                    PostalCode = "75002",
                    CountryCode = "FR"
                },
                Radius = 10d,
                // Default is kilometers.
                RadiusUnits = ProximityRadiusUnits.Miles
            };

            return new CampaignCriterion()
            {
                Campaign = campaignResourceName,
                Proximity = proximity
            };
        }
        // [END add_campaign_targeting_criteria_1]
    }
}