Dodaj rozszerzenie graficzne

Java

// Copyright 2021 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.

package com.google.ads.googleads.examples.extensions;

import com.beust.jcommander.Parameter;
import com.google.ads.googleads.examples.utils.ArgumentNames;
import com.google.ads.googleads.examples.utils.CodeSampleParams;
import com.google.ads.googleads.lib.GoogleAdsClient;
import com.google.ads.googleads.v11.common.ImageFeedItem;
import com.google.ads.googleads.v11.enums.ExtensionTypeEnum.ExtensionType;
import com.google.ads.googleads.v11.errors.GoogleAdsError;
import com.google.ads.googleads.v11.errors.GoogleAdsException;
import com.google.ads.googleads.v11.resources.Asset;
import com.google.ads.googleads.v11.resources.CampaignExtensionSetting;
import com.google.ads.googleads.v11.resources.ExtensionFeedItem;
import com.google.ads.googleads.v11.services.CampaignExtensionSettingOperation;
import com.google.ads.googleads.v11.services.CampaignExtensionSettingServiceClient;
import com.google.ads.googleads.v11.services.ExtensionFeedItemOperation;
import com.google.ads.googleads.v11.services.ExtensionFeedItemServiceClient;
import com.google.ads.googleads.v11.services.MutateCampaignExtensionSettingResult;
import com.google.ads.googleads.v11.services.MutateCampaignExtensionSettingsResponse;
import com.google.ads.googleads.v11.services.MutateExtensionFeedItemsResponse;
import com.google.ads.googleads.v11.utils.ResourceNames;
import com.google.common.collect.ImmutableList;
import java.io.FileNotFoundException;
import java.io.IOException;

/**
 * Adds an image extension to a campaign. To create a campaign, run AddCampaigns.java. To create an
 * image asset, run UploadImageAsset.java.
 */
public class AddImageExtension {

  private static class AddImageExtensionParams 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.IMAGE_ASSET_ID, required = true)
    private long imageAssetId;
  }

  public static void main(String[] args) {
    AddImageExtensionParams params = new AddImageExtensionParams();
    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.imageAssetId = Long.parseLong("INSERT_IMAGE_ASSET_ID_HERE");
    }

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

    try {
      new AddImageExtension()
          .runExample(googleAdsClient, params.customerId, params.campaignId, params.imageAssetId);
    } 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. */
  private void runExample(
      GoogleAdsClient googleAdsClient, long customerId, long campaignId, long imageAssetId) {
    // Creates an image ExtensionFeedItem.
    String imageExtensionResourceName =
        createImageExtensionFeedItem(googleAdsClient, customerId, imageAssetId);

    // Creates a CampaignExtensionSetting for the image ExtensionFeedItem.
    CampaignExtensionSetting campaignExtensionSetting =
        CampaignExtensionSetting.newBuilder()
            .setCampaign(ResourceNames.campaign(customerId, campaignId))
            .setExtensionType(ExtensionType.IMAGE)
            .addExtensionFeedItems(imageExtensionResourceName)
            .build();

    // Creates an operation to add the CampaignExtensionSetting.
    CampaignExtensionSettingOperation operation =
        CampaignExtensionSettingOperation.newBuilder().setCreate(campaignExtensionSetting).build();

    // Creates a CampaignExtensionSettingServiceClient.
    try (CampaignExtensionSettingServiceClient client =
        googleAdsClient.getLatestVersion().createCampaignExtensionSettingServiceClient()) {
      // Issues the mutate request.
      MutateCampaignExtensionSettingsResponse response =
          client.mutateCampaignExtensionSettings(
              String.valueOf(customerId), ImmutableList.of(operation));

      // Prints some information about the result.
      for (MutateCampaignExtensionSettingResult result : response.getResultsList()) {
        System.out.printf(
            "Created campaign extension setting with resource name '%s'.%n",
            result.getResourceName());
      }
    }
  }

  /** Creates an image extension from an (image) {@link Asset}. */
  private String createImageExtensionFeedItem(
      GoogleAdsClient googleAdsClient, long customerId, long imageAssetId) {
    // Creates an image feed item containing the asset.
    ImageFeedItem imageFeedItem =
        ImageFeedItem.newBuilder()
            .setImageAsset(ResourceNames.asset(customerId, imageAssetId))
            .build();

    // Creates an extension feed item for the ImageFeedItem.
    ExtensionFeedItem extensionFeedItem =
        ExtensionFeedItem.newBuilder().setImageFeedItem(imageFeedItem).build();

    // Creates an operation to add the ExtensionFeedItem.
    ExtensionFeedItemOperation operation =
        ExtensionFeedItemOperation.newBuilder().setCreate(extensionFeedItem).build();

    // Creates an ExtensionFeedItemServiceClient.
    try (ExtensionFeedItemServiceClient client =
        googleAdsClient.getLatestVersion().createExtensionFeedItemServiceClient()) {
      // Issues the mutate request.
      MutateExtensionFeedItemsResponse response =
          client.mutateExtensionFeedItems(String.valueOf(customerId), ImmutableList.of(operation));

      // Retrieves the resource name.
      return response.getResults(0).getResourceName();
    }
  }
}

      

