Expanded Text Ads

Use expanded text ads to promote products or services on the Google Network. This ad format supports:

  • Multiple headlines

    This ad type has three headline fields concatenated together with a vertical bar (|) separator. The first two headlines are required, while the third is optional.

  • More characters

    Each headline has a 30-character limit, an increase from that for standard text ads. Languages with double-width characters such as Chinese, Japanese, or Korean, are allowed 15 characters.

  • Expanded description

    There are two description lines with an expanded limit of 90 characters. Truncation and ellipsification have been minimized to make ad display more predictable.

  • URL customization

    Instead of inputting a display URL for your ad, the URL is calculated from the final URL domain and path fields (path1 and path2), that indicate to a user where they will be directed on a click. Final URL and tracking URL behavior remain the same.

Here's an example ad for Interplanetary Cruises in the Google Ads UI, after being uploaded via the Google Ads API.

For the expanded text ad illustrated above, the ad properties can be mapped to individual fields in ExpandedTextAdInfo with Google Ads API, as shown in the following table:

Field Value
headline_part1 Cruise to Mars #12QjNuTP
headline_part2 Best Space Cruise Line
headline_part3 Discount ends soon
description Buy your tickets now!
description2 Limited number
final_urls ["https://www.example.com/0"]
path1 all-inclusive
path2 deals

Example

Let's walk through the code for the Interplanetary Cruise ad shown above.

Similar to other ad types, ExpandedTextAdInfo can be added through the AdGroupAdService.MutateAdGroupAds method. This ad type requires at least two headlines, at least one description, and one or more final URLs.

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

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.v5.common.CustomParameter;
import com.google.ads.googleads.v5.common.ExpandedTextAdInfo;
import com.google.ads.googleads.v5.enums.AdGroupAdStatusEnum.AdGroupAdStatus;
import com.google.ads.googleads.v5.errors.GoogleAdsError;
import com.google.ads.googleads.v5.errors.GoogleAdsException;
import com.google.ads.googleads.v5.resources.Ad;
import com.google.ads.googleads.v5.resources.AdGroupAd;
import com.google.ads.googleads.v5.services.AdGroupAdOperation;
import com.google.ads.googleads.v5.services.AdGroupAdServiceClient;
import com.google.ads.googleads.v5.services.MutateAdGroupAdResult;
import com.google.ads.googleads.v5.services.MutateAdGroupAdsResponse;
import com.google.ads.googleads.v5.utils.ResourceNames;
import com.google.common.collect.ImmutableList;
import java.io.FileNotFoundException;
import java.io.IOException;

/** Adds expanded text ads to a given ad group. To get ad groups, run GetAdGroups.java. */
public class AddExpandedTextAdWithUpgradedUrls {

  private static class AddExpandedTextAdWithUpgradedUrlsParams extends CodeSampleParams {

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

    @Parameter(names = ArgumentNames.AD_GROUP_ID, required = true)
    private Long adGroupId;
  }

