Add Listing Scope
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.shoppingads
;
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.v21.common.ListingScopeInfo
;
import
com.google.ads.googleads.v21.common.ProductBrandInfo
;
import
com.google.ads.googleads.v21.common.ProductCustomAttributeInfo
;
import
com.google.ads.googleads.v21.common.ProductTypeInfo
;
import
com.google.ads.googleads.v21.enums.ProductCustomAttributeIndexEnum.ProductCustomAttributeIndex
;
import
com.google.ads.googleads.v21.enums.ProductTypeLevelEnum.ProductTypeLevel
;
import
com.google.ads.googleads.v21.errors.GoogleAdsError
;
import
com.google.ads.googleads.v21.errors.GoogleAdsException
;
import
com.google.ads.googleads.v21.resources.CampaignCriterion
;
import
com.google.ads.googleads.v21.services.CampaignCriterionOperation
;
import
com.google.ads.googleads.v21.services.CampaignCriterionServiceClient
;
import
com.google.ads.googleads.v21.services.MutateCampaignCriteriaResponse
;
import
com.google.ads.googleads.v21.services.MutateCampaignCriterionResult
;
import
com.google.ads.googleads.v21.utils.ResourceNames
;
import
com.google.common.collect.ImmutableList
;
import
java.io.FileNotFoundException
;
import
java.io.IOException
;
/**
* Adds a shopping listing scope to a shopping campaign. The example will construct and add a new
* listing scope which will act as the inventory filter for the campaign. The campaign will only
* advertise products that match the following requirements:
*
* <ul>
* <li>Brand is "google"
* <li>Custom label 0 is "top_selling_products"
* <li>Product type (level 1) is "electronics"
* <li>Product type (level 2) is "smartphones"
* </ul>
*
* Only one listing scope is allowed per campaign. Remove any existing listing scopes before running
* this example.
*/
public
class
AddListingScope
{
private
static
class
AddListingScopeParams
extends
CodeSampleParams
{
@Parameter
(
names
=
ArgumentNames
.
CUSTOMER_ID
,
required
=
true
)
private
Long
customerId
;
@Parameter
(
names
=
ArgumentNames
.
CAMPAIGN_ID
,
required
=
true
)
private
Long
campaignId
;
}
public
static
void
main
(
String
[]
args
)
{
AddListingScopeParams
params
=
new
AddListingScopeParams
();
if
(
!
params
.
parseArguments
(
args
))
{
// Either pass the required parameters for this example on the command line, or insert them
// into the code here. See the parameter class definition above for descriptions.
params
.
customerId
=
Long
.
parseLong
(
"INSERT_CUSTOMER_ID_HERE"
);
params
.
campaignId
=
Long
.
parseLong
(
"INSERT_CAMPAIGN_ID_HERE"
);
}
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
AddListingScope
().
runExample
(
googleAdsClient
,
params
.
customerId
,
params
.
campaignId
);
}
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 campaignId the campaign ID.
* @throws GoogleAdsException if an API request failed with one or more service errors.
*/
private
void
runExample
(
GoogleAdsClient
googleAdsClient
,
long
customerId
,
long
campaignId
)
{
String
campaignResourceName
=
ResourceNames
.
campaign
(
customerId
,
campaignId
);
// Creates a campaign criterion to store the listing scope.
CampaignCriterion
.
Builder
campaignCriterionBuilder
=
CampaignCriterion
.
newBuilder
().
setCampaign
(
campaignResourceName
);
// A listing scope allows you to filter the products that will be included in a given campaign.
// You can specify multiple dimensions with conditions that must be met for a product to be
// included in a campaign.
// A typical ListingScope might only have a few dimensions. This example demonstrates a range of
// different dimensions you could use.
ListingScopeInfo
.
Builder
listingScopeBuilder
=
campaignCriterionBuilder
.
getListingScopeBuilder
();
// Creates a ProductBrand dimension set to "google".
listingScopeBuilder
.
addDimensionsBuilder
()
.
setProductBrand
(
ProductBrandInfo
.
newBuilder
().
setValue
(
"google"
));
// Creates a ProductCustomAttribute dimension for INDEX0 set to "top_selling_products".
listingScopeBuilder
.
addDimensionsBuilder
()
.
setProductCustomAttribute
(
ProductCustomAttributeInfo
.
newBuilder
()
.
setIndex
(
ProductCustomAttributeIndex
.
INDEX0
)
.
setValue
(
"top_selling_products"
)
.
build
());
// Creates a ProductType dimension for LEVEL1 set to "electronics".
listingScopeBuilder
.
addDimensionsBuilder
()
.
setProductType
(
ProductTypeInfo
.
newBuilder
()
.
setLevel
(
ProductTypeLevel
.
LEVEL1
)
.
setValue
(
"electronics"
)
.
build
());
// Creates a ProductType dimension for LEVEL2 set to "smartphones".
listingScopeBuilder
.
addDimensionsBuilder
()
.
setProductType
(
ProductTypeInfo
.
newBuilder
()
.
setLevel
(
ProductTypeLevel
.
LEVEL2
)
.
setValue
(
"smartphones"
)
.
build
());
// Create a new campaign criterion containing the listingScope on the campaign.
try
(
CampaignCriterionServiceClient
campaignCriterionServiceClient
=
googleAdsClient
.
getLatestVersion
().
createCampaignCriterionServiceClient
())
{
// Calls the mutate method to add the campaign criterion.
MutateCampaignCriteriaResponse
response
=
campaignCriterionServiceClient
.
mutateCampaignCriteria
(
Long
.
toString
(
customerId
),
ImmutableList
.
of
(
CampaignCriterionOperation
.
newBuilder
()
.
setCreate
(
campaignCriterionBuilder
)
.
build
()));
System
.
out
.
printf
(
"Added %d campaign criteria:%n"
,
response
.
getResultsCount
());
for
(
MutateCampaignCriterionResult
result
:
response
.
getResultsList
())
{
System
.
out
.
println
(
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.V21.Common
;
using
Google.Ads.GoogleAds.V21.Errors
;
using
Google.Ads.GoogleAds.V21.Resources
;
using
Google.Ads.GoogleAds.V21.Services
;
using
System
;
using
System.Collections.Generic
;
using
static
Google
.
Ads
.
GoogleAds
.
V21
.
Enums
.
ProductCustomAttributeIndexEnum
.
Types
;
using
static
Google
.
Ads
.
GoogleAds
.
V21
.
Enums
.
ProductTypeLevelEnum
.
Types
;
namespace
Google.Ads.GoogleAds.Examples.V21
{
/// <summary>
/// This code example adds a shopping listing scope to a shopping campaign. The example will
/// construct and add a new listing scope which will act as the inventory filter for the
/// campaign. The campaign will only advertise products that match the following requirements:
///
/// <ul>
/// <li>Brand is "google"</li>
/// <li>Custom label 0 is "top_selling_products"</li>
/// <li>Product type (level 1) is "electronics"</li>
/// <li>Product type(level 2) is "smartphones"</li>
/// </ul>
///
/// Only one listing scope is allowed per campaign. Remove any existing listing scopes before
/// running this code example.
/// </summary>
public
class
AddListingScope
:
ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="AddListingScope"/> 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 campaign to which listing scope is added.
/// </summary>
[Option("campaignId", Required = true, HelpText =
"The campaign to which listing scope is added.")]
public
long
CampaignId
{
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
);
AddListingScope
codeExample
=
new
AddListingScope
();
Console
.
WriteLine
(
codeExample
.
Description
);
codeExample
.
Run
(
new
GoogleAdsClient
(),
options
.
CustomerId
,
options
.
CampaignId
);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public
override
string
Description
=
>
"This code example adds a shopping listing scope to a shopping campaign. The example "
+
"will construct and add a new listing scope which will act as the inventory filter "
+
"for the campaign. The campaign will only advertise products that match the "
+
"following requirements: \n"
+
" - Brand is 'google'\n"
+
" - Custom label 0 is 'top_selling_products'\n"
+
" - Product type (level 1) is 'electronics'\n"
+
" - Product type (level 2) is 'smartphones'\n"
+
"Only one listing scope is allowed per campaign. Remove any existing listing scopes "
+
"before running this code example."
;
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="campaignId">The campaign to which listing scope is added.</param>
public
void
Run
(
GoogleAdsClient
client
,
long
customerId
,
long
campaignId
)
{
// Get the CampaignCriterionService.
CampaignCriterionServiceClient
campaignCriterionService
=
client
.
GetService
(
Services
.
V21
.
CampaignCriterionService
);
// A listing scope allows you to filter the products that will be included in a given
// campaign. You can specify multiple dimensions with conditions that must be met for
// a product to be included in a campaign.
// A typical ListingScope might only have a few dimensions. This example demonstrates
// a range of different dimensions you could use.
ListingScopeInfo
listingScope
=
new
ListingScopeInfo
()
{
Dimensions
=
{
// Creates a ProductBrand dimension set to "google".
new
ListingDimensionInfo
()
{
ProductBrand
=
new
ProductBrandInfo
()
{
Value
=
"google"
}
},
// Creates a ProductCustomAttribute dimension for INDEX0 set to
// "top_selling_products".
new
ListingDimensionInfo
()
{
ProductCustomAttribute
=
new
ProductCustomAttributeInfo
()
{
Index
=
ProductCustomAttributeIndex
.
Index0
,
Value
=
"top_selling_products"
}
},
// Creates a ProductType dimension for LEVEL1 set to "electronics".
new
ListingDimensionInfo
()
{
ProductType
=
new
ProductTypeInfo
()
{
Level
=
ProductTypeLevel
.
Level1
,
Value
=
"electronics"
}
},
// Creates a ProductType dimension for LEVEL2 set to "smartphones".
new
ListingDimensionInfo
()
{
ProductType
=
new
ProductTypeInfo
()
{
Level
=
ProductTypeLevel
.
Level2
,
Value
=
"smartphones"
}
},
}
};
string
campaignResourceName
=
ResourceNames
.
Campaign
(
customerId
,
campaignId
);
// Creates a campaign criterion to store the listing scope.
CampaignCriterion
campaignCriterion
=
new
CampaignCriterion
()
{
Campaign
=
campaignResourceName
,
ListingScope
=
listingScope
};
CampaignCriterionOperation
operation
=
new
CampaignCriterionOperation
()
{
Create
=
campaignCriterion
};
try
{
// Calls the mutate method to add the campaign criterion.
MutateCampaignCriteriaResponse
response
=
campaignCriterionService
.
MutateCampaignCriteria
(
customerId
.
ToString
(),
new
[]
{
operation
});
Console
.
WriteLine
(
$"Added {response.Results.Count} campaign criteria:"
);
foreach
(
MutateCampaignCriterionResult
result
in
response
.
Results
)
{
Console
.
WriteLine
(
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 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\ShoppingAds;
require __DIR__ . '/../../vendor/autoload.php';
use GetOpt\GetOpt;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentNames;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentParser;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsException;
use Google\Ads\GoogleAds\Util\V21\ResourceNames;
use Google\Ads\GoogleAds\V21\Common\ListingDimensionInfo;
use Google\Ads\GoogleAds\V21\Common\ListingScopeInfo;
use Google\Ads\GoogleAds\V21\Common\ProductBrandInfo;
use Google\Ads\GoogleAds\V21\Common\ProductCustomAttributeInfo;
use Google\Ads\GoogleAds\V21\Common\ProductTypeInfo;
use Google\Ads\GoogleAds\V21\Enums\ProductCustomAttributeIndexEnum\ProductCustomAttributeIndex;
use Google\Ads\GoogleAds\V21\Enums\ProductTypeLevelEnum\ProductTypeLevel;
use Google\Ads\GoogleAds\V21\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V21\Resources\CampaignCriterion;
use Google\Ads\GoogleAds\V21\Services\CampaignCriterionOperation;
use Google\Ads\GoogleAds\V21\Services\MutateCampaignCriteriaRequest;
use Google\ApiCore\ApiException;
/**
* Adds a shopping listing scope to a shopping campaign. The example will construct and add a new
* listing scope which will act as the inventory filter for the campaign. The campaign will only
* advertise products that match the following requirements:
*
* <ul>
* <li>Brand is "google"
* <li>Custom label 0 is "top_selling_products"
* <li>Product type (level 1) is "electronics"
* <li>Product type (level 2) is "smartphones"
* </ul>
*
* Only one listing scope is allowed per campaign. Remove any existing listing scopes before running
* this example.
*/
class AddListingScope
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const CAMPAIGN_ID = 'INSERT_CAMPAIGN_ID_HERE';
public static function main()
{
// Either pass the required parameters for this example on the command line, or insert them
// into the constants above.
$options = (new ArgumentParser())->parseCommandArguments([
ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::CAMPAIGN_ID => GetOpt::REQUIRED_ARGUMENT
]);
// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();
// Construct a Google Ads client configured from a properties file and the
// OAuth2 credentials above.
$googleAdsClient = (new GoogleAdsClientBuilder())->fromFile()
->withOAuth2Credential($oAuth2Credential)
->build();
try {
self::runExample(
$googleAdsClient,
$options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID,
$options[ArgumentNames::CAMPAIGN_ID] ?: self::CAMPAIGN_ID
);
} catch (GoogleAdsException $googleAdsException) {
printf(
"Request with ID '%s' has failed.%sGoogle Ads failure details:%s",
$googleAdsException->getRequestId(),
PHP_EOL,
PHP_EOL
);
foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) {
/** @var GoogleAdsError $error */
printf(
"\t%s: %s%s",
$error->getErrorCode()->getErrorCode(),
$error->getMessage(),
PHP_EOL
);
}
exit(1);
} catch (ApiException $apiException) {
printf(
"ApiException was thrown with message '%s'.%s",
$apiException->getMessage(),
PHP_EOL
);
exit(1);
}
}
/**
* Runs the example.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param int $campaignId the campaign ID
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $campaignId
) {
// A listing scope allows you to filter the products that will be included in a given
// campaign. You can specify multiple dimensions with conditions that must be met for a
// product to be included in a campaign.
// A typical listing scope might only have a few dimensions. This example demonstrates a
// range of different dimensions you could use.
$listingScopeInfo = new ListingScopeInfo([
'dimensions' => [
// Creates a product brand info set to "google".
new ListingDimensionInfo([
'product_brand' => new ProductBrandInfo(['value' => 'google'])
]),
// Creates a product custom attribute info for INDEX0 set to "top_selling_products".
new ListingDimensionInfo([
'product_custom_attribute' => new ProductCustomAttributeInfo([
'index' => ProductCustomAttributeIndex::INDEX0,
'value' => 'top_selling_products'
])
]),
// Creates a product type info for LEVEL1 set to "electronics".
new ListingDimensionInfo([
'product_type' => new ProductTypeInfo([
'level' => ProductTypeLevel::LEVEL1,
'value' => 'electronics'
])
]),
// Creates a product type info for LEVEL2 set to "smartphones".
new ListingDimensionInfo([
'product_type' => new ProductTypeInfo([
'level' => ProductTypeLevel::LEVEL2,
'value' => 'smartphones'
])
])
]
]);
// Creates a campaign criterion to store the listing scope.
$campaignCriterion = new CampaignCriterion([
'campaign' => ResourceNames::forCampaign($customerId, $campaignId),
'listing_scope' => $listingScopeInfo
]);
// Creates a campaign criterion operation.
$campaignCriterionOperation = new CampaignCriterionOperation();
$campaignCriterionOperation->setCreate($campaignCriterion);
// Issues a mutate request to create a campaign criterion on the server and print its info.
$campaignCriterionServiceClient = $googleAdsClient->getCampaignCriterionServiceClient();
$response = $campaignCriterionServiceClient->mutateCampaignCriteria(
MutateCampaignCriteriaRequest::build($customerId, [$campaignCriterionOperation])
);
/** @var CampaignCriterion $addedCampaignCriterion */
$addedCampaignCriterion = $response->getResults()[0];
printf(
"Added a campaign criterion with resource name '%s'.%s",
$addedCampaignCriterion->getResourceName(),
PHP_EOL
);
}
}
AddListingScope::main();
Python
#!/usr/bin/env python
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Adds a shopping listing scope to a shopping campaign.
The example will construct and add a new listing scope which will act as the
inventory filter for the campaign. The campaign will only advertise products
that match the following requirements:
* Brand is "google".
* Custom label 0 is "top_selling_products".
* Product type (level 1) is "electronics".
* Product type (level 2) is "smartphones".
Only one listing scope is allowed per campaign. Remove any existing listing
scopes before running this example.
"""
import
argparse
import
sys
from
typing
import
List
from
google.ads.googleads.client
import
GoogleAdsClient
from
google.ads.googleads.errors
import
GoogleAdsException
from
google.ads.googleads.v21.common.types.criteria
import
(
ListingDimensionInfo
,
)
from
google.ads.googleads.v21.enums.types.product_custom_attribute_index
import
(
ProductCustomAttributeIndexEnum
,
)
from
google.ads.googleads.v21.enums.types.product_type_level
import
(
ProductTypeLevelEnum
,
)
from
google.ads.googleads.v21.resources.types.campaign_criterion
import
(
CampaignCriterion
,
)
from
google.ads.googleads.v21.services.services.campaign_criterion_service
import
(
CampaignCriterionServiceClient
,
)
from
google.ads.googleads.v21.services.services.campaign_service
import
(
CampaignServiceClient
,
)
from
google.ads.googleads.v21.services.types.campaign_criterion_service
import
(
CampaignCriterionOperation
,
MutateCampaignCriteriaResponse
,
)
def
main
(
client
:
GoogleAdsClient
,
customer_id
:
str
,
campaign_id
:
str
)
-
> None
:
campaign_service
:
CampaignServiceClient
=
client
.
get_service
(
"CampaignService"
)
campaign_criterion_operation
:
CampaignCriterionOperation
=
client
.
get_type
(
"CampaignCriterionOperation"
)
campaign_criterion
:
CampaignCriterion
=
campaign_criterion_operation
.
create
campaign_criterion
.
campaign
=
campaign_service
.
campaign_path
(
customer_id
,
campaign_id
)
# A listing scope allows you to filter the products that will be included in
# a given campaign. You can specify multiple dimensions with conditions that
# must be met for a product to be included in a campaign.
# A typical listing scope might only have a few dimensions. This example
# demonstrates a range of different dimensions you could use.
dimensions
:
List
[
ListingDimensionInfo
]
=
(
campaign_criterion
.
listing_scope
.
dimensions
)
product_brand_dimension
:
ListingDimensionInfo
=
client
.
get_type
(
"ListingDimensionInfo"
)
product_brand_dimension
.
product_brand
.
value
=
"google"
dimensions
.
append
(
product_brand_dimension
)
product_custom_attribute_index_enum
:
ProductCustomAttributeIndexEnum
=
(
client
.
enums
.
ProductCustomAttributeIndexEnum
)
product_custom_attribute_dimension
:
ListingDimensionInfo
=
client
.
get_type
(
"ListingDimensionInfo"
)
product_custom_attribute
=
(
product_custom_attribute_dimension
.
product_custom_attribute
)
product_custom_attribute
.
index
=
product_custom_attribute_index_enum
.
INDEX0
product_custom_attribute
.
value
=
"top_selling_products"
dimensions
.
append
(
product_custom_attribute_dimension
)
product_type_level_enum
:
ProductTypeLevelEnum
=
(
client
.
enums
.
ProductTypeLevelEnum
)
product_type_dimension_1
:
ListingDimensionInfo
=
client
.
get_type
(
"ListingDimensionInfo"
)
product_type
=
product_type_dimension_1
.
product_type
product_type
.
level
=
product_type_level_enum
.
LEVEL1
product_type
.
value
=
"electronics"
dimensions
.
append
(
product_type_dimension_1
)
product_type_dimension_2
:
ListingDimensionInfo
=
client
.
get_type
(
"ListingDimensionInfo"
)
product_type
=
product_type_dimension_2
.
product_type
product_type
.
level
=
product_type_level_enum
.
LEVEL2
product_type
.
value
=
"smartphones"
dimensions
.
append
(
product_type_dimension_2
)
campaign_criterion_service
:
CampaignCriterionServiceClient
=
(
client
.
get_service
(
"CampaignCriterionService"
)
)
campaign_criterion_response
:
MutateCampaignCriteriaResponse
=
(
campaign_criterion_service
.
mutate_campaign_criteria
(
customer_id
=
customer_id
,
operations
=
[
campaign_criterion_operation
]
)
)
print
(
f
"Added
{
len
(
campaign_criterion_response
.
results
)
}
campaign "
"criteria:"
)
for
criterion
in
campaign_criterion_response
.
results
:
print
(
criterion
.
resource_name
)
if
__name__
==
"__main__"
:
parser
=
argparse
.
ArgumentParser
(
description
=
(
"Adds a shopping listing scope to a shopping campaign."
)
)
# The following argument(s) should be provided to run the example.
parser
.
add_argument
(
"-c"
,
"--customer_id"
,
type
=
str
,
required
=
True
,
help
=
"The Google Ads customer ID."
,
)
parser
.
add_argument
(
"-i"
,
"--campaign_id"
,
type
=
str
,
required
=
True
,
help
=
"The campaign ID."
)
args
:
argparse
.
Namespace
=
parser
.
parse_args
()
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client
:
GoogleAdsClient
=
GoogleAdsClient
.
load_from_storage
(
version
=
"v21"
)
try
:
main
(
googleads_client
,
args
.
customer_id
,
args
.
campaign_id
)
except
GoogleAdsException
as
ex
:
print
(
f
'Request with ID "
{
ex
.
request_id
}
" failed with status'
f
'"
{
ex
.
error
.
code
()
.
name
}
" and includes the following errors:'
)
for
error
in
ex
.
failure
.
errors
:
print
(
f
'
\t
Error with message "
{
error
.
message
}
".'
)
if
error
.
location
:
for
field_path_element
in
error
.
location
.
field_path_elements
:
print
(
f
"
\t\t
On field:
{
field_path_element
.
field_name
}
"
)
sys
.
exit
(
1
)
Ruby
#!/usr/bin/env ruby
#
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This example shows how to add a shopping listing scope to a shopping campaign.
# The example will construct and add a new listing scope which will act as the
# inventory filter for the campaign. The campaign will only advertise products
# that match the following requirements:
# - Brand is "google"
# - Custom label 0 is "top_selling_products"
# - Product type (level 1) is "electronics"
# - Product type (level 2) is "smartphones"
#
# Only one listing scope is allowed per campaign. Remove any existing listing
# scopes before running this example.
require
'optparse'
require
'google/ads/google_ads'
def
add_listing_scope
(
customer_id
,
campaign_id
)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client
=
Google
::
Ads
::
GoogleAds
::
GoogleAdsClient
.
new
# A listing scope allows you to filter the products that will be included in
# a given campaign. You can specify multiple dimensions with conditions that
# must be met for a product to be included in a campaign.
# A typical listing scope might only have a few dimensions. This example
# demonstrates a range of different dimensions you could use.
operation
=
client
.
operation
.
create_resource
.
campaign_criterion
do
|
cc
|
cc
.
campaign
=
client
.
path
.
campaign
(
customer_id
,
campaign_id
)
cc
.
listing_scope
=
client
.
resource
.
listing_scope_info
do
|
lsi
|
# Creates a ProductBrand dimension set to "google".
lsi
.
dimensions
<<
client
.
resource
.
listing_dimension_info
do
|
ldi
|
ldi
.
product_brand
=
client
.
resource
.
product_brand_info
do
|
pbi
|
pbi
.
value
=
'google'
end
end
# Creates a ProductCustomAttribute dimension for INDEX0 set to "top_selling_products".
lsi
.
dimensions
<<
client
.
resource
.
listing_dimension_info
do
|
ldi
|
ldi
.
product_custom_attribute
=
client
.
resource
.
product_custom_attribute_info
do
|
pcai
|
pcai
.
value
=
'top_selling_products'
pcai
.
index
=
:INDEX0
end
end
# Creates a ProductType dimension for LEVEL1 set to "electronics".
lsi
.
dimensions
<<
client
.
resource
.
listing_dimension_info
do
|
ldi
|
ldi
.
product_type
=
client
.
resource
.
product_type_info
do
|
pti
|
pti
.
value
=
'electronics'
pti
.
level
=
:LEVEL1
end
end
# Creates a ProductType dimension for LEVEL2 set to "smartphones".
lsi
.
dimensions
<<
client
.
resource
.
listing_dimension_info
do
|
ldi
|
ldi
.
product_type
=
client
.
resource
.
product_type_info
do
|
pti
|
pti
.
value
=
'smartphones'
pti
.
level
=
:LEVEL2
end
end
end
end
# Issue the mutate request.
response
=
client
.
service
.
campaign_criterion
.
mutate_campaign_criteria
(
customer_id
:
customer_id
,
operations
:
[
operation
]
)
puts
"Added
#{
response
.
results
.
size
}
campaign criteria:"
response
.
results
.
each
do
|
resource
|
puts
"
#{
resource
.
resource_name
}
"
end
end
if
__FILE__
==
$0
options
=
{}
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
options
[
:customer_id
]
=
'INSERT_CUSTOMER_ID_HERE'
options
[
:campaign_id
]
=
'INSERT_CAMPAIGN_ID_HERE'
# Specifying any value for this field on the command line will override this
# to true.
options
[
:should_replace_existing_tree
]
=
false
OptionParser
.
new
do
|
opts
|
opts
.
banner
=
sprintf
(
"Usage:
#{
File
.
basename
(
__FILE__
)
}
[options]"
)
opts
.
separator
''
opts
.
separator
'Options:'
opts
.
on
(
'-C'
,
'--customer-id CUSTOMER-ID'
,
String
,
'Customer ID'
)
do
|
v
|
options
[
:customer_id
]
=
v
end
opts
.
on
(
'-c'
,
'--campaign-id CAMPAIGN-ID'
,
String
,
'Campaign ID'
)
do
|
v
|
options
[
:campaign_id
]
=
v
end
opts
.
separator
''
opts
.
separator
'Help:'
opts
.
on_tail
(
'-h'
,
'--help'
,
'Show this message'
)
do
puts
opts
exit
end
end
.
parse!
begin
add_listing_scope
(
options
.
fetch
(
:customer_id
)
.
tr
(
'-'
,
''
),
options
.
fetch
(
:campaign_id
)
)
rescue
Google
::
Ads
::
GoogleAds
::
Errors
::
GoogleAdsError
=
>
e
e
.
failure
.
errors
.
each
do
|
error
|
STDERR
.
printf
(
"Error with message: %s
\n
"
,
error
.
message
)
error
.
location
& .
field_path_elements
& .
each
do
|
field_path_element
|
STDERR
.
printf
(
"
\t
On field: %s
\n
"
,
field_path_element
.
field_name
)
end
error
.
error_code
.
to_h
.
each
do
|
k
,
v
|
next
if
v
==
:UNSPECIFIED
STDERR
.
printf
(
"
\t
Type: %s
\n\t
Code: %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.
#
# Adds a shopping listing scope to a shopping campaign. The example will construct
# and add a new listing scope which will act as the inventory filter for the campaign.
# The campaign will only advertise products that match the following requirements:
#
# - Brand is "google"
# - Custom label 0 is "top_selling_products"
# - Product type (level 1) is "electronics"
# - Product type (level 2) is "smartphones"
#
# Only one listing scope is allowed per campaign. Remove any existing listing
# scopes before running this example.
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::V21::Resources::CampaignCriterion
;
use
Google::Ads::GoogleAds::V21::Common::ListingDimensionInfo
;
use
Google::Ads::GoogleAds::V21::Common::ProductBrandInfo
;
use
Google::Ads::GoogleAds::V21::Common::ProductCustomAttributeInfo
;
use
Google::Ads::GoogleAds::V21::Common::ProductTypeInfo
;
use
Google::Ads::GoogleAds::V21::Common::ListingScopeInfo
;
use
Google::Ads::GoogleAds::V21::Enums::ProductCustomAttributeIndexEnum
qw(INDEX0)
;
use
Google::Ads::GoogleAds::V21::Enums::ProductTypeLevelEnum
qw(LEVEL1 LEVEL2)
;
use
Google::Ads::GoogleAds::V21::Services::CampaignCriterionService::CampaignCriterionOperation
;
use
Google::Ads::GoogleAds::V21::Utils::ResourceNames
;
use
Getopt::Long
qw(:config auto_help)
;
use
Pod::Usage
;
use
Cwd
qw(abs_path)
;
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
my
$customer_id
=
"INSERT_CUSTOMER_ID_HERE"
;
my
$campaign_id
=
"INSERT_CAMPAIGN_ID_HERE"
;
sub
add_listing_scope
{
my
(
$api_client
,
$customer_id
,
$campaign_id
)
=
@_
;
# Create a campaign criterion to store the listing scope.
my
$campaign_criterion
=
Google::Ads::GoogleAds::V21::Resources::
CampaignCriterion
-
> new
({
campaign
=
>
Google::Ads::GoogleAds::V21::Utils::ResourceNames::
campaign
(
$customer_id
,
$campaign_id
)});
# A listing scope allows you to filter the products that will be included in
# a given campaign. You can specify multiple dimensions with conditions that
# must be met for a product to be included in a campaign.
# A typical listing scope might only have a few dimensions. This example
# demonstrates a range of different dimensions you could use.
my
$dimensions
=
[]
;
# Create a ProductBrand dimension set to "google".
push
@$dimensions
,
Google::Ads::GoogleAds::V21::Common::
ListingDimensionInfo
-
> new
({
productBrand
=
>
Google::Ads::GoogleAds::V21::Common::
ProductBrandInfo
-
> new
({
value
=
>
"google"
})});
# Create a ProductCustomAttribute dimension for INDEX0 set to "top_selling_products".
push
@$dimensions
,
Google::Ads::GoogleAds::V21::Common::
ListingDimensionInfo
-
> new
({
productCustomAttribute
=
>
Google::Ads::GoogleAds::V21::Common::
ProductCustomAttributeInfo
-
> new
({
index
=
>
INDEX0
,
value
=
>
"top_selling_products"
})});
# Create a ProductType dimension for LEVEL1 set to "electronics".
push
@$dimensions
,
Google::Ads::GoogleAds::V21::Common::
ListingDimensionInfo
-
> new
({
productType
=
>
Google::Ads::GoogleAds::V21::Common::
ProductTypeInfo
-
> new
({
level
=
>
LEVEL1
,
value
=
>
"electronics"
})});
# Create a ProductType dimension for LEVEL2 set to "smartphones".
push
@$dimensions
,
Google::Ads::GoogleAds::V21::Common::
ListingDimensionInfo
-
> new
({
productType
=
>
Google::Ads::GoogleAds::V21::Common::
ProductTypeInfo
-
> new
({
level
=
>
LEVEL2
,
value
=
>
"smartphones"
})});
$campaign_criterion
-
> {
listingScope
}
=
Google::Ads::GoogleAds::V21::Common::
ListingScopeInfo
-
> new
({
dimensions
=
>
$dimensions
});
# Create a campaign criterion operation.
my
$campaign_criterion_operation
=
Google::Ads::GoogleAds::V21::Services::CampaignCriterionService::
CampaignCriterionOperation
-
> new
({
create
=
>
$campaign_criterion
});
# Add the campaign criterion containing the listing scope on the campaign.
my
$campaign_criteria_response
=
$api_client
-
> CampaignCriterionService
()
-
> mutate
({
customerId
=
>
$customer_id
,
operations
=
>
[
$campaign_criterion_operation
]});
printf
"Added a campaign criteria with resource name: '%s'.\n"
,
$campaign_criteria_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
,
"campaign_id=i"
=
>
\
$campaign_id
);
# Print the help message if the parameters are not initialized in the code nor
# in the command line.
pod2usage
(
2
)
if
not
check_params
(
$customer_id
,
$campaign_id
);
# Call the example.
add_listing_scope
(
$api_client
,
$customer_id
=~
s/-//g
r
,
$campaign_id
);
=pod
=head1 NAME
add_listing_scope
=head1 DESCRIPTION
Adds a shopping listing scope to a shopping campaign. The example will construct
and add a new listing scope which will act as the inventory filter for the campaign.
The campaign will only advertise products that match the following requirements:
- Brand is "google"
- Custom label 0 is "top_selling_products"
- Product type (level 1) is "electronics"
- Product type (level 2) is "smartphones"
Only one listing scope is allowed per campaign. Remove any existing listing scopes
before running this example.
=head1 SYNOPSIS
add_listing_scope.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-campaign_id The campaign ID.
=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 2025-09-03 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 2025-09-03 UTC."],[[["\u003cp\u003eThe code adds a listing scope to a Google Shopping campaign, filtering the products eligible for advertising.\u003c/p\u003e\n"],["\u003cp\u003eThis listing scope uses criteria like brand, custom label, and product type to select specific products.\u003c/p\u003e\n"],["\u003cp\u003eOnly one listing scope is allowed per campaign; existing scopes should be removed before adding a new one.\u003c/p\u003e\n"],["\u003cp\u003eThe code is provided in various programming languages (Java, C#, PHP, Python, Ruby, Perl) with similar functionality.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes the Google Ads API to create and apply the listing scope to the desired campaign.\u003c/p\u003e\n"]]],[],null,[]]