C#

// Copyright 2021 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;
using static Google.Ads.GoogleAds.V11.Enums.ExtensionTypeEnum.Types;

namespace Google.Ads.GoogleAds.Examples.V11
{
    /// <summary>
    /// This code example adds an image extension to a campaign. To create a campaign, run
    /// AddCampaigns.cs. To create an image asset, run UploadImageAsset.cs.
    /// </summary>
    public class AddImageExtension : ExampleBase
    {
        /// <summary>
        /// Command line options for running the <see cref="AddImageExtension"/> example.
        /// </summary>
        public class Options : OptionsBase
        {
            /// <summary>
            /// The customer ID for which the call is made.
            /// </summary>
            [Option("customerId", Required = true, HelpText =
                "The customer ID for which the call is made.")]
            public long CustomerId { get; set; }

            /// <summary>
            /// ID of the campaign to which sitelinks are added.
            /// </summary>
            [Option("campaignId", Required = true, HelpText =
                "ID of the campaign to which sitelinks are added.")]
            public long CampaignId { get; set; }

            /// <summary>
            /// ID of the image asset to be used for creating the extension.
            /// </summary>
            [Option("imageAssetId", Required = true, HelpText =
                "ID of the image asset to be used for creating the extension.")]
            public long ImageAssetId { 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);

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

        /// <summary>
        /// Returns a description about the code example.
        /// </summary>
        public override string Description =>
            "This code example adds an image extension to a campaign. To create a campaign, run " +
            "AddCampaigns.cs. To create an image asset, run UploadImageAsset.cs.";