  public static void main(String[] args) throws IOException {
    AddExpandedTextAdWithUpgradedUrlsParams params = new AddExpandedTextAdWithUpgradedUrlsParams();
    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.adGroupId = Long.parseLong("INSERT_AD_GROUP_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 AddExpandedTextAdWithUpgradedUrls()
          .runExample(googleAdsClient, params.customerId, params.adGroupId);
    } catch (GoogleAdsException gae) {
      // GoogleAdsException is the base class for most exceptions thrown by an API request.
      // Instances of this exception have a message and a GoogleAdsFailure that contains a
      // collection of GoogleAdsErrors that indicate the underlying causes of the
      // GoogleAdsException.
      System.err.printf(
          "Request ID %s failed due to GoogleAdsException. Underlying errors:%n",
          gae.getRequestId());
      int i = 0;
      for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
        System.err.printf("  Error %d: %s%n", i++, googleAdsError);
      }
      System.exit(1);
    }
  }

  /**
   * Runs the example.
   *
   * @param googleAdsClient the Google Ads API client.
   * @param customerId the client customer ID.
   * @param adGroupId the ad group ID.
   * @throws GoogleAdsException if an API request failed with one or more service errors.
   */
  private void runExample(GoogleAdsClient googleAdsClient, long customerId, long adGroupId) {
    String adGroupResourceName = ResourceNames.adGroup(customerId, adGroupId);

    // Creates an expanded text ad.
    Ad ad =
        Ad.newBuilder()
            .setExpandedTextAd(
                ExpandedTextAdInfo.newBuilder()
                    .setDescription("Low-gravity fun for everyone!")
                    .setHeadlinePart1("Luxury Cruise to Mars")
                    .setHeadlinePart2("Visit the Red Planet in style.")
                    .build())
            // Specifies a tracking URL for 3rd party tracking provider. You may specify one at
            // customer, campaign, ad group, ad, criterion or feed item levels.
            .setTrackingUrlTemplate(
                "http://tracker.example.com/?season={_season}&promocode={_promocode}"
                    + "&u={lpurl}")
            // Since your tracking URL has two custom parameters, provide their values too. This can
            // be provided at campaign, ad group, ad, criterion or feed item levels.
            .addAllUrlCustomParameters(
                ImmutableList.of(
                    CustomParameter.newBuilder().setKey("season").setValue("christmas").build(),
                    CustomParameter.newBuilder().setKey("promocode").setValue("NY123").build()))
            // Specifies a list of final URLs. This field cannot be set if URL field is set. This
            // may be specified at ad, criterion and feed item levels.
            .addFinalUrls("http://www.example.com/cruise/space/")
            .addFinalUrls("http://www.example.com/locations/mars/")
            // Specifies a list of final mobile URLs. This field cannot be set if URL field is
            // set, or finalUrls is unset. This may be specified at ad, criterion and feed item
            // levels.
            /*
             .addFinalMobileUrls("http://mobile.example.com/cruise/space/")
             .addFinalMobileUrls("http://mobile.example.com/locations/mars/")
            */
            .build();

    // Creates an ad group ad containing the ad.
    AdGroupAd adGroupAd =
        AdGroupAd.newBuilder()
            .setAdGroup(adGroupResourceName)
            .setAd(ad)
            // Sets the status to PAUSED.
            .setStatus(AdGroupAdStatus.PAUSED)
            .build();

    try (AdGroupAdServiceClient adGroupAdServiceClient =
        googleAdsClient.getLatestVersion().createAdGroupAdServiceClient()) {
      MutateAdGroupAdsResponse response =
          adGroupAdServiceClient.mutateAdGroupAds(
              Long.toString(customerId),
              ImmutableList.of(AdGroupAdOperation.newBuilder().setCreate(adGroupAd).build()));
      for (MutateAdGroupAdResult result : response.getResultsList()) {
        System.out.printf(
            "Added an expanded text ad 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 Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V5.Common;
using Google.Ads.GoogleAds.V5.Errors;
using Google.Ads.GoogleAds.V5.Resources;
using Google.Ads.GoogleAds.V5.Services;

using System;

using static Google.Ads.GoogleAds.V5.Enums.AdGroupAdStatusEnum.Types;

namespace Google.Ads.GoogleAds.Examples.V5
{
    /// <summary>
    /// This code example adds expanded text ads to a given ad group. To list
    /// ad groups, run GetAdGroups.cs.
    /// </summary>
    public class AddExpandedTextAdWithUpgradedUrls : 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)
        {
            AddExpandedTextAdWithUpgradedUrls codeExample =
                new AddExpandedTextAdWithUpgradedUrls();
            Console.WriteLine(codeExample.Description);

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

            //The ad group ID that contains the ad.
            long adGroupId = long.Parse("INSERT_AD_GROUP_ID_HERE");

            codeExample.Run(new GoogleAdsClient(), customerId, adGroupId);
        }

        /// <summary>
        /// Returns a description about the code example.
        /// </summary>
        public override string Description =>
            "This code example adds an expanded text ad that uses advanced features of upgraded " +
            "URLs.";

        /// <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="adGroupId">The ad group ID to which ads are added.</param>
        public void Run(GoogleAdsClient client, long customerId, long adGroupId)
        {
            // Get the AdGroupAdService.
            AdGroupAdServiceClient service = client.GetService(Services.V5.AdGroupAdService);

            // Create the expanded text ad.
            AdGroupAd ad = new AdGroupAd
            {
                AdGroup = ResourceNames.AdGroup(customerId, adGroupId),
                Ad = new Ad
                {
                    ExpandedTextAd = new ExpandedTextAdInfo
                    {
                        Description = "Low-gravity fun for everyone!",
                        HeadlinePart1 = "Luxury Cruise to Mars",
                        HeadlinePart2 = "Visit the Red Planet in style.",
                    },

                    // Specify a tracking URL for 3rd party tracking provider. You may
                    // specify one at customer, campaign, ad group, ad, criterion or
                    // feed item levels.
                    TrackingUrlTemplate =
                  "http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}",

                    // Since your tracking URL has two custom parameters, provide their
                    // values too. This can be provided at campaign, ad group, ad, criterion
                    // or feed item levels.
                    UrlCustomParameters = {
                      new CustomParameter { Key = "season", Value = "christmas" },
                      new CustomParameter { Key = "promocode", Value = "NY123" }
                    },

                    // Specify a list of final URLs. This field cannot be set if URL field is
                    // set. This may be specified at ad, criterion and feed item levels.
                    FinalUrls = {
                      "http://www.example.com/cruise/space/",
                      "http://www.example.com/locations/mars/"
                    },

                    // Specify a list of final mobile URLs. This field cannot be set if URL
                    // field is set, or finalUrls is unset. This may be specified at ad,
                    // criterion and feed item levels.
                    FinalMobileUrls = {
                      "http://mobile.example.com/cruise/space/",
                      "http://mobile.example.com/locations/mars/"
                    }
                },
                // Optional: Set the status.
                Status = AdGroupAdStatus.Paused
            };

            // Create the operation.
            AdGroupAdOperation operation = new AdGroupAdOperation
            {
                Create = ad
            };

            try
            {
                // Create the ad.
                MutateAdGroupAdsResponse response = service.MutateAdGroupAds(customerId.ToString(),
                    new AdGroupAdOperation[] { operation });

                // Display the results.
                foreach (MutateAdGroupAdResult result in response.Results)
                {
                    Console.WriteLine($"Expanded text ad created 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;
            }
        }
    }
}

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\AdvancedOperations;

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\V5\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V5\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V5\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\V5\Common\CustomParameter;
use Google\Ads\GoogleAds\V5\Common\ExpandedTextAdInfo;
use Google\Ads\GoogleAds\V5\Enums\AdGroupAdStatusEnum\AdGroupAdStatus;
use Google\Ads\GoogleAds\V5\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V5\Resources\Ad;
use Google\Ads\GoogleAds\V5\Resources\AdGroupAd;
use Google\Ads\GoogleAds\V5\Services\AdGroupAdOperation;
use Google\Ads\GoogleAds\V5\Services\AdGroupServiceClient;
use Google\ApiCore\ApiException;

/**
 * This example demonstrates how to add expanded text ads to a given ad group.
 * To get ad groups, run GetAdGroups.php.
 */
class AddExpandedTextAdWithUpgradedUrls
{
    private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
    private const AD_GROUP_ID = 'INSERT_AD_GROUP_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::AD_GROUP_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::AD_GROUP_ID] ?: self::AD_GROUP_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 $adGroupId the ad group ID to add a keyword to
     */
    public static function runExample(
        GoogleAdsClient $googleAdsClient,
        int $customerId,
        int $adGroupId
    ) {
        // Creates the expanded text ad info.
        $expandedTextAdInfo = new ExpandedTextAdInfo([
            'headline_part1' => 'Luxury Cruise to Mars',
            'headline_part2' => 'Visit the Red Planet in style.',
            'description' => 'Low-gravity fun for everyone!'
        ]);

        $ad = new Ad([
            // Sets the expanded text ad info on an Ad.
            'expanded_text_ad' => $expandedTextAdInfo,
            // Specifies a list of final URLs. This field cannot be set if URL field is set. This
            // may be specified at ad and criterion levels.
            'final_urls' => [
                'http://www.example.com/cruise/space/',
                'http://www.example.com/locations/mars/'
            ],
            // Specifies a tracking URL for 3rd party tracking provider. You may specify one at
            // customer, campaign, ad group, ad or criterion levels.
            'tracking_url_template' =>
                'http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}',
            // Since your tracking URL has two custom parameters, provide their values too. This can
            // be provided at campaign, ad group, ad or criterion levels.
            'url_custom_parameters' => [
                new CustomParameter(['key' => 'season', 'value' => 'christmas']),
                new CustomParameter(['key' => 'promocode', 'value' => 'NY123'])
            ]
        ]);

        // Specifies a list of final mobile URLs. This field cannot be set if URL field is set, or
        // finalUrls is unset. This may be specified at ad and criterion levels.
        /*
        $ad->setFinalMobileUrls([
            'http://mobile.example.com/cruise/space/',
            'http://mobile.example.com/locations/mars/'
        ]);
        */

        // Creates an ad group ad to hold the above ad.
        $adGroupAd = new AdGroupAd([
            'ad_group' => AdGroupServiceClient::adGroupName($customerId, $adGroupId),
            'status' => AdGroupAdStatus::PAUSED,
            'ad' => $ad
        ]);

        // Creates an ad group ad operation and add it to the operations array.
        $adGroupAdOperation = new AdGroupAdOperation();
        $adGroupAdOperation->setCreate($adGroupAd);

        // Issues a mutate request to add the ad group ads.
        $adGroupAdServiceClient = $googleAdsClient->getAdGroupAdServiceClient();
        $response = $adGroupAdServiceClient->mutateAdGroupAds($customerId, [$adGroupAdOperation]);

        foreach ($response->getResults() as $addedAdGroupAd) {
            /** @var AdGroupAd $addedAdGroupAd */
            printf(
                "Added an expanded text ad with resource name: '%s'%s",
                $addedAdGroupAd->getResourceName(),
                PHP_EOL
            );
        }
    }
}

AddExpandedTextAdWithUpgradedUrls::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.
"""This adds an expanded text ad using advanced features of upgraded URLs."""


import argparse
import sys

import google.ads.google_ads.client


def main(client, customer_id, ad_group_id):
    ad_group_ad_service = client.get_service("AdGroupAdService", version="v5")
    ad_group_service = client.get_service("AdGroupService", version="v5")

    # Create ad group ad.
    ad_group_ad_operation = client.get_type("AdGroupAdOperation", version="v5")
    ad_group_ad = ad_group_ad_operation.create
    ad_group_ad.ad_group = ad_group_service.ad_group_path(
        customer_id, ad_group_id
    )
    ad_group_ad.status = client.get_type(
        "AdGroupAdStatusEnum", version="v5"
    ).PAUSED

    # Set expanded text ad info
    ad_group_ad.ad.final_urls.extend(
        [
            "http://www.example.com/cruise/space/",
            "http://www.example.com/locations/mars/",
        ]
    )

    ad_group_ad.ad.expanded_text_ad.description = (
        "Low-gravity fun for everyone!"
    )
    ad_group_ad.ad.expanded_text_ad.headline_part1 = "Luxury cruise to Mars"
    ad_group_ad.ad.expanded_text_ad.headline_part2 = (
        "Visit the Red Planet in Style."
    )

    # Specify a tracking URL for 3rd party tracking provider. You may specify
    # one at customer, campaign, ad group, ad, criterion, or feed item levels.
    ad_group_ad.ad.tracking_url_template = (
        "http://tracker.example.com/?season={_season}&promocode={_promocode}&"
        "u={lpurl}"
    )

    # Since your tracking URL has two custom parameters, provide their values
    # too. This can be provided at campaign, ad group, ad, criterion, or feed
    # item levels.
    param_1 = ad_group_ad.ad.url_custom_parameters.add()
    param_1.key = "season"
    param_1.value = "easter123"

    param_2 = ad_group_ad.ad.url_custom_parameters.add()
    param_2.key = "promocode"
    param_2.value = "nj123"

    # Specify a list of final mobile URLs. This field cannot be set if URL field
    # is set, or finalUrls is unset. This may be specified at ad, criterion, and
    # feed item levels.
    ad_group_ad.ad.final_mobile_urls.extend(
        [
            "http://mobile.example.com/cruise/space/",
            "http://mobile.example.com/locations/mars/",
        ]
    )

    # Add the ad group ad.
    try:
        ad_group_ad_response = ad_group_ad_service.mutate_ad_group_ads(
            customer_id, [ad_group_ad_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 expanded text ad %s."
        % ad_group_ad_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 an expanded text ad to the specified ad group 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(
        "-a", "--ad_group_id", type=str, required=True, help="The ad group ID."
    )
    args = parser.parse_args()

    main(google_ads_client, args.customer_id, args.ad_group_id)

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 adds an expanded text ad that uses advanced features of
# upgraded URLs.

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

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

  # Create an ad group ad.
  ad_group_ad = client.resource.ad_group_ad do |aga|
    aga.ad_group = client.path.ad_group(customer_id, ad_group_id)
    aga.status = :PAUSED
    aga.ad = client.resource.ad do |ad|
      ad.final_urls << "http://www.example.com/cruise/space/"
      ad.final_urls << "http://www.example.com/locations/mars/"

      # Set expanded text ad info
      ad.expanded_text_ad = client.resource.expanded_text_ad_info do |eta|
        eta.description = "Low-gravity fun for everyone!"
        eta.headline_part1 = "Luxury Cruise to Mars"
        eta.headline_part2 = "Visit the Red Planet in Style."
      end

      # Specify a tracking URL for 3rd party tracking provider. You may specify
      # one at customer, campaign, ad group, ad, criterion or feed item levels.
      ad.tracking_url_template =
          "http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}"

      # Since your tracking URL has two custom parameters, provide their
      # values too. This can be provided at campaign, ad group, ad, criterion
      # or feed item levels.
      ad.url_custom_parameters << client.resource.custom_parameter do |param|
        param.key = "season"
        param.value = "easter123"
      end

      ad.url_custom_parameters << client.resource.custom_parameter do |param|
        param.key = "promocode"
        param.value = "nj123"
      end

      # Specify a list of final mobile URLs. This field cannot be set if URL field
      # is set, or finalUrls is unset. This may be specified at ad, criterion and
      # feed item levels.
      ad.final_mobile_urls << "http://mobile.example.com/cruise/space/"
      ad.final_mobile_urls << "http://mobile.example.com/locations/mars/"
    end
  end


  # Create the operation.
  ad_group_ad_operation = client.operation.create_resource.ad_group_ad(ad_group_ad)

  # Add the ad group ad.
  response = client.service.ad_group_ad.mutate_ad_group_ads(
    customer_id: customer_id,
    operations:[ad_group_ad_operation]
  )

  puts "Created expanded text ad #{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[:ad_group_id] = 'INSERT_AD_GROUP_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('-A', '--ad-group-id AD-GROUP-ID', String, 'AdGroup ID') do |v|
      options[:ad_group_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_expanded_text_ad_with_upgraded_urls(options.fetch(:customer_id).tr("-", ""),
        options[:ad_group_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 an expanded text ad that uses advanced features of upgraded
# URLs.

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::V5::Resources::AdGroupAd;
use Google::Ads::GoogleAds::V5::Resources::Ad;
use Google::Ads::GoogleAds::V5::Common::ExpandedTextAdInfo;
use Google::Ads::GoogleAds::V5::Common::CustomParameter;
use Google::Ads::GoogleAds::V5::Enums::AdGroupAdStatusEnum qw(PAUSED);
use Google::Ads::GoogleAds::V5::Services::AdGroupAdService::AdGroupAdOperation;
use Google::Ads::GoogleAds::V5::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 $ad_group_id = "INSERT_AD_GROUP_ID_HERE";

sub add_expanded_text_ad_with_upgraded_urls {
  my ($api_client, $customer_id, $ad_group_id) = @_;

  # Create an expanded text ad info.
  my $expanded_text_ad_info =
    Google::Ads::GoogleAds::V5::Common::ExpandedTextAdInfo->new({
      description   => "Low-gravity fun for everyone!",
      headlinePart1 => "Luxury Cruise to Mars",
      headlinePart2 => "Visit the Red Planet in style.",
    });

  # Create an ad group ad.
  my $ad_group_ad = Google::Ads::GoogleAds::V5::Resources::AdGroupAd->new({
      adGroup => Google::Ads::GoogleAds::V5::Utils::ResourceNames::ad_group(
        $customer_id, $ad_group_id
      ),
      status => PAUSED,
      ad     => Google::Ads::GoogleAds::V5::Resources::Ad->new({
          # Set the expanded text ad info on an ad.
          expandedTextAd => $expanded_text_ad_info,
          # Specify a list of final URLs. This field cannot be set if URL field is set. This
          # may be specified at ad, criterion and feed item levels.
          finalUrls => [
            "http://www.example.com/cruise/space/",
            "http://www.example.com/locations/mars/"
          ],
          # Specify a tracking URL for 3rd party tracking provider. You may specify one at
          # customer, campaign, ad group, ad, criterion or feed item levels.
          trackingUrlTemplate => "http://tracker.example.com/?" .
            "season={_season}&promocode={_promocode}&u={lpurl}",
          # Since your tracking URL has two custom parameters, provide their values too. This can
          # be provided at campaign, ad group, ad, criterion or feed item levels.
          urlCustomParameters => [
            Google::Ads::GoogleAds::V5::Common::CustomParameter->new({
                key   => "season",
                value => "christmas"
              }
            ),
            Google::Ads::GoogleAds::V5::Common::CustomParameter->new({
                key   => "promocode",
                value => "NY123"
              })
          ],
          # Specify a list of final mobile URLs. This field cannot be set if URL field
          # is set, or finalUrls is unset. This may be specified at ad, criterion and
          # feed item levels.
          # finalMobileUrls => [
          #   "http://mobile.example.com/cruise/space/",
          #   "http://mobile.example.com/locations/mars/"
          # ]
        })});

  # Create an ad group ad operation.
  my $ad_group_ad_operation =
    Google::Ads::GoogleAds::V5::Services::AdGroupAdService::AdGroupAdOperation
    ->new({create => $ad_group_ad});

  # Add the ad group ad.
  my $ad_group_ad_response = $api_client->AdGroupAdService()->mutate({
      customerId => $customer_id,
      operations => [$ad_group_ad_operation]});

  printf "Created expanded text ad '%s'.\n",
    $ad_group_ad_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, "ad_group_id=i" => \$ad_group_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, $ad_group_id);

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

=pod

=head1 NAME

add_expanded_text_ad_with_upgraded_urls

=head1 DESCRIPTION

This example adds an expanded text ad that uses advanced features of upgraded URLs.

=head1 SYNOPSIS

add_expanded_text_ad_with_upgraded_urls.pl [options]

    -help                       Show the help message.
    -customer_id                The Google Ads customer ID.
    -ad_group_id                The ad group ID.

=cut

Like most other entities in the Google Ads API, an ExpandedTextAdInfo is fetched by querying the GoogleAdsService.SearchStream using a Google Ads Query Language query that specifies which fields to return, with a filter on ad_group_ad.ad.type in the WHERE clause.

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

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.v5.common.ExpandedTextAdInfo;
import com.google.ads.googleads.v5.errors.GoogleAdsError;
import com.google.ads.googleads.v5.errors.GoogleAdsException;
import com.google.ads.googleads.v5.resources.Ad;
import com.google.ads.googleads.v5.services.GoogleAdsRow;
import com.google.ads.googleads.v5.services.GoogleAdsServiceClient;
import com.google.ads.googleads.v5.services.GoogleAdsServiceClient.SearchPagedResponse;
import com.google.ads.googleads.v5.services.SearchGoogleAdsRequest;
import java.io.FileNotFoundException;
import java.io.IOException;
import javax.annotation.Nullable;

/** Gets expanded text ads. */
public class GetExpandedTextAds {

  private static final int PAGE_SIZE = 1_000;

  private static class GetExpandedTextAdsParams extends CodeSampleParams {

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

    @Parameter(names = ArgumentNames.AD_GROUP_ID)
    private Long adGroupId;
  }

  public static void main(String[] args) throws IOException {
    GetExpandedTextAdsParams params = new GetExpandedTextAdsParams();
    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");

      // Optional: Specify an ad group ID to restrict search to only a given ad group.
      params.adGroupId = null;
    }

    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 GetExpandedTextAds().runExample(googleAdsClient, params.customerId, params.adGroupId);
    } catch (GoogleAdsException gae) {
      // GoogleAdsException is the base class for most exceptions thrown by an API request.
      // Instances of this exception have a message and a GoogleAdsFailure that contains a
      // collection of GoogleAdsErrors that indicate the underlying causes of the
      // GoogleAdsException.
      System.err.printf(
          "Request ID %s failed due to GoogleAdsException. Underlying errors:%n",
          gae.getRequestId());
      int i = 0;
      for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
        System.err.printf("  Error %d: %s%n", i++, googleAdsError);
      }
      System.exit(1);
    }
  }

  /**
   * Runs the example.
   *
   * @param googleAdsClient the Google Ads API client.
   * @param customerId the client customer ID.
   * @param adGroupId the ad group ID for which ads will be retrieved. If {@code null}, returns from
   *     all ad groups.
   * @throws GoogleAdsException if an API request failed with one or more service errors.
   */
  private void runExample(
      GoogleAdsClient googleAdsClient, long customerId, @Nullable Long adGroupId) {
    try (GoogleAdsServiceClient googleAdsServiceClient =
        googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
      String searchQuery =
          "SELECT ad_group.id, "
              + "ad_group_ad.ad.id, "
              + "ad_group_ad.ad.expanded_text_ad.headline_part1, "
              + "ad_group_ad.ad.expanded_text_ad.headline_part2, "
              + "ad_group_ad.status "
              + "FROM ad_group_ad "
              + "WHERE ad_group_ad.ad.type = EXPANDED_TEXT_AD ";
      if (adGroupId != null) {
        searchQuery += String.format("AND ad_group.id = %d", adGroupId);
      }
      // Creates a request that will retrieve all ads using pages of the specified page size.
      SearchGoogleAdsRequest request =
          SearchGoogleAdsRequest.newBuilder()
              .setCustomerId(Long.toString(customerId))
              .setPageSize(PAGE_SIZE)
              .setQuery(searchQuery)
              .build();
      // Issues the search request.
      SearchPagedResponse searchPagedResponse = googleAdsServiceClient.search(request);
      // Iterates over all rows in all pages and prints the requested field values for the ad
      // in each row.
      for (GoogleAdsRow googleAdsRow : searchPagedResponse.iterateAll()) {
        Ad ad = googleAdsRow.getAdGroupAd().getAd();
        ExpandedTextAdInfo expandedTextAdInfo = ad.getExpandedTextAd();
        System.out.printf(
            "Expanded text ad with ID %d, status '%s', and headline '%s - %s' was found in ad "
                + "group with ID %d.%n",
            ad.getId(),
            googleAdsRow.getAdGroupAd().getStatus(),
            expandedTextAdInfo.getHeadlinePart1(),
            expandedTextAdInfo.getHeadlinePart2(),
            googleAdsRow.getAdGroup().getId());
      }
    }
  }
}

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

using System;

namespace Google.Ads.GoogleAds.Examples.V5
{
    /// <summary>
    /// This code example gets expanded text ads.
    /// </summary>
    public class GetExpandedTextAds : ExampleBase
    {
        /// <summary>
        /// The page size to be used by default.
        /// </summary>
        private const int PAGE_SIZE = 1_000;

        /// <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)
        {
            GetExpandedTextAds codeExample = new GetExpandedTextAds();

            Console.WriteLine(codeExample.Description);

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

            // Optional: ID of the ad group to restrict search to.
            long adGroupId = long.Parse("INSERT_AD_GROUP_ID_HERE");

            codeExample.Run(new GoogleAdsClient(), customerId, adGroupId);
        }

        /// <summary>
        /// Returns a description about the code example.
        /// </summary>
        public override string Description => "This example gets expanded text ads.";

        /// <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="adGroupId">Optional: ID of the ad group to restrict search to.</param>
        public void Run(GoogleAdsClient client, long customerId, long? adGroupId)
        {
            // Get the GoogleAdsService.
            GoogleAdsServiceClient googleAdsService = client.GetService(
                Services.V5.GoogleAdsService);

            string searchQuery =
                $@"SELECT
                 ad_group.id,
                 ad_group_ad.ad.id,
                 ad_group_ad.ad.expanded_text_ad.headline_part1,
                 ad_group_ad.ad.expanded_text_ad.headline_part2,
                 ad_group_ad.status
             FROM ad_group_ad
             WHERE
                 ad_group_ad.ad.type = EXPANDED_TEXT_AD ";

            if (adGroupId != null)
            {
                searchQuery += $" AND ad_group.id = {adGroupId}";
            }

            // Create a request that will retrieve all ads using pages of the specified page size.
            SearchGoogleAdsRequest request = new SearchGoogleAdsRequest()
            {
                CustomerId = customerId.ToString(),
                PageSize = PAGE_SIZE,
                Query = searchQuery
            };

            try
            {
                // Issue the search request.
                PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> searchPagedResponse =
                    googleAdsService.Search(request);

                // Iterate over all rows in all pages and prints the requested field values for
                // the ad in each row.
                foreach (GoogleAdsRow googleAdsRow in searchPagedResponse)
                {
                    Ad ad = googleAdsRow.AdGroupAd.Ad;
                    ExpandedTextAdInfo expandedTextAdInfo = ad.ExpandedTextAd;
                    Console.WriteLine("Expanded text ad with ID {0}, status '{1}', and headline " +
                        "'{2} - {3}' was found in ad group with ID {4}.",
                        ad.Id, googleAdsRow.AdGroupAd.Status, expandedTextAdInfo.HeadlinePart1,
                        expandedTextAdInfo.HeadlinePart2, googleAdsRow.AdGroup.Id);
                }
            }
            catch (GoogleAdsException e)
            {
                Console.WriteLine("Failure:");
                Console.WriteLine($"Message: {e.Message}");
                Console.WriteLine($"Failure: {e.Failure}");
                Console.WriteLine($"Request ID: {e.RequestId}");
                throw;
            }
        }
    }
}

PHP

<?php

/**
 * Copyright 2018 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Google\Ads\GoogleAds\Examples\BasicOperations;

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\V5\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V5\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V5\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\V5\Enums\AdGroupAdStatusEnum\AdGroupAdStatus;
use Google\Ads\GoogleAds\V5\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V5\Services\GoogleAdsRow;
use Google\ApiCore\ApiException;

/** This example gets expanded text ads. */
class GetExpandedTextAds
{
    private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
    // Optional: Specify an ad group ID below to restrict search to only a given ad group.
    private const AD_GROUP_ID = null;

    private const PAGE_SIZE = 1000;

    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::AD_GROUP_ID => GetOpt::OPTIONAL_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::AD_GROUP_ID] ?: self::AD_GROUP_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|null $adGroupId the ad group ID for which expanded text ads will be retrieved. If
     *     `null`, returns from all ad groups
     */
    public static function runExample(
        GoogleAdsClient $googleAdsClient,
        int $customerId,
        ?int $adGroupId
    ) {
        $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
        // Creates a query that retrieves expanded text ads.
        $query =
            'SELECT ad_group.id, '
            . 'ad_group_ad.ad.id, '
            . 'ad_group_ad.ad.expanded_text_ad.headline_part1, '
            . 'ad_group_ad.ad.expanded_text_ad.headline_part2, '
            . 'ad_group_ad.status '
            . 'FROM ad_group_ad '
            . 'WHERE ad_group_ad.ad.type = EXPANDED_TEXT_AD';
        if ($adGroupId !== null) {
            $query .= " AND ad_group.id = $adGroupId";
        }

        // Issues a search request by specifying page size.
        $response =
            $googleAdsServiceClient->search($customerId, $query, ['pageSize' => self::PAGE_SIZE]);

        // Iterates over all rows in all pages and prints the requested field values for
        // the expanded text ad in each row.
        foreach ($response->iterateAllElements() as $googleAdsRow) {
            /** @var GoogleAdsRow $googleAdsRow */
            $ad = $googleAdsRow->getAdGroupAd()->getAd();
            printf(
                "Expanded text ad with ID %d, status '%s', and headline '%s - %s' was found in ad "
                . "group with ID %d.%s",
                $ad->getId(),
                AdGroupAdStatus::name($googleAdsRow->getAdGroupAd()->getStatus()),
                $ad->getExpandedTextAd()->getHeadlinePart1(),
                $ad->getExpandedTextAd()->getHeadlinePart2(),
                $googleAdsRow->getAdGroup()->getId(),
                PHP_EOL
            );
        }
    }
}

GetExpandedTextAds::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.
"""This example illustrates how to retrieve expanded text ads."""


import argparse
import sys

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


def main(client, customer_id, ad_group_id=None):
    ga_service = client.get_service("GoogleAdsService", version="v5")
    ad_group_ad_status_enum = client.get_type(
        "AdGroupAdStatusEnum", version="v5"
    ).AdGroupAdStatus

    query = """
        SELECT
          ad_group.id,
          ad_group_ad.ad.id,
          ad_group_ad.ad.expanded_text_ad.headline_part1,
          ad_group_ad.ad.expanded_text_ad.headline_part2,
          ad_group_ad.status
        FROM ad_group_ad
        WHERE ad_group_ad.ad.type = EXPANDED_TEXT_AD"""

    if ad_group_id:
        query += f" AND ad_group.id = {ad_group_id}"

    response = ga_service.search_stream(customer_id, query=query)

    try:
        for batch in response:
            for row in batch.results:
                ad = row.ad_group_ad.ad

                if ad.expanded_text_ad:
                    expanded_text_ad_info = ad.expanded_text_ad

                print(
                    f"Expanded text ad with ID {ad.id}, status "
                    f'"{ad_group_ad_status_enum.Name(row.ad_group_ad.status)}", '
                    "and headline "
                    f'"{expanded_text_ad_info.headline_part1}"'
                    f' - "{expanded_text_ad_info.headline_part2}" was '
                    f"found in ad group with ID {row.ad_group.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)


if __name__ == "__main__":
    # GoogleAdsClient will read the google-ads.yaml configuration file in the
    # home directory if none is specified.
    google_ads_client = GoogleAdsClient.load_from_storage()

    parser = argparse.ArgumentParser(
        description="List ad groups for specified customer."
    )
    # 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",
        "--ad_group_id",
        type=str,
        required=False,
        help="The ad group ID. ",
    )
    args = parser.parse_args()

    main(google_ads_client, args.customer_id, ad_group_id=args.ad_group_id)

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 retrieves expanded text ads.

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

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


  search_query = <<~QUERY
    SELECT ad_group.id,
           ad_group_ad.ad.id,
           ad_group_ad.ad.expanded_text_ad.headline_part1,
           ad_group_ad.ad.expanded_text_ad.headline_part2,
           ad_group_ad.status
   FROM ad_group_ad
   WHERE ad_group_ad.ad.type = EXPANDED_TEXT_AD
  QUERY

  if ad_group_id
    search_query << " AND ad_group.id = #{ad_group_id}"
  end

  response = client.service.google_ads.search(
    customer_id: customer_id,
    query: search_query,
    page_size: PAGE_SIZE,
  )

  response.each do |row|
    ad = row.ad_group_ad.ad
    if ad.expanded_text_ad
      eta = ad.expanded_text_ad

      puts "Expanded text ad with ID #{ad.id}, status #{row.ad_group_ad.status}, " \
          "and headline '#{eta.headline_part1} - #{eta.headline_part2}' was found in ad group " \
          "with ID #{row.ad_group.id}."
    end
  end
end

if __FILE__ == $0
  PAGE_SIZE = 1000

  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[:ad_group_id] = nil

  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', '--ad-group-id AD-GROUP-ID', String,
        '(Optional) Ad Group ID') do |v|
      options[:ad_group_id] = v
    end

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

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

  begin
    get_expanded_text_ads(options.fetch(:customer_id).tr("-", ""), options[:ad_group_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 gets expanded text ads for a customer or for a specific ad group.
# To add expanded text ads, run add_expanded_text_ads.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::Utils::SearchGoogleAdsIterator;
use
  Google::Ads::GoogleAds::V5::Services::GoogleAdsService::SearchGoogleAdsRequest;

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

use constant PAGE_SIZE => 1000;

# 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 $ad_group_id = undef;

sub get_expanded_text_ads {
  my ($api_client, $customer_id, $ad_group_id) = @_;

  # Create the search query.
  my $search_query =
    "SELECT ad_group.id, ad_group_ad.ad.id, " .
    "ad_group_ad.ad.expanded_text_ad.headline_part1, " .
    "ad_group_ad.ad.expanded_text_ad.headline_part2, " .
    "ad_group_ad.status FROM ad_group_ad " .
    "WHERE ad_group_ad.ad.type = EXPANDED_TEXT_AD";

  if ($ad_group_id) {
    $search_query .= " AND ad_group.id = $ad_group_id";
  }

  # Create a search Google Ads request that will retrieve all expanded text ads
  # using pages of the specified page size.
  my $search_request =
    Google::Ads::GoogleAds::V5::Services::GoogleAdsService::SearchGoogleAdsRequest
    ->new({
      customerId => $customer_id,
      query      => $search_query,
      pageSize   => PAGE_SIZE
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $iterator = Google::Ads::GoogleAds::Utils::SearchGoogleAdsIterator->new({
    service => $google_ads_service,
    request => $search_request
  });

  # Iterate over all rows in all pages and print the requested field values for
  # the expanded text ad in each row.
  while ($iterator->has_next) {
    my $google_ads_row = $iterator->next;

    my $ad                    = $google_ads_row->{adGroupAd}{ad};
    my $expanded_text_ad_info = $ad->{expandedTextAd};

    printf
      "Expanded text ad with ID %d, status '%s', and headline '%s - %s' " .
      "was found in ad group with ID %d.\n",
      $ad->{id},
      $google_ads_row->{adGroupAd}{status},
      $expanded_text_ad_info->{headlinePart1},
      $expanded_text_ad_info->{headlinePart2},
      $google_ads_row->{adGroup}{id};
  }

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

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

=pod

=head1 NAME

get_expanded_text_ads

=head1 DESCRIPTION

This example gets expanded text ads for a customer or for a specific ad group.
To add expanded text ads, run add_expanded_text_ads.pl.

=head1 SYNOPSIS

get_expanded_text_ads.pl [options]

    -help                       Show the help message.
    -customer_id                The Google Ads customer ID.
    -ad_group_id                [optional] The ad group ID.

=cut

Ad variations

Ad variations allow you to easily create and test variations of your ads across multiple campaigns or your entire account. Creating and managing ad variations is currently not supported in Google Ads API, but you can identify the experimental ads created by the ad variations feature using one of the following methods.

Reporting

The ad_group_ad.ad.type in reports for expanded text ads is EXPANDED_TEXT_AD. To make it easier to retrieve data related to expanded text ads in reports, the following fields can be selected along with ad_group_ad:

Upgrade from standard text ads

The upgrade to expanded text ads will require your intervention: In many cases, the second and third headlines will need new content, and you'll need to decide when to enable the new expanded text ad and when to disable the old standard text ad.

To upgrade your standard text ads to expanded text ads:

  1. Create the new expanded text ad in a PAUSED state based on the data in the standard text ad. Take into consideration that TextAdInfo.description1 in standard text ads is 35 characters, while ExpandedTextAdInfo.headline_part2 in expanded text ads is 30 characters: If you simply copy the text from the text ad's description1 to the expanded text ad's headline_part2, an error will result.

  2. Wait for the new expanded text ad's policy_summary.approval_status to become APPROVED.

  3. If you're using fully automated conversion-based bidding (Target CPA or Target ROAS), we recommend transitioning to expanded text ads gradually by letting the expanded text ads run in parallel with the standard text ads for some time before removing the standard text ads.

  4. Send an AdGroupAdService.MutateAdGroupAds request with two operations:

    • Set the new expanded text ad status to ENABLED.
    • Set the old standard text ad status to REMOVED.

If you're not sure where to start upgrading or experimenting, start with the standard text ads that are performing the worst because you'll get improved clickthrough rates with the new expanded text ads.

Upgrade progress

There are a few ways to measure your progress when upgrading.

Client account level (Google Ads UI)

Navigate to your Google Ads client account.

  • Click the Ads tab.
  • Select Filter > Create Filter.
  • Filter on Ad type as Text ad.
  • Click Apply.

This results in a list of standard text ads.

Client account level (API)

Using the GoogleAdsService.SearchStream with a Google Ads Query Language query that filters on ad_group_ad.ad.type in the WHERE clause.

Here's an example report query that retrieves all your standard text ads that need to be upgraded:

SELECT
  ad_group_ad.ad.id,
  ad_group_ad.status,
  ad_group.id,
  campaign.id,
  campaign.status
FROM ad_group_ad
WHERE ad_group_ad.ad.type = TEXT_AD

Upgrade helper

ETA Transition Helper is available to assist in upgrading standard text ads in bulk to expanded text ads.

The tool has two main components:

  1. A Google Ads script that copies your standard text ads to a Google Sheet and then helps you write expanded text ads to add to your Google Ads account.

  2. A Google Sheet that displays your standard text ads and allows you to configure the associated expanded text ads.

Code examples

You can view the complete code samples at the links below.