Create Feed Item Set
Stay organized with collections
Save and categorize content based on your preferences.
Java
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.ads.googleads.examples.feeds;
import static com.google.ads.googleads.examples.utils.CodeSampleHelper.getPrintableDateTime;
import com.beust.jcommander.Parameter;
import com.google.ads.googleads.examples.utils.ArgumentNames;
import com.google.ads.googleads.examples.utils.CodeSampleParams;
import com.google.ads.googleads.lib.GoogleAdsClient;
import com.google.ads.googleads.v18.errors.GoogleAdsError;
import com.google.ads.googleads.v18.errors.GoogleAdsException;
import com.google.ads.googleads.v18.resources.FeedItemSet;
import com.google.ads.googleads.v18.services.FeedItemSetOperation;
import com.google.ads.googleads.v18.services.FeedItemSetServiceClient;
import com.google.ads.googleads.v18.services.MutateFeedItemSetResult;
import com.google.ads.googleads.v18.services.MutateFeedItemSetsResponse;
import com.google.ads.googleads.v18.utils.ResourceNames;
import com.google.common.collect.ImmutableList;
import java.io.FileNotFoundException;
import java.io.IOException;
/**
* Creates a new feed item set for a specified feed, which must belong to either a Google Ads
* location extension or an affiliate extension. This is equivalent to a "location group" in the
* Google Ads UI. See https://support.google.com/google-ads/answer/9288588 for more details.
*/
public class CreateFeedItemSet {
private static class CreateFeedItemSetParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private long customerId;
@Parameter(names = ArgumentNames.FEED_ID, required = true)
private long feedId;
}
public static void main(String[] args) {
CreateFeedItemSetParams params = new CreateFeedItemSetParams();
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.feedId = Long.parseLong("INSERT_FEED_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 CreateFeedItemSet().runExample(googleAdsClient, params.customerId, params.feedId);
} 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 customer ID.
* @param feedId the feed ID.
* @throws GoogleAdsException if an API request failed with one or more service errors.
*/
private void runExample(GoogleAdsClient googleAdsClient, long customerId, long feedId) {
FeedItemSet.Builder feedItemSetBuilder =
FeedItemSet.newBuilder()
.setFeed(ResourceNames.feed(customerId, feedId))
.setDisplayName("Feed Item Set #" + getPrintableDateTime());
// A feed item set can be created as a dynamic set by setting an optional filter field
// below. If your feed is a location extension, uncomment the code that calls
// setDynamicLocationSetFilter. If instead your feed is an affiliate extension, uncomment the
// code that calls setDynamicAffiliateLocationSetFilter.
// 1) Location extension.
/*
feedItemSetBuilder.setDynamicLocationSetFilter(
DynamicLocationSetFilter.newBuilder()
// Dynamic location sets support filtering locations based on business name and/or
// labels. If both are specified, the feed item set will only include locations that
// satisfy both types of filters.
.setBusinessNameFilter(
// Adds a filter for a business name using exact matching.
BusinessNameFilter.newBuilder()
.setBusinessName("INSERT_YOUR_BUSINESS_NAME_HERE")
.setFilterType(FeedItemSetStringFilterType.EXACT))
// Adds a filter by feed item label resource name. If multiple labels are specified,
// the feed item set will only include feed items with all of the specified labels.
.addLabels("INSERT_BUSINESS_LABEL_HERE"));
*/
// 2) Affiliate extension. This snippet adds one chain ID, but you can add a collection of
// chain IDs using the addAllChainIds() builder method.
/*
feedItemSetBuilder.setDynamicAffiliateLocationSetFilter(
DynamicAffiliateLocationSetFilter.newBuilder()
.addChainIds(Long.parseLong("INSERT_CHAIN_ID_HERE")));
*/
// Constructs an operation that will create a new feed item set.
FeedItemSetOperation operation =
FeedItemSetOperation.newBuilder().setCreate(feedItemSetBuilder.build()).build();
// Creates the feed item set service client.
try (FeedItemSetServiceClient feedItemSetServiceClient =
googleAdsClient.getLatestVersion().createFeedItemSetServiceClient()) {
// Issues a mutate request to add the feed item set on the server.
MutateFeedItemSetsResponse response =
feedItemSetServiceClient.mutateFeedItemSets(
Long.toString(customerId), ImmutableList.of(operation));
for (MutateFeedItemSetResult result : response.getResultsList()) {
System.out.printf(
"Created a feed item set with resource name '%s'.%n", result.getResourceName());
}
}
}
}
C#
// 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
//
// 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.V18.Errors;
using Google.Ads.GoogleAds.V18.Resources;
using Google.Ads.GoogleAds.V18.Services;
using System;
using System.Collections.Generic;
namespace Google.Ads.GoogleAds.Examples.V18
{
/// <summary>
/// This code example creates a new feed item set for a specified feed, which must belong to
/// either a Google Ads location extension or an affiliate extension. This is equivalent to a
/// "location group" in the Google Ads UI.See
/// https://support.google.com/google-ads/answer/9288588 for more details.
/// </summary>
public class CreateFeedItemSet : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="CreateFeedItemSet"/> example.
/// </summary>
public class Options : OptionsBase
{
/// <summary>
/// The Google Ads customer ID for which the call is made.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The Google Ads customer ID for which the call is made.")]
public long CustomerId { get; set; }
/// <summary>
/// The Feed ID for creating the feed item set.
/// </summary>
[Option("feedId", Required = true, HelpText =
"The Feed ID for creating the feed item set.")]
public long FeedId { 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);
CreateFeedItemSet codeExample = new CreateFeedItemSet();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(), options.CustomerId, options.FeedId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description => "This code example creates a new feed item set for " +
"a specified feed, which must belong to either a Google Ads location extension or " +
"an affiliate extension. This is equivalent to a 'location group' in the Google " +
"Ads UI. See https://support.google.com/google-ads/answer/9288588 for more details.";
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads API client.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="feedId">The Feed ID for creating the feed item set.</param>
public void Run(GoogleAdsClient client, long customerId, long feedId)
{
// Get the FeedItemSetService.
FeedItemSetServiceClient feedItemService = client.GetService(
Services.V18.FeedItemSetService);
FeedItemSet feedItemSet = new FeedItemSet()
{
Feed = ResourceNames.Feed(customerId, feedId),
DisplayName = "Feed Item Set #" + ExampleUtilities.GetRandomString(),
};
// A feed item set can be created as a dynamic set by setting an optional filter
// field below. If your feed is a location extension, uncomment the code that calls
// DynamicLocationSetFilter. If instead your feed is an affiliate extension,
// uncomment the code that sets the DynamicAffiliateLocationSetFilter instead.
// 1) Location extension.
//feedItemSet.DynamicLocationSetFilter = new DynamicLocationSetFilter()
//{
// // Dynamic location sets support filtering locations based on business name
// // and/or labels. If both are specified, the feed item set will only include
// // locations that satisfy both types of filters.
// BusinessNameFilter = new BusinessNameFilter()
// {
// BusinessName = "INSERT_YOUR_BUSINESS_NAME_HERE",
// FilterType = FeedItemSetStringFilterType.Exact,
// },
// // Adds a filter by feed item label resource name. If multiple labels are
// // specified, the feed item set will only include feed items with all of the
// // specified labels.
// Labels = { "INSERT_BUSINESS_LABEL_HERE" }
//};
// 2) Affiliate extension.
//feedItemSet.DynamicAffiliateLocationSetFilter = new DynamicAffiliateLocationSetFilter()
//{
// ChainIds = { long.Parse("INSERT_CHAIN_ID_HERE") }
//};
// Constructs an operation that will create a new feed item set.
FeedItemSetOperation operation = new FeedItemSetOperation()
{
Create = feedItemSet
};
try
{
// Issues a mutate request to add the feed item set on the server.
MutateFeedItemSetsResponse response =
feedItemService.MutateFeedItemSets(customerId.ToString(), new[] { operation });
// Prints the resource names of the added feed item sets.
foreach (MutateFeedItemSetResult addedFeedItemSet in response.Results)
{
Console.WriteLine("Created a feed item set with resource name " +
$"'{addedFeedItemSet.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 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.
*/
namespace Google\Ads\GoogleAds\Examples\Feeds;
require __DIR__ . '/../../vendor/autoload.php';
use GetOpt\GetOpt;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentNames;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentParser;
use Google\Ads\GoogleAds\Examples\Utils\Helper;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V18\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V18\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V18\GoogleAdsException;
use Google\Ads\GoogleAds\Util\V18\ResourceNames;
use Google\Ads\GoogleAds\V18\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V18\Resources\FeedItemSet;
use Google\Ads\GoogleAds\V18\Services\FeedItemSetOperation;
use Google\Ads\GoogleAds\V18\Services\MutateFeedItemSetsRequest;
use Google\ApiCore\ApiException;
/**
* Creates a new feed item set for a specified feed, which must belong to either a Google Ads
* location extension or an affiliate extension. This is equivalent to a "location group" in the
* Google Ads UI. See https://support.google.com/google-ads/answer/9288588 for more detail.
*/
class CreateFeedItemSet
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const FEED_ID = 'INSERT_FEED_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::FEED_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::FEED_ID] ?: self::FEED_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 $feedId the ID of feed that a newly created feed item set will be associated with
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $feedId
) {
// Creates a new feed item set.
$feedItemSet = new FeedItemSet([
'feed' => ResourceNames::forFeed($customerId, $feedId),
'display_name' => 'Feed Item Set #' . Helper::getPrintableDatetime()
]);
// A feed item set can be created as a dynamic set by setting an optional filter field
// below. If your feed is a location extension, uncomment the code that sets
// $dynamic_location_set_filter. If your feed is an affiliate extension, set
// $dynamic_affiliate_location_set_filter instead.
// 1) Location extension.
/*
$feedItemSet->setDynamicLocationSetFilter(new DynamicLocationSetFilter([
// Adds a filter for a business name using exact matching.
'business_name_filter' => new BusinessNameFilter([
'business_name' => 'INSERT_YOUR_BUSINESS_NAME_HERE',
'filter_type' => FeedItemSetStringFilterType::EXACT
])
]));
*/
// 2) Affiliate extension.
/*
$feedItemSet->setDynamicAffiliateLocationSetFilter(
new DynamicAffiliateLocationSetFilter(['chain_ids' => [INSERT_CHAIN_IDS_HERE]])
);
*/
// Constructs an operation that will create a new feed item set.
$feedItemSetOperation = new FeedItemSetOperation();
$feedItemSetOperation->setCreate($feedItemSet);
// Issues a mutate request to add the feed item set on the server.
$feedItemServiceClient = $googleAdsClient->getFeedItemSetServiceClient();
$response = $feedItemServiceClient->mutateFeedItemSets(
MutateFeedItemSetsRequest::build($customerId, [$feedItemSetOperation])
);
// Prints some information about the created feed item set.
printf(
"Created a feed item set with resource name '%s'.%s",
$response->getResults()[0]->getResourceName(),
PHP_EOL
);
}
}
CreateFeedItemSet::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.
"""Creates a new feed item set for a specified feed.
The feed must belong to either a Google Ads location extension or an affiliate
extension. This is equivalent to a "location group" in the Google Ads UI. See
https://support.google.com/google-ads/answer/9288588 for more detail.
"""
import argparse
import sys
import uuid
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
def main(client, customer_id, feed_id):
"""The main method that creates all necessary entities for the example.
Args:
client: an initialized GoogleAdsClient instance.
customer_id: a client customer ID.
feed_id: the ID for a Feed belonging to the given customer.
"""
feed_item_set_service = client.get_service("FeedItemSetService")
feed_item_set_operation = client.get_type("FeedItemSetOperation")
feed_item_set = feed_item_set_operation.create
feed_resource_name = client.get_service("FeedService").feed_path(
customer_id, feed_id
)
feed_item_set.feed = feed_resource_name
feed_item_set.display_name = f"Feed Item Set #{uuid.uuid4()}"
# A feed item set can be created as a dynamic set by setting an optional
# filter field below. If your feed is a location extension, uncomment the code
# that sets dynamic_location_set_filter. If your feed is an affiliate
# extension, set dynamic_affiliate_location_set_filter instead.
# 1) Location Extension
# NOTE: Does not support Curated location extensions.
# dynamic_location_set_filter = feed_item_set.dynamic_location_set_filter
# business_name_filter = dynamic_location_set_filter.business_name_filter
# business_name_filter.business_name = 'INSERT_YOUR_BUSINESS_NAME_HERE'
# business_name_filter.filter_type = client.enums.FeedItemSetStringFilterTypeEnum.EXACT
# 2) Affiliate Extension
# dynamic_affiliate_location_set_filter = feed_item_set.dynamic_affiliate_location_set_filter
# dynamic_affiliate_location_set_filter.chain_ids.extend([INSERT_CHAIN_IDS_HERE])
response = feed_item_set_service.mutate_feed_item_sets(
customer_id=customer_id, operations=[feed_item_set_operation]
)
print(
"Created a feed item set with resource name: "
f"'{response.results[0].resource_name}'"
)
if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="Creates a new feed item set for a specified feed."
)
# 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(
"-f",
"--feed_id",
type=str,
required=True,
help="The feed ID.",
)
args = parser.parse_args()
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client = GoogleAdsClient.load_from_storage(version="v18")
try:
main(
googleads_client,
args.customer_id,
args.feed_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 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.
#
# Creates a new feed item set for a specified feed, which must belong to either
# a Google Ads location extension or an affiliate extension. This is equivalent
# to a "location group" in the Google Ads UI. See
# https://support.google.com/google-ads/answer/9288588 for more detail.
require 'optparse'
require 'google/ads/google_ads'
require 'date'
def create_feed_item_set(customer_id, feed_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
operation = client.operation.create_resource.feed_item_set do |set|
set.feed = client.path.feed(customer_id, feed_id)
set.display_name = "Feed Item Set ##{(Time.new.to_f * 1000).to_i}"
# A feed item set can be created as a dynamic set by setting an optional
# filter field below. If your feed is a location extension, uncomment the
# code that sets dynamic_location_set_filter. If your feed is an affiliate
# extension, set dynamic_affiliate_location_set_filter instead.
# 1) Location extension.
# set.dynamic_location_set_filter = client.resource.dynamic_location_set_filter do |filter|
# filter.business_name_filter = client.resource.business_name_filter do |bnf|
# bnf.business_name = "INSERT_YOUR_BUSINESS_NAME_HERE"
# bnf.filter_type = :EXACT
# end
# end
# 2) Affiliate extension.
# set.dynamic_affiliate_location_set_filter =
# client.resource.dynamic_affiliate_location_set_filter do |filter|
# filter.chain_ids = [INSERT_CHAIN_IDS_HERE]
# end
end
response = client.service.feed_item_set.mutate_feed_item_sets(
customer_id: customer_id,
operations: [operation],
)
puts "Created feed item set 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[:feed_id] = 'INSERT_FEED_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('-F', '--feed-id FEED-ID', String, 'Feed ID') do |v|
options[:feed_id] = v
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
create_feed_item_set(
options.fetch(:customer_id).tr("-", ""),
options.fetch(:feed_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 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
#
# 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.
#
# Creates a new feed item set for a specified feed, which must belong to either a
# Google Ads location extension or an affiliate extension. This is equivalent to
# a "location group" in the Google Ads UI.
# See https://support.google.com/google-ads/answer/9288588 for more detail.
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::V18::Resources::FeedItemSet;
use Google::Ads::GoogleAds::V18::Common::DynamicLocationSetFilter;
use Google::Ads::GoogleAds::V18::Common::BusinessNameFilter;
use Google::Ads::GoogleAds::V18::Common::DynamicAffiliateLocationSetFilter;
use Google::Ads::GoogleAds::V18::Enums::FeedItemSetStringFilterTypeEnum
qw(EXACT);
use
Google::Ads::GoogleAds::V18::Services::FeedItemSetService::FeedItemSetOperation;
use Google::Ads::GoogleAds::V18::Utils::ResourceNames;
use Getopt::Long qw(:config auto_help);
use Pod::Usage;
use Cwd qw(abs_path);
use Data::Uniqid qw(uniqid);
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
my $customer_id = "INSERT_CUSTOMER_ID_HERE";
my $feed_id = "INSERT_FEED_ID_HERE";
sub create_feed_item_set {
my ($api_client, $customer_id, $feed_id) = @_;
# Create a new feed item set.
my $feed_item_set = Google::Ads::GoogleAds::V18::Resources::FeedItemSet->new({
feed => Google::Ads::GoogleAds::V18::Utils::ResourceNames::feed(
$customer_id, $feed_id
),
displayName => "Feed Item Set #" . uniqid()});
# A feed item set can be created as a dynamic set by setting an optional filter
# field below. If your feed is a location extension, uncomment the code that
# sets 'dynamicLocationSetFilter'. If your feed is an affiliate extension, set
# 'dynamicAffiliateLocationSetFilter' instead.
# 1) Location extension.
# $feed_item_set->{dynamicLocationSetFilter} =
# Google::Ads::GoogleAds::V18::Common::DynamicLocationSetFilter->new({
# # Add a filter for a business name using exact matching.
# businessNameFilter =>
# Google::Ads::GoogleAds::V18::Common::BusinessNameFilter->new({
# businessName => "INSERT_YOUR_BUSINESS_NAME_HERE",
# filterType => EXACT
# })});
# 2) Affiliate extension.
# $feed_item_set->{dynamicAffiliateLocationSetFilter} =
# Google::Ads::GoogleAds::V18::Common::DynamicAffiliateLocationSetFilter->new({
# chainIds => [INSERT_CHAIN_IDS_HERE]});
# Construct an operation that will create a new feed item set.
my $feed_item_set_operation =
Google::Ads::GoogleAds::V18::Services::FeedItemSetService::FeedItemSetOperation
->new({
create => $feed_item_set
});
# Issue a mutate request to add the feed item set on the server.
my $feed_item_sets_response = $api_client->FeedItemSetService()->mutate({
customerId => $customer_id,
operations => [$feed_item_set_operation]});
# Print some information about the created feed item set.
printf
"Created a feed item set with resource name '%s'.\n",
$feed_item_sets_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,
"feed_id=i" => \$feed_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, $feed_id);
# Call the example.
create_feed_item_set($api_client, $customer_id =~ s/-//gr, $feed_id);
=pod
=head1 NAME
create_feed_item_set
=head1 DESCRIPTION
Creates a new feed item set for a specified feed, which must belong to either a
Google Ads location extension or an affiliate extension. This is equivalent to
a "location group" in the Google Ads UI.
See https://support.google.com/google-ads/answer/9288588 for more detail.
=head1 SYNOPSIS
create_feed_item_set.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-feed_id The ID of feed that a newly created feed item set
will be associated with.
=cut
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-18 UTC."],[],[]]