        /// <summary>
        /// Runs the code example.
        /// </summary>
        /// <param name="client">The Google Ads client.</param>
        /// <param name="customerId">The customer ID for which the call is made.</param>
        /// <param name="campaignId">ID of the campaign to which sitelinks are added.</param>
        /// <param name="imageAssetId">ID of the image asset to be used for creating the extension.
        /// </param>
        public void Run(GoogleAdsClient client, long customerId, long campaignId,
            long imageAssetId)
        {
            // Get the CampaignExtensionSettingServiceClient.
            CampaignExtensionSettingServiceClient campaignExtensionSettingService =
                client.GetService(Services.V11.CampaignExtensionSettingService);

            try
            {
                // Creates an image extension.
                string imageExtensionResourceName =
                    CreateImageExtension(client, customerId, imageAssetId);
                string campaignResourceName = ResourceNames.Campaign(customerId, campaignId);

                // Creates a CampaignExtensionSetting.
                CampaignExtensionSetting campaignExtensionSetting = new CampaignExtensionSetting()
                {
                    Campaign = campaignResourceName,
                    ExtensionType = ExtensionType.Image,
                    ExtensionFeedItems = { imageExtensionResourceName }
                };

                // Creates the operation.
                CampaignExtensionSettingOperation operation =
                    new CampaignExtensionSettingOperation()
                    {
                        Create = campaignExtensionSetting
                    };

                // Creates the campaign extension.
                MutateCampaignExtensionSettingsResponse response =
                    campaignExtensionSettingService.MutateCampaignExtensionSettings(
                        customerId.ToString(), new[] { operation });
                foreach (MutateCampaignExtensionSettingResult result in response.Results)
                {
                    Console.WriteLine($"Created campaign extension setting with resource " +
                        $"name '{result.ResourceName}'.");
                }
            }
            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 an image extension.
        /// </summary>
        /// <param name="client">The Google Ads API client.</param>
        /// <param name="customerId">The client customer ID.</param>
        /// <param name="imageAssetId">The ID of the image asset to be used for creating image
        /// extension.</param>
        /// <returns>Resource name of the newly created image extension.</returns>
        private static string CreateImageExtension(GoogleAdsClient client, long customerId,
            long imageAssetId)
        {
            // Get the ExtensionFeedItemServiceClient.
            ExtensionFeedItemServiceClient extensionFeedItemService =
                client.GetService(Services.V11.ExtensionFeedItemService);

            // Creates the image feed item using the provided image.
            ImageFeedItem imageFeedItem = new ImageFeedItem()
            {
                ImageAsset = ResourceNames.Asset(customerId, imageAssetId)
            };

            // Creates an ExtensionFeedItem from the ImageFeedItem.
            ExtensionFeedItem extensionFeedItem = new ExtensionFeedItem()
            {
                ImageFeedItem = imageFeedItem
            };

            ExtensionFeedItemOperation operation = new ExtensionFeedItemOperation()
            {
                Create = extensionFeedItem
            };

            // Adds the ExtensionFeedItem.
            MutateExtensionFeedItemsResponse response =
                extensionFeedItemService.MutateExtensionFeedItems(customerId.ToString(),
                    new[] { operation });

            // Displays the result.
            string resourceName = response.Results.First().ResourceName;
            Console.WriteLine($"Created an image extension with resource name '{resourceName}'.");

            return resourceName;
        }
    }
}

      

PHP

<?php

/**
 * Copyright 2021 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\Extensions;

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\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\Common\ImageFeedItem;
use Google\Ads\GoogleAds\V11\Enums\ExtensionTypeEnum\ExtensionType;
use Google\Ads\GoogleAds\V11\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V11\Resources\CampaignExtensionSetting;
use Google\Ads\GoogleAds\V11\Resources\ExtensionFeedItem;
use Google\Ads\GoogleAds\V11\Services\CampaignExtensionSettingOperation;
use Google\Ads\GoogleAds\V11\Services\ExtensionFeedItemOperation;
use Google\ApiCore\ApiException;

/**
 * Adds an image extension to a campaign. To create a campaign, run
 * BasicOperations/AddCampaigns.php. To create an image asset, run Misc/UploadImageAsset.php.
 */
class AddImageExtension
{
    private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
    private const CAMPAIGN_ID = 'INSERT_CAMPAIGN_ID_HERE';
    private const IMAGE_ASSET_ID = 'INSERT_IMAGE_ASSET_ID_HERE';

    public static function main()
    {
        // Either pass the required parameters for this example on the command line, or insert them
        // into the constants above.
        $options = (new ArgumentParser())->parseCommandArguments([
            ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
            ArgumentNames::CAMPAIGN_ID => GetOpt::REQUIRED_ARGUMENT,
            ArgumentNames::IMAGE_ASSET_ID => GetOpt::REQUIRED_ARGUMENT
        ]);

        // Generate a refreshable OAuth2 credential for authentication.
        $oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();

        // Construct a Google Ads client configured from a properties file and the
        // OAuth2 credentials above.
        $googleAdsClient = (new GoogleAdsClientBuilder())->fromFile()
            ->withOAuth2Credential($oAuth2Credential)
            ->build();

        try {
            self::runExample(
                $googleAdsClient,
                $options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID,
                $options[ArgumentNames::CAMPAIGN_ID] ?: self::CAMPAIGN_ID,
                $options[ArgumentNames::IMAGE_ASSET_ID] ?: self::IMAGE_ASSET_ID
            );
        } catch (GoogleAdsException $googleAdsException) {
            printf(
                "Request with ID '%s' has failed.%sGoogle Ads failure details:%s",
                $googleAdsException->getRequestId(),
                PHP_EOL,
                PHP_EOL
            );
            foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) {
                /** @var GoogleAdsError $error */
                printf(
                    "\t%s: %s%s",
                    $error->getErrorCode()->getErrorCode(),
                    $error->getMessage(),
                    PHP_EOL
                );
            }
            exit(1);
        } catch (ApiException $apiException) {
            printf(
                "ApiException was thrown with message '%s'.%s",
                $apiException->getMessage(),
                PHP_EOL
            );
            exit(1);
        }
    }

