Add Ad Groups
Stay organized with collections
Save and categorize content based on your preferences.
Java
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package
com.google.ads.googleads.examples.basicoperations
;
import 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.v21.enums.AdGroupStatusEnum.AdGroupStatus
;
import
com.google.ads.googleads.v21.enums.AdGroupTypeEnum.AdGroupType
;
import
com.google.ads.googleads.v21.errors.GoogleAdsError
;
import
com.google.ads.googleads.v21.errors.GoogleAdsException
;
import
com.google.ads.googleads.v21.resources.AdGroup
;
import
com.google.ads.googleads.v21.services.AdGroupOperation
;
import
com.google.ads.googleads.v21.services.AdGroupServiceClient
;
import
com.google.ads.googleads.v21.services.MutateAdGroupResult
;
import
com.google.ads.googleads.v21.services.MutateAdGroupsResponse
;
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 ad groups to a campaign. */
public
class
AddAdGroups
{
private
static
class
AddAdGroupParams
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
)
throws
IOException
{
AddAdGroupParams
params
=
new
AddAdGroupParams
();
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
AddAdGroups
().
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 an ad group, setting an optional CPC value.
AdGroup
adGroup1
=
AdGroup
.
newBuilder
()
.
setName
(
"Earth to Mars Cruises #"
+
getPrintableDateTime
())
.
setStatus
(
AdGroupStatus
.
ENABLED
)
.
setCampaign
(
campaignResourceName
)
.
setType
(
AdGroupType
.
SEARCH_STANDARD
)
.
setCpcBidMicros
(
10_000_000L
)
.
build
();
// You may add as many additional ad groups as you need.
AdGroup
adGroup2
=
AdGroup
.
newBuilder
()
.
setName
(
"Earth to Venus Cruises #"
+
getPrintableDateTime
())
.
setStatus
(
AdGroupStatus
.
ENABLED
)
.
setCampaign
(
campaignResourceName
)
.
setType
(
AdGroupType
.
SEARCH_STANDARD
)
.
setCpcBidMicros
(
10_000_000L
)
.
build
();
List<AdGroupOperation>
operations
=
new
ArrayList
<> ();
operations
.
add
(
AdGroupOperation
.
newBuilder
().
setCreate
(
adGroup1
).
build
());
operations
.
add
(
AdGroupOperation
.
newBuilder
().
setCreate
(
adGroup2
).
build
());
try
(
AdGroupServiceClient
adGroupServiceClient
=
googleAdsClient
.
getLatestVersion
().
createAdGroupServiceClient
())
{
MutateAdGroupsResponse
response
=
adGroupServiceClient
.
mutateAdGroups
(
Long
.
toString
(
customerId
),
operations
);
System
.
out
.
printf
(
"Added %d ad groups:%n"
,
response
.
getResultsCount
());
for
(
MutateAdGroupResult
result
:
response
.
getResultsList
())
{
System
.
out
.
println
(
result
.
getResourceName
());
}
}
}
}
C#
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using
CommandLine
;
using
Google.Ads.Gax.Examples
;
using
Google.Ads.GoogleAds.Lib
;
using
Google.Ads.GoogleAds.V21.Enums
;
using
Google.Ads.GoogleAds.V21.Errors
;
using
Google.Ads.GoogleAds.V21.Resources
;
using
Google.Ads.GoogleAds.V21.Services
;
using
System
;
using
System.Collections.Generic
;
namespace
Google.Ads.GoogleAds.Examples.V21
{
/// <summary>
/// This code example illustrates how to create ad groups. To create campaigns, run
/// AddCampaigns.cs.
/// </summary>
public
class
AddAdGroups
:
ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="AddAdGroups"/> 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 campaign to which ad groups are added.
/// </summary>
[Option("campaignId", Required = true, HelpText =
"ID of the campaign to which ad groups are 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
);
AddAdGroups
codeExample
=
new
AddAdGroups
();
Console
.
WriteLine
(
codeExample
.
Description
);
codeExample
.
Run
(
new
GoogleAdsClient
(),
options
.
CustomerId
,
options
.
CampaignId
);
}
/// <summary>
/// Number of ad groups to create.
/// </summary>
private
const
int
NUM_ADGROUPS_TO_CREATE
=
5
;
/// <summary>
/// Returns a description about the code example.
/// </summary>
public
override
string
Description
=
>
"This code example illustrates how to create ad groups. To create campaigns, run "
+
"AddCampaigns.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="campaignId">ID of the campaign to which ad groups are added.</param>
public
void
Run
(
GoogleAdsClient
client
,
long
customerId
,
long
campaignId
)
{
// Get the AdGroupService.
AdGroupServiceClient
adGroupService
=
client
.
GetService
(
Services
.
V21
.
AdGroupService
);
List<AdGroupOperation>
operations
=
new
List<AdGroupOperation>
();
for
(
int
i
=
0
;
i
<
NUM_ADGROUPS_TO_CREATE
;
i
++
)
{
// Create the ad group.
AdGroup
adGroup
=
new
AdGroup
()
{
Name
=
$"Earth to Mars Cruises #{ExampleUtilities.GetRandomString()}"
,
Status
=
AdGroupStatusEnum
.
Types
.
AdGroupStatus
.
Enabled
,
Campaign
=
ResourceNames
.
Campaign
(
customerId
,
campaignId
),
// Set the ad group bids.
CpcBidMicros
=
10000000
};
// Create the operation.
AdGroupOperation
operation
=
new
AdGroupOperation
()
{
Create
=
adGroup
};
operations
.
Add
(
operation
);
}
try
{
// Create the ad groups.
MutateAdGroupsResponse
response
=
adGroupService
.
MutateAdGroups
(
customerId
.
ToString
(),
operations
);
// Display the results.
foreach
(
MutateAdGroupResult
newAdGroup
in
response
.
Results
)
{
Console
.
WriteLine
(
"Ad group with resource name '{0}' was created."
,
newAdGroup
.
ResourceName
);
}
}
catch
(
GoogleAdsException
e
)
{
Console
.
WriteLine
(
"Failure:"
);
Console
.
WriteLine
(
$"Message: {e.Message}"
);
Console
.
WriteLine
(
$"Failure: {e.Failure}"
);
Console
.
WriteLine
(
$"Request ID: {e.RequestId}"
);
throw
;
}
}
}
}
PHP
< ?php
/**
* Copyright 2018 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace Google\Ads\GoogleAds\Examples\BasicOperations;
require __DIR__ . '/../../vendor/autoload.php';
use GetOpt\GetOpt;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentNames;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentParser;
use Google\Ads\GoogleAds\Examples\Utils\Helper;
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\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Util\V21\ResourceNames;
use Google\Ads\GoogleAds\V21\Enums\AdGroupStatusEnum\AdGroupStatus;
use Google\Ads\GoogleAds\V21\Enums\AdGroupTypeEnum\AdGroupType;
use Google\Ads\GoogleAds\V21\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V21\Resources\AdGroup;
use Google\Ads\GoogleAds\V21\Services\AdGroupOperation;
use Google\Ads\GoogleAds\V21\Services\MutateAdGroupsRequest;
use Google\ApiCore\ApiException;
/** This example adds ad groups to a campaign. */
class AddAdGroups
{
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 to add ad groups to
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $campaignId
) {
$campaignResourceName = ResourceNames::forCampaign($customerId, $campaignId);
$operations = [];
// Constructs an ad group and sets an optional CPC value.
$adGroup1 = new AdGroup([
'name' => 'Earth to Mars Cruises #' . Helper::getPrintableDatetime(),
'campaign' => $campaignResourceName,
'status' => AdGroupStatus::ENABLED,
'type' => AdGroupType::SEARCH_STANDARD,
'cpc_bid_micros' => 10000000
]);
$adGroupOperation1 = new AdGroupOperation();
$adGroupOperation1->setCreate($adGroup1);
$operations[] = $adGroupOperation1;
// Constructs another ad group.
$adGroup2 = new AdGroup([
'name' => 'Earth to Venus Cruises #' . Helper::getPrintableDatetime(),
'campaign' => $campaignResourceName,
'status' => AdGroupStatus::ENABLED,
'type' => AdGroupType::SEARCH_STANDARD,
'cpc_bid_micros' => 20000000
]);
$adGroupOperation2 = new AdGroupOperation();
$adGroupOperation2->setCreate($adGroup2);
$operations[] = $adGroupOperation2;
// Issues a mutate request to add the ad groups.
$adGroupServiceClient = $googleAdsClient->getAdGroupServiceClient();
$response = $adGroupServiceClient->mutateAdGroups(MutateAdGroupsRequest::build(
$customerId,
$operations
));
printf("Added %d ad groups:%s", $response->getResults()->count(), PHP_EOL);
foreach ($response->getResults() as $addedAdGroup) {
/** @var AdGroup $addedAdGroup */
print $addedAdGroup->getResourceName() . PHP_EOL;
}
}
}
AddAdGroups::main();
Python
#!/usr/bin/env python
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""This example adds an ad group.
To get ad groups, run get_ad_groups.py.
"""
import
argparse
import
sys
from
typing
import
List
import
uuid
from
google.ads.googleads.client
import
GoogleAdsClient
from
google.ads.googleads.errors
import
GoogleAdsException
from
google.ads.googleads.v21.services.services.ad_group_service
import
(
AdGroupServiceClient
,
)
from
google.ads.googleads.v21.services.types.ad_group_service
import
(
AdGroupOperation
,
MutateAdGroupsResponse
,
)
from
google.ads.googleads.v21.services.services.campaign_service
import
(
CampaignServiceClient
,
)
from
google.ads.googleads.v21.resources.types.ad_group
import
AdGroup
def
main
(
client
:
GoogleAdsClient
,
customer_id
:
str
,
campaign_id
:
str
)
-
> None
:
ad_group_service
:
AdGroupServiceClient
=
client
.
get_service
(
"AdGroupService"
)
campaign_service
:
CampaignServiceClient
=
client
.
get_service
(
"CampaignService"
)
# Create ad group.
ad_group_operation
:
AdGroupOperation
=
client
.
get_type
(
"AdGroupOperation"
)
ad_group
:
AdGroup
=
ad_group_operation
.
create
ad_group
.
name
=
f
"Earth to Mars cruises
{
uuid
.
uuid4
()
}
"
ad_group
.
status
=
client
.
enums
.
AdGroupStatusEnum
.
ENABLED
ad_group
.
campaign
=
campaign_service
.
campaign_path
(
customer_id
,
campaign_id
)
ad_group
.
type_
=
client
.
enums
.
AdGroupTypeEnum
.
SEARCH_STANDARD
ad_group
.
cpc_bid_micros
=
10000000
operations
:
List
[
AdGroupOperation
]
=
[
ad_group_operation
]
# Add the ad group.
ad_group_response
:
MutateAdGroupsResponse
=
(
ad_group_service
.
mutate_ad_groups
(
customer_id
=
customer_id
,
operations
=
operations
,
)
)
print
(
f
"Created ad group
{
ad_group_response
.
results
[
0
]
.
resource_name
}
."
)
if
__name__
==
"__main__"
:
parser
=
argparse
.
ArgumentParser
(
description
=
"Adds an ad group for specified customer and campaign id."
)
# The following argument(s) should be provided to run the example.
parser
.
add_argument
(
"-c"
,
"--customer_id"
,
type
=
str
,
required
=
True
,
help
=
"The Google Ads customer ID."
,
)
parser
.
add_argument
(
"-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
# Encoding: utf-8
#
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This example adds an ad group. To get ad groups, run get_ad_groups.rb.
require
'optparse'
require
'google/ads/google_ads'
require
'date'
require_relative
'../shared/error_handler.rb'
def
add_ad_groups
(
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
# Create an ad group, setting an optional CPC value.
ad_group
=
client
.
resource
.
ad_group
do
|
ag
|
ag
.
name
=
"Earth to Mars Cruises
#{
(
Time
.
new
.
to_f
*
1000
)
.
to_i
}
"
ag
.
status
=
:ENABLED
ag
.
campaign
=
client
.
path
.
campaign
(
customer_id
,
campaign_id
)
ag
.
type
=
:SEARCH_STANDARD
ag
.
cpc_bid_micros
=
10_000_000
end
# Create the operation
ad_group_operation
=
client
.
operation
.
create_resource
.
ad_group
(
ad_group
)
# Add the ad group.
response
=
client
.
service
.
ad_group
.
mutate_ad_groups
(
customer_id
:
customer_id
,
operations
:
[
ad_group_operation
]
,
)
puts
"Created ad group
#{
response
.
results
.
first
.
resource_name
}
."
end
if
__FILE__
==
$0
options
=
{}
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
options
[
:customer_id
]
=
'INSERT_CUSTOMER_ID_HERE'
options
[
:campaign_id
]
=
'INSERT_CAMPAIGN_ID_HERE'
OptionParser
.
new
do
|
opts
|
opts
.
banner
=
sprintf
(
'Usage: %s [options]'
,
File
.
basename
(
__FILE__
))
opts
.
separator
''
opts
.
separator
'Options:'
opts
.
on
(
'-C'
,
'--customer-id CUSTOMER-ID'
,
String
,
'Customer ID'
)
do
|
v
|
options
[
:customer_id
]
=
v
end
opts
.
on
(
'-c'
,
'--campaign-id CAMPAIGN-ID'
,
String
,
'Campaign ID'
)
do
|
v
|
options
[
:campaign_id
]
=
v
end
opts
.
separator
''
opts
.
separator
'Help:'
opts
.
on_tail
(
'-h'
,
'--help'
,
'Show this message'
)
do
puts
opts
exit
end
end
.
parse!
begin
add_ad_groups
(
options
.
fetch
(
:customer_id
)
.
tr
(
"-"
,
""
),
options
[
:campaign_id
]
)
rescue
Google
::
Ads
::
GoogleAds
::
Errors
::
GoogleAdsError
=
>
e
GoogleAdsErrorHandler
.
handle_google_ads_error
(
e
)
raise
# Re-raise the error to maintain original script behavior.
end
end
Perl
#!/usr/bin/perl -w
#
# Copyright 2019, Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This example adds an ad group. To get ad groups, run get_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::AdGroup
;
use
Google::Ads::GoogleAds::V21::Enums::AdGroupStatusEnum
qw(ENABLED)
;
use
Google::Ads::GoogleAds::V21::Enums::AdGroupTypeEnum
qw(SEARCH_STANDARD)
;
use
Google::Ads::GoogleAds::V21::Services::AdGroupService::AdGroupOperation
;
use
Google::Ads::GoogleAds::V21::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
$campaign_id
=
"INSERT_CAMPAIGN_ID_HERE"
;
sub
add_ad_groups
{
my
(
$api_client
,
$customer_id
,
$campaign_id
)
=
@_
;
# Create an ad group, setting an optional CPC value.
my
$ad_group
=
Google::Ads::GoogleAds::V21::Resources::
AdGroup
-
> new
({
name
=
>
"Earth to Mars Cruises #"
.
uniqid
(),
status
=
>
ENABLED
,
campaign
=
>
Google::Ads::GoogleAds::V21::Utils::ResourceNames::
campaign
(
$customer_id
,
$campaign_id
),
type
=
>
SEARCH_STANDARD
,
cpcBidMicros
=
>
10000000
});
# Create an ad group operation.
my
$ad_group_operation
=
Google::Ads::GoogleAds::V21::Services::AdGroupService::
AdGroupOperation
-
>
new
({
create
=
>
$ad_group
});
# Add the ad group.
my
$ad_groups_response
=
$api_client
-
> AdGroupService
()
-
> mutate
({
customerId
=
>
$customer_id
,
operations
=
>
[
$ad_group_operation
]});
printf
"Created ad group '%s'.\n"
,
$ad_groups_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_ad_groups
(
$api_client
,
$customer_id
=~
s/-//g
r
,
$campaign_id
);
=pod
=head1 NAME
add_ad_groups
=head1 DESCRIPTION
This example adds an ad group. To get ad groups, run get_ad_groups.pl.
=head1 SYNOPSIS
add_ad_groups.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 provided code snippets demonstrate how to add one or more ad groups to an existing Google Ads campaign using the Google Ads API in Java, C#, PHP, and Python.\u003c/p\u003e\n"],["\u003cp\u003eThe core logic involves initializing a client, creating ad group objects, defining operations, sending a mutation request to the API, and handling results and errors.\u003c/p\u003e\n"],["\u003cp\u003eEssential ad group properties like name, status, campaign, type, and bidding are set during creation.\u003c/p\u003e\n"],["\u003cp\u003eYou need to provide your customer ID, campaign ID, and set up authentication before running the code.\u003c/p\u003e\n"],["\u003cp\u003eError handling is implemented to catch and display any issues during the process.\u003c/p\u003e\n"]]],[],null,[]]
