Add Demographic Targeting Criteria
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.targeting
;
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.AgeRangeInfo
;
import
com.google.ads.googleads.v21.common.GenderInfo
;
import
com.google.ads.googleads.v21.enums.AgeRangeTypeEnum.AgeRangeType
;
import
com.google.ads.googleads.v21.enums.GenderTypeEnum.GenderType
;
import
com.google.ads.googleads.v21.errors.GoogleAdsError
;
import
com.google.ads.googleads.v21.errors.GoogleAdsException
;
import
com.google.ads.googleads.v21.resources.AdGroupCriterion
;
import
com.google.ads.googleads.v21.services.AdGroupCriterionOperation
;
import
com.google.ads.googleads.v21.services.AdGroupCriterionServiceClient
;
import
com.google.ads.googleads.v21.services.MutateAdGroupCriteriaResponse
;
import
com.google.ads.googleads.v21.services.MutateAdGroupCriterionResult
;
import
com.google.ads.googleads.v21.utils.ResourceNames
;
import
java.io.FileNotFoundException
;
import
java.io.IOException
;
import
java.util.ArrayList
;
import
java.util.List
;
/** Adds demographic criteria to an ad group. */
public
class
AddDemographicTargetingCriteria
{
private
static
class
AddDemographicTargetingCriteriaParams
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
)
{
AddDemographicTargetingCriteriaParams
params
=
new
AddDemographicTargetingCriteriaParams
();
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
AddDemographicTargetingCriteria
()
.
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 in which to create criterion.
* @param adGroupId the ad group ID in which to create criterion.
*/
private
void
runExample
(
GoogleAdsClient
googleAdsClient
,
long
customerId
,
long
adGroupId
)
{
String
adGroupResourceName
=
ResourceNames
.
adGroup
(
customerId
,
adGroupId
);
List<AdGroupCriterionOperation>
operations
=
new
ArrayList
<> ();
// Creates a gender demographic criterion.
AdGroupCriterion
genderAdGroupCriterionOperation
=
AdGroupCriterion
.
newBuilder
()
.
setAdGroup
(
adGroupResourceName
)
.
setGender
(
GenderInfo
.
newBuilder
().
setType
(
GenderType
.
MALE
).
build
())
.
build
();
// Creates an age range negative demographic criterion.
AdGroupCriterion
ageRangeNegativeAdGroupCriterionOperation
=
AdGroupCriterion
.
newBuilder
()
.
setAdGroup
(
adGroupResourceName
)
.
setNegative
(
true
)
.
setAgeRange
(
AgeRangeInfo
.
newBuilder
().
setType
(
AgeRangeType
.
AGE_RANGE_18_24
).
build
())
.
build
();
// Creates and adds the operations.
operations
.
add
(
AdGroupCriterionOperation
.
newBuilder
().
setCreate
(
genderAdGroupCriterionOperation
).
build
());
operations
.
add
(
AdGroupCriterionOperation
.
newBuilder
()
.
setCreate
(
ageRangeNegativeAdGroupCriterionOperation
)
.
build
());
// Creates the service client.
try
(
AdGroupCriterionServiceClient
adGroupCriterionServiceClient
=
googleAdsClient
.
getLatestVersion
().
createAdGroupCriterionServiceClient
())
{
// Issues the mutate request.
MutateAdGroupCriteriaResponse
response
=
adGroupCriterionServiceClient
.
mutateAdGroupCriteria
(
Long
.
toString
(
customerId
),
operations
);
// Prints the results.
System
.
out
.
printf
(
"Added %d ad group criteria:%n"
,
response
.
getResultsCount
());
for
(
MutateAdGroupCriterionResult
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
.
AgeRangeTypeEnum
.
Types
;
using
static
Google
.
Ads
.
GoogleAds
.
V21
.
Enums
.
GenderTypeEnum
.
Types
;
namespace
Google.Ads.GoogleAds.Examples.V21
{
/// <summary>
/// This code example adds demographic criteria to an ad group. To get ad groups,
/// run GetAdGroups.cs.
/// </summary>
public
class
AddDemographicTargetingCriteria
:
ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="AddDemographicTargetingCriteria"/>
/// example.
/// </summary>
public
class
Options
:
OptionsBase
{
/// <summary>
/// The Google Ads customer ID for which the call is made.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The Google Ads customer ID for which the call is made.")]
public
long
CustomerId
{
get
;
set
;
}
/// <summary>
/// ID of the ad group to which targeting criteria are added.
/// </summary>
[Option("adGroupId", Required = true, HelpText =
"ID of the ad group to which targeting criteria are added.")]
public
long
AdGroupId
{
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
);
AddDemographicTargetingCriteria
codeExample
=
new
AddDemographicTargetingCriteria
();
Console
.
WriteLine
(
codeExample
.
Description
);
codeExample
.
Run
(
new
GoogleAdsClient
(),
options
.
CustomerId
,
options
.
AdGroupId
);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public
override
string
Description
=
>
"This code example adds demographic criteria to an ad group. To get ad groups, run "
+
"GetAdGroups.cs."
;
/// <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">ID of the ad group to which targeting criteria are added.
/// </param>
public
void
Run
(
GoogleAdsClient
client
,
long
customerId
,
long
adGroupId
)
{
// Get the AdGroupCriterionService.
AdGroupCriterionServiceClient
adGroupCriterionService
=
client
.
GetService
(
Services
.
V21
.
AdGroupCriterionService
);
string
adGroupResourceName
=
ResourceNames
.
AdGroup
(
customerId
,
adGroupId
);
// Creates a positive ad group criterion for gender.
AdGroupCriterion
genderAdGroupCriterion
=
new
AdGroupCriterion
()
{
AdGroup
=
adGroupResourceName
,
// Targets male.
Gender
=
new
GenderInfo
()
{
Type
=
GenderType
.
Male
}
};
// Creates a negative ad group criterion for age range.
AdGroupCriterion
ageRangeNegativeAdGroupCriterion
=
new
AdGroupCriterion
()
{
AdGroup
=
adGroupResourceName
,
// Makes this ad group criterion negative.
Negative
=
true
,
// Targets the age range of 18 to 24.
AgeRange
=
new
AgeRangeInfo
()
{
Type
=
AgeRangeType
.
AgeRange1824
}
};
// Creates ad group criterion operations for both ad group criteria.
AdGroupCriterionOperation
[]
operations
=
new
AdGroupCriterionOperation
[]
{
new
AdGroupCriterionOperation
()
{
Create
=
genderAdGroupCriterion
},
new
AdGroupCriterionOperation
()
{
Create
=
ageRangeNegativeAdGroupCriterion
}
};
try
{
// Issues a mutate request to add the ad group criteria and print out some
// information.
MutateAdGroupCriteriaResponse
response
=
adGroupCriterionService
.
MutateAdGroupCriteria
(
customerId
.
ToString
(),
operations
);
Console
.
WriteLine
(
$"Added {response.Results.Count} demographic ad group"
+
$" criteria:"
);
foreach
(
MutateAdGroupCriterionResult
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 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
*
* 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\Targeting;
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\AgeRangeInfo;
use Google\Ads\GoogleAds\V21\Common\GenderInfo;
use Google\Ads\GoogleAds\V21\Enums\AgeRangeTypeEnum\AgeRangeType;
use Google\Ads\GoogleAds\V21\Enums\GenderTypeEnum\GenderType;
use Google\Ads\GoogleAds\V21\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V21\Resources\AdGroupCriterion;
use Google\Ads\GoogleAds\V21\Services\AdGroupCriterionOperation;
use Google\Ads\GoogleAds\V21\Services\MutateAdGroupCriteriaRequest;
use Google\ApiCore\ApiException;
/**
* This example adds demographic target criteria to an ad group, one as positive ad group criterion
* and one as negative ad group criterion. To create ad groups, run AddAdGroups.php.
*/
class AddDemographicTargetingCriteria
{
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 client customer ID
* @param int $adGroupId the ad group ID to add demographic targeting criteria to
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $adGroupId
) {
$adGroupResourceName = ResourceNames::forAdGroup($customerId, $adGroupId);
// Creates a positive ad group criterion for gender.
$genderAdGroupCriterion = new AdGroupCriterion([
'ad_group' => $adGroupResourceName,
// Targets male.
'gender' => new GenderInfo(['type' => GenderType::MALE])
]);
// Creates a negative ad group criterion for age range.
$ageRangeNegativeAdGroupCriterion = new AdGroupCriterion([
'ad_group' => $adGroupResourceName,
// Makes this ad group criterion negative.
'negative' => true,
// Targets the age range of 18 to 24.
'age_range' => new AgeRangeInfo(['type' => AgeRangeType::AGE_RANGE_18_24])
]);
// Creates ad group criterion operations for both ad group criteria.
$operations = [
new AdGroupCriterionOperation(['create' => $genderAdGroupCriterion]),
new AdGroupCriterionOperation(['create' => $ageRangeNegativeAdGroupCriterion])
];
// Issues a mutate request to add the ad group criteria and print out some information.
$adGroupCriterionServiceClient = $googleAdsClient->getAdGroupCriterionServiceClient();
$response = $adGroupCriterionServiceClient->mutateAdGroupCriteria(
MutateAdGroupCriteriaRequest::build($customerId, $operations)
);
printf(
"Added %d demographic ad group criteria:%s",
$response->getResults()->count(),
PHP_EOL
);
foreach ($response->getResults() as $addedAdGroupCriterion) {
/** @var AdGroupCriterion $addedAdGroupCriterion */
print $addedAdGroupCriterion->getResourceName() . PHP_EOL;
}
}
}
AddDemographicTargetingCriteria::main();
Python
#!/usr/bin/env python
# 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
#
# 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 demographic target criteria to an ad group, one as
positive ad group criterion and one as negative ad group criterion. To
create ad groups, run add_ad_groups.py."""
import
argparse
import
sys
from
google.ads.googleads.client
import
GoogleAdsClient
from
google.ads.googleads.errors
import
GoogleAdsException
from
google.ads.googleads.v21.resources.types.ad_group_criterion
import
(
AdGroupCriterion
,
)
from
google.ads.googleads.v21.services.services.ad_group_criterion_service
import
(
AdGroupCriterionServiceClient
,
)
from
google.ads.googleads.v21.services.services.ad_group_service
import
(
AdGroupServiceClient
,
)
from
google.ads.googleads.v21.services.types.ad_group_criterion_service
import
(
AdGroupCriterionOperation
,
MutateAdGroupCriteriaResponse
,
)
def
main
(
client
:
GoogleAdsClient
,
customer_id
:
str
,
ad_group_id
:
str
)
-
> None
:
ad_group_service
:
AdGroupServiceClient
=
client
.
get_service
(
"AdGroupService"
)
ad_group_criterion_service
:
AdGroupCriterionServiceClient
=
(
client
.
get_service
(
"AdGroupCriterionService"
)
)
ad_group_resource_name
:
str
=
ad_group_service
.
ad_group_path
(
customer_id
,
ad_group_id
)
# Create a positive ad group criterion for the gender MALE.
gender_ad_group_criterion_operation
:
AdGroupCriterionOperation
=
(
client
.
get_type
(
"AdGroupCriterionOperation"
)
)
gender_ad_group_criterion
:
AdGroupCriterion
=
(
gender_ad_group_criterion_operation
.
create
)
gender_ad_group_criterion
.
ad_group
=
ad_group_resource_name
gender_ad_group_criterion
.
gender
.
type_
=
client
.
enums
.
GenderTypeEnum
.
MALE
# Create a negative ad group criterion for age range of 18 to 24.
age_range_ad_group_criterion_operation
:
AdGroupCriterionOperation
=
(
client
.
get_type
(
"AdGroupCriterionOperation"
)
)
age_range_ad_group_criterion
:
AdGroupCriterion
=
(
age_range_ad_group_criterion_operation
.
create
)
age_range_ad_group_criterion
.
ad_group
=
ad_group_resource_name
age_range_ad_group_criterion
.
negative
=
True
age_range_ad_group_criterion
.
age_range
.
type_
=
(
client
.
enums
.
AgeRangeTypeEnum
.
AGE_RANGE_18_24
)
# Add two ad group criteria
ad_group_criterion_response
:
MutateAdGroupCriteriaResponse
=
(
ad_group_criterion_service
.
mutate_ad_group_criteria
(
customer_id
=
customer_id
,
operations
=
[
gender_ad_group_criterion_operation
,
age_range_ad_group_criterion_operation
,
],
)
)
for
result
in
ad_group_criterion_response
.
results
:
print
(
f
"Created ad group criterion '
{
result
.
resource_name
}
'."
)
if
__name__
==
"__main__"
:
parser
=
argparse
.
ArgumentParser
(
description
=
(
"Adds demographic targeting criteria to the provided"
" ad group, for the 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
=
True
,
help
=
"The ad group 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
.
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
'
\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
# Encoding: utf-8
#
# Copyright:: 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 code example adds demographic target criteria to an ad group, one as
# positive ad group criterion and one as negative ad group criterion. To create
# ad groups, run add_ad_groups.rb.
require
'optparse'
require
'google/ads/google_ads'
def
add_demographic_targeting_criteria
(
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
ad_group_resource
=
client
.
path
.
ad_group
(
customer_id
,
ad_group_id
)
operations
=
[]
# Create a positive ad group criterion for gender MALE.
operations
<<
client
.
operation
.
create_resource
.
ad_group_criterion
do
|
agc
|
agc
.
ad_group
=
ad_group_resource
agc
.
gender
=
client
.
resource
.
gender_info
do
|
gi
|
gi
.
type
=
:MALE
end
end
# Create a negative ad group criterion for age range of 18 to 24.
operations
<<
client
.
operation
.
create_resource
.
ad_group_criterion
do
|
agc
|
agc
.
ad_group
=
ad_group_resource
agc
.
negative
=
true
agc
.
age_range
=
client
.
resource
.
age_range_info
do
|
ari
|
ari
.
type
=
:AGE_RANGE_18_24
end
end
response
=
client
.
service
.
ad_group_criterion
.
mutate_ad_group_criteria
(
customer_id
:
customer_id
,
operations
:
operations
,
)
response
.
results
.
each
do
|
result
|
puts
"Created ad group criterion '
#{
result
.
resource_name
}
'."
end
end
if
__FILE__
==
$PROGRAM_NAME
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_GOOGLE_ADS_CUSTOMER_ID_HERE'
options
[
:ad_group_id
]
=
'INSERT_AD_GROUP_ID_HERE'
OptionParser
.
new
do
|
opts
|
opts
.
banner
=
sprintf
(
'Usage: ruby %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
,
'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
add_demographic_targeting_criteria
(
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
(
"
\t
On 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
(
"
\t
Type: %s
\n\t
Code: %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 demographic target criteria to an ad group, one as positive
# ad group criterion and one as negative ad group criterion. To create ad groups,
# run add_ad_groups.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::V21::Resources::AdGroupCriterion
;
use
Google::Ads::GoogleAds::V21::Common::GenderInfo
;
use
Google::Ads::GoogleAds::V21::Common::AgeRangeInfo
;
use
Google::Ads::GoogleAds::V21::Enums::GenderTypeEnum
qw(MALE)
;
use
Google::Ads::GoogleAds::V21::Enums::AgeRangeTypeEnum
qw(AGE_RANGE_18_24)
;
use
Google::Ads::GoogleAds::V21::Services::AdGroupCriterionService::AdGroupCriterionOperation
;
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
$ad_group_id
=
"INSERT_AD_GROUP_ID_HERE"
;
sub
add_demographic_targeting_criteria
{
my
(
$api_client
,
$customer_id
,
$ad_group_id
)
=
@_
;
my
$ad_group_resource_name
=
Google::Ads::GoogleAds::V21::Utils::ResourceNames::
ad_group
(
$customer_id
,
$ad_group_id
);
# Create a positive ad group criterion for gender.
my
$gender_ad_group_criterion
=
Google::Ads::GoogleAds::V21::Resources::
AdGroupCriterion
-
> new
({
adGroup
=
>
$ad_group_resource_name
,
# Target male.
gender
=
>
Google::Ads::GoogleAds::V21::Common::
GenderInfo
-
> new
({
type
=
>
MALE
})});
# Create a negative ad group criterion for age range.
my
$age_range_negative_ad_group_criterion
=
Google::Ads::GoogleAds::V21::Resources::
AdGroupCriterion
-
> new
({
adGroup
=
>
$ad_group_resource_name
,
# Make this ad group criterion negative.
negative
=
>
"true"
,
# Target the age range of 18 to 24.
ageRange
=
>
Google::Ads::GoogleAds::V21::Common::
AgeRangeInfo
-
> new
({
type
=
>
AGE_RANGE_18_24
})});
# Create ad group criterion operations for both ad group criteria.
my
$operations
=
[
Google::Ads::GoogleAds::V21::Services::AdGroupCriterionService::
AdGroupCriterionOperation
-
> new
({
create
=
>
$gender_ad_group_criterion
}
),
Google::Ads::GoogleAds::V21::Services::AdGroupCriterionService::
AdGroupCriterionOperation
-
> new
({
create
=
>
$age_range_negative_ad_group_criterion
})];
# Issue a mutate request to add the ad group criteria and print out some information.
my
$ad_group_criteria_response
=
$api_client
-
> AdGroupCriterionService
()
-
> mutate
({
customerId
=
>
$customer_id
,
operations
=
>
$operations
});
my
$ad_group_criterion_results
=
$ad_group_criteria_response
-
> {
results
};
printf
"Added %d demographic ad group criteria:\n"
,
scalar
@$ad_group_criterion_results
;
foreach
my
$ad_group_criterion_result
(
@$ad_group_criterion_results
)
{
printf
"\t%s\n"
,
$ad_group_criterion_result
-
> {
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_demographic_targeting_criteria
(
$api_client
,
$customer_id
=~
s/-//g
r
,
$ad_group_id
);
=pod
=head1 NAME
add_demographic_targeting_criteria
=head1 DESCRIPTION
This example adds demographic target criteria to an ad group, one as positive ad
group criterion and one as negative ad group criterion. To create ad groups, run
add_ad_groups.pl.
=head1 SYNOPSIS
add_demographic_targeting_criteria.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-ad_group_id The ad group 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\u003eThis code demonstrates adding demographic targeting criteria to Google Ads ad groups, specifying both positive and negative targeting.\u003c/p\u003e\n"],["\u003cp\u003eThe process involves creating \u003ccode\u003eAdGroupCriterion\u003c/code\u003e objects to define the demographic (gender or age range) and whether it's a positive or negative target.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAdGroupCriterionOperation\u003c/code\u003e objects are used to create operations, which are then sent to the Google Ads API via \u003ccode\u003emutateAdGroupCriteria\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe provided examples showcase code for Java, C#, PHP, and Python, as well as demonstrate the common core components across them all, such as the use of \u003ccode\u003eAdGroupCriterion\u003c/code\u003e, \u003ccode\u003eGenderInfo\u003c/code\u003e, \u003ccode\u003eAgeRangeInfo\u003c/code\u003e, and \u003ccode\u003eAdGroupCriterionService\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe code requires a Google Ads Client set up, and requires the Ad group and Customer Ids, along with command line arguments, to be able to run.\u003c/p\u003e\n"]]],[],null,[]]