    /**
     * Runs the example.
     *
     * @param GoogleAdsClient $googleAdsClient the Google Ads API client
     * @param int $customerId the customer ID
     * @param int $campaignId the campaign ID
     * @param int $imageAssetId the image asset ID used to create an image extension
     */
    public static function runExample(
        GoogleAdsClient $googleAdsClient,
        int $customerId,
        int $campaignId,
        int $imageAssetId
    ) {
        // Creates an extension feed item using the specified image asset ID.
        $extensionFeedItem = new ExtensionFeedItem([
            'image_feed_item' => new ImageFeedItem([
                'image_asset' => ResourceNames::forAsset($customerId, $imageAssetId)
            ])
        ]);

        // Creates an extension feed item operation.
        $extensionFeedItemOperation = new ExtensionFeedItemOperation();
        $extensionFeedItemOperation->setCreate($extensionFeedItem);

        // Issues a mutate request to add the extension feed item and prints its information.
        $extensionFeedItemServiceClient = $googleAdsClient->getExtensionFeedItemServiceClient();
        $response = $extensionFeedItemServiceClient->mutateExtensionFeedItems(
            $customerId,
            [$extensionFeedItemOperation]
        );
        $extensionFeedItemResourceName = $response->getResults()[0]->getResourceName();
        printf(
            "Created an image extension with resource name: '%s'.%s",
            $extensionFeedItemResourceName,
            PHP_EOL
        );

        // Then, creates a campaign extension setting using the created image feed item.
        $campaignExtensionSetting = new CampaignExtensionSetting([
            'campaign' => ResourceNames::forCampaign($customerId, $campaignId),
            'extension_type' => ExtensionType::IMAGE,
            'extension_feed_items' => [$extensionFeedItemResourceName]
        ]);

        // Creates a campaign extension setting operation.
        $campaignExtensionSettingOperation = new CampaignExtensionSettingOperation();
        $campaignExtensionSettingOperation->setCreate($campaignExtensionSetting);

        // Issues a mutate request to add the campaign extension setting and prints its information.
        $campaignExtensionSettingServiceClient =
            $googleAdsClient->getCampaignExtensionSettingServiceClient();
        $response = $campaignExtensionSettingServiceClient->mutateCampaignExtensionSettings(
            $customerId,
            [$campaignExtensionSettingOperation]
        );
        printf(
            "Created a campaign extension setting with resource name: '%s'.%s",
            $response->getResults()[0]->getResourceName(),
            PHP_EOL
        );
    }
}

AddImageExtension::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.
"""Adds an image extension to a campaign.

To create a campaign, run basic_operations/add_campaigns.py. To create an
image asset, run misc/upload_image_asset.py.
"""


import argparse
import sys

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


def main(client, customer_id, campaign_id, image_asset_id):
    """The main method that creates all necessary entities for the example.

    Args:
        client: An initialized GoogleAdsClient instance.
        customer_id: The client customer ID str.
        campaign_id: A str of a campaign ID.
        image_asset_id: A str of an image asset ID.
    """
    extension_feed_item_service = client.get_service("ExtensionFeedItemService")
    extension_feed_item_operation = client.get_type(
        "ExtensionFeedItemOperation"
    )
    extension_feed_item = extension_feed_item_operation.create
    extension_feed_item.image_feed_item.image_asset = client.get_service(
        "AssetService"
    ).asset_path(customer_id, image_asset_id)

    response = extension_feed_item_service.mutate_extension_feed_items(
        customer_id=customer_id, operations=[extension_feed_item_operation]
    )
    image_resource_name = response.results[0].resource_name
    print(
        "Created an image extension with resource name: "
        f"'{image_resource_name}'"
    )

    campaign_extension_setting_service = client.get_service(
        "CampaignExtensionSettingService"
    )
    campaign_extension_setting_operation = client.get_type(
        "CampaignExtensionSettingOperation"
    )
    ces = campaign_extension_setting_operation.create
    ces.campaign = client.get_service("CampaignService").campaign_path(
        customer_id, campaign_id
    )
    ces.extension_type = client.enums.ExtensionTypeEnum.IMAGE
    ces.extension_feed_items.append(image_resource_name)

    response = (
        campaign_extension_setting_service.mutate_campaign_extension_settings(
            customer_id=customer_id,
            operations=[campaign_extension_setting_operation],
        )
    )
    print(
        "Created a campaign extension setting with resource name: "
        f"'{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 an image extension to a campaign.")
    )
    # The following argument(s) should be provided to run the example.
    parser.add_argument(
        "-c",
        "--customer_id",
        type=str,
        required=True,
        help="The Google Ads customer ID.",
    )
    parser.add_argument(
        "-a",
        "--campaign_id",
        type=str,
        required=True,
        help="The ID for a campaign to add an image extension to.",
    )
    parser.add_argument(
        "-i",
        "--image_asset_id",
        type=str,
        required=True,
        help="The ID of an image asset to use for the new extension.",
    )
    args = parser.parse_args()

    try:
        main(
            googleads_client,
            args.customer_id,
            args.campaign_id,
            args.image_asset_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 2021 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.
#
# Adds an image extension to a campaign. To create a campaign, run
# basic_operations/add_campaigns.rb. To create an image asset, run
# misc/upload_image_asset.rb.

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

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

  # First, create the image feed item.
  operation = client.operation.create_resource.extension_feed_item do |efi|
    efi.image_feed_item = client.resource.image_feed_item do |ifi|
      ifi.image_asset = client.path.asset(customer_id, image_id)
    end
  end

  response = client.service.extension_feed_item.mutate_extension_feed_items(
    customer_id: customer_id,
    operations: [operation],
  )

  image_resource_name = response.results.first.resource_name
  puts "Created an image extension with resource name '#{image_resource_name}'."

  # Then, create a campaign extension setting using the created image feed item.
  operation = client.operation.create_resource.campaign_extension_setting do |ces|
    ces.campaign = client.path.campaign(customer_id, campaign_id)
    ces.extension_type = :IMAGE
    ces.extension_feed_items << image_resource_name
  end

  response = client.service.campaign_extension_setting.mutate_campaign_extension_settings(
    customer_id: customer_id,
    operations: [operation],
  )

  puts "Created a campaign extension setting with resource name '#{response.results.first.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'
  options[:image_asset_id] = 'INSERT_IMAGE_ASSET_ID_HERE'

  OptionParser.new do |opts|
    opts.banner = sprintf('Usage: %s [options]', File.basename(__FILE__))

    opts.separator ''
    opts.separator 'Options:'

    opts.on('-C', '--customer-id CUSTOMER-ID', String, 'Customer ID') do |v|
      options[:customer_id] = v
    end

    opts.on('-c', '--campaign-id CAMPAIGN-ID', String, 'Campaign ID') do |v|
      options[:campaign_id] = v
    end

    opts.on('-I', '--image-asset-id IMAGE-ASSET-ID', String, 'Image Asset ID') do |v|
      options[:image_asset_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_image_extension(
      options.fetch(:customer_id).tr("-", ""),
      options.fetch(:campaign_id),
      options.fetch(:image_asset_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 2021, 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 code example adds an image extension to a campaign. To create a campaign,
# run add_campaigns.pl. To create an image asset, run upload_image_asset.pl.

use strict;
use warnings;
use utf8;

use FindBin qw($Bin);
use lib "$Bin/../../lib";
use Google::Ads::GoogleAds::Client;
use Google::Ads::GoogleAds::Utils::GoogleAdsHelper;
use Google::Ads::GoogleAds::V11::Resources::CampaignExtensionSetting;
use Google::Ads::GoogleAds::V11::Resources::ExtensionFeedItem;
use Google::Ads::GoogleAds::V11::Common::ImageFeedItem;
use Google::Ads::GoogleAds::V11::Enums::ExtensionTypeEnum qw(IMAGE);
use
  Google::Ads::GoogleAds::V11::Services::CampaignExtensionSettingService::CampaignExtensionSettingOperation;
use
  Google::Ads::GoogleAds::V11::Services::ExtensionFeedItemService::ExtensionFeedItemOperation;
use Google::Ads::GoogleAds::V11::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 $image_asset_id = "INSERT_IMAGE_ASSET_ID_HERE";

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

  # Create an image extension.
  my $image_extension_resource_name =
    create_image_extension($api_client, $customer_id, $image_asset_id);

  my $campaign_resource_name =
    Google::Ads::GoogleAds::V11::Utils::ResourceNames::campaign($customer_id,
    $campaign_id);

  # Create a campaign extension setting.
  my $campaign_extension_setting =
    Google::Ads::GoogleAds::V11::Resources::CampaignExtensionSetting->new({
      campaign           => $campaign_resource_name,
      extensionType      => IMAGE,
      extensionFeedItems => [$image_extension_resource_name]});

  # Create a campaign extension setting operation.
  my $campaign_extension_setting_operation =
    Google::Ads::GoogleAds::V11::Services::CampaignExtensionSettingService::CampaignExtensionSettingOperation
    ->new({
      create => $campaign_extension_setting
    });

  # Add the campaign extension setting and print the resulting resource name.
  my $campaign_extension_settings_response =
    $api_client->CampaignExtensionSettingService()->mutate({
      customerId => $customer_id,
      operations => [$campaign_extension_setting_operation]});

  printf "Created campaign extension setting with resource name '%s'.\n",
    $campaign_extension_settings_response->{results}[0]{resourceName};

  return 1;
}

# Creates an image extension and returns the resource name of the newly created
# image extension.
sub create_image_extension {
  my ($api_client, $customer_id, $image_asset_id) = @_;

  # Create the image feed item using the provided image.
  my $image_feed_item = Google::Ads::GoogleAds::V11::Common::ImageFeedItem->new(
    {
      imageAsset => Google::Ads::GoogleAds::V11::Utils::ResourceNames::asset(
        $customer_id, $image_asset_id
      )});

  # Create an extension feed item from the image feed item.
  my $extension_feed_item =
    Google::Ads::GoogleAds::V11::Resources::ExtensionFeedItem->new({
      imageFeedItem => $image_feed_item
    });

  # Create an extension feed item operation.
  my $extension_feed_item_operation =
    Google::Ads::GoogleAds::V11::Services::ExtensionFeedItemService::ExtensionFeedItemOperation
    ->new({
      create => $extension_feed_item
    });

  # Add the extension feed item, then display and return the newly created
  # feed item's resource name.
  my $extension_feed_items_response =
    $api_client->ExtensionFeedItemService()->mutate({
      customerId => $customer_id,
      operations => [$extension_feed_item_operation]});

  my $extension_feed_item_resource_name =
    $extension_feed_items_response->{results}[0]{resourceName};
  printf "Created an image extension with resource name '%s'.\n",
    $extension_feed_item_resource_name;

  return $extension_feed_item_resource_name;
}

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

# Print the help message if the parameters are not initialized in the code nor
# in the command line.
pod2usage(2) if not check_params($customer_id, $campaign_id, $image_asset_id);

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

=pod

=head1 NAME

add_image_extension

=head1 DESCRIPTION

This code example adds an image extension to a campaign. To create a campaign,
run add_campaigns.pl. To create an image asset, run upload_image_asset.pl.

=head1 SYNOPSIS

add_image_extension.pl [options]

    -help                       Show the help message.
    -customer_id                The Google Ads customer ID.
    -campaign_id                The campaign ID.
    -image_asset_id             The image asset ID.

=cut