Get Change Details
Stay organized with collections
Save and categorize content based on your preferences.
Java
// Copyright 2021 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.accountmanagement
;
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.lib.utils.FieldMasks
;
import
com.google.ads.googleads.v21.enums.ChangeEventResourceTypeEnum.ChangeEventResourceType
;
import
com.google.ads.googleads.v21.enums.ResourceChangeOperationEnum.ResourceChangeOperation
;
import
com.google.ads.googleads.v21.errors.GoogleAdsError
;
import
com.google.ads.googleads.v21.errors.GoogleAdsException
;
import
com.google.ads.googleads.v21.resources.ChangeEvent
;
import
com.google.ads.googleads.v21.resources.ChangeEvent.ChangedResource
;
import
com.google.ads.googleads.v21.services.GoogleAdsRow
;
import
com.google.ads.googleads.v21.services.GoogleAdsServiceClient
;
import
com.google.ads.googleads.v21.services.GoogleAdsServiceClient.SearchPagedResponse
;
import
com.google.protobuf.Message
;
import
java.io.FileNotFoundException
;
import
java.io.IOException
;
import
java.util.Collections
;
import
java.util.List
;
import
java.util.Optional
;
import
org.joda.time.LocalDate
;
/**
* Gets specific details about the most recent changes in your account, including which field
* changed and the old and new values.
*/
public
class
GetChangeDetails
{
private
static
class
GetChangeDetailsParams
extends
CodeSampleParams
{
@Parameter
(
names
=
ArgumentNames
.
CUSTOMER_ID
,
required
=
true
)
private
Long
customerId
;
}
public
static
void
main
(
String
[]
args
)
{
GetChangeDetailsParams
params
=
new
GetChangeDetailsParams
();
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"
);
}
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
GetChangeDetails
().
runExample
(
googleAdsClient
,
params
.
customerId
);
}
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. */
private
void
runExample
(
GoogleAdsClient
googleAdsClient
,
long
customerId
)
{
// Defines a GAQL query to retrieve change_event instances from the last 14 days.
String
query
=
String
.
format
(
"SELECT"
+
" change_event.resource_name,"
+
" change_event.change_date_time,"
+
" change_event.change_resource_name,"
+
" change_event.user_email,"
+
" change_event.client_type,"
+
" change_event.change_resource_type,"
+
" change_event.old_resource,"
+
" change_event.new_resource,"
+
" change_event.resource_change_operation,"
+
" change_event.changed_fields "
+
"FROM "
+
" change_event "
+
"WHERE "
+
" change_event.change_date_time <= '%s' "
+
" AND change_event.change_date_time >= '%s' "
+
"ORDER BY"
+
" change_event.change_date_time DESC "
+
"LIMIT 5"
,
LocalDate
.
now
().
toString
(
"YYYY-MM-dd"
),
LocalDate
.
now
().
minusDays
(
14
).
toString
(
"YYYY-MM-dd"
));
// Creates a GoogleAdsServiceClient instance.
try
(
GoogleAdsServiceClient
client
=
googleAdsClient
.
getLatestVersion
().
createGoogleAdsServiceClient
())
{
// Issues the search query.
SearchPagedResponse
response
=
client
.
search
(
String
.
valueOf
(
customerId
),
query
);
// Processes the rows of the response.
for
(
GoogleAdsRow
row
:
response
.
iterateAll
())
{
ChangeEvent
event
=
row
.
getChangeEvent
();
// Prints some general information about the change event.
System
.
out
.
printf
(
"On '%s', user '%s' used interface '%s' to perform a(n) '%s' operation on a '%s' with"
+
" resource name '%s'.%n"
,
event
.
getChangeDateTime
(),
event
.
getUserEmail
(),
event
.
getClientType
(),
event
.
getResourceChangeOperation
(),
event
.
getChangeResourceType
(),
event
.
getResourceName
());
// Prints some detailed information about update and create operations.
if
(
event
.
getResourceChangeOperation
()
==
ResourceChangeOperation
.
UPDATE
||
event
.
getResourceChangeOperation
()
==
ResourceChangeOperation
.
CREATE
)
{
// Retrieves the entity that was changed.
Optional<Message>
oldResource
=
getResourceByType
(
event
.
getOldResource
(),
event
.
getChangeResourceType
());
Optional<Message>
newResource
=
getResourceByType
(
event
.
getNewResource
(),
event
.
getChangeResourceType
());
// Prints the old and new values for each field that was updated/created.
for
(
String
changedPath
:
row
.
getChangeEvent
().
getChangedFields
().
getPathsList
())
{
// Uses the FieldMasks utility to retrieve a value from a . delimited path.
List
< ?
extends
Object
>
oldValue
=
oldResource
.
isPresent
()
?
FieldMasks
.
getFieldValue
(
changedPath
,
oldResource
.
get
())
:
Collections
.
emptyList
();
List
< ?
extends
Object
>
newValue
=
newResource
.
isPresent
()
?
FieldMasks
.
getFieldValue
(
changedPath
,
newResource
.
get
())
:
Collections
.
emptyList
();
// Prints different messages for UPDATE and CREATE cases.
if
(
event
.
getResourceChangeOperation
()
==
ResourceChangeOperation
.
UPDATE
)
{
System
.
out
.
printf
(
"\t %s changed from %s to %s.%n"
,
changedPath
,
oldValue
,
newValue
);
}
else
if
(
event
.
getResourceChangeOperation
()
==
ResourceChangeOperation
.
CREATE
)
{
System
.
out
.
printf
(
"\t %s set to %s.%n"
,
changedPath
,
newValue
);
}
}
}
}
}
}
/** Retrieves the resource from a {@link ChangeEvent.ChangedResource} instance. */
private
Optional<Message>
getResourceByType
(
ChangedResource
resource
,
ChangeEventResourceType
type
)
{
switch
(
type
)
{
case
AD
:
return
Optional
.
of
(
resource
.
getAd
());
case
AD_GROUP
:
return
Optional
.
of
(
resource
.
getAdGroup
());
case
AD_GROUP_CRITERION
:
return
Optional
.
of
(
resource
.
getAdGroupCriterion
());
case
AD_GROUP_BID_MODIFIER
:
return
Optional
.
of
(
resource
.
getAdGroupBidModifier
());
case
AD_GROUP_ASSET
:
return
Optional
.
of
(
resource
.
getAdGroupAsset
());
case
ASSET
:
return
Optional
.
of
(
resource
.
getAsset
());
case
ASSET_SET
:
return
Optional
.
of
(
resource
.
getAssetSet
());
case
ASSET_SET_ASSET
:
return
Optional
.
of
(
resource
.
getAssetSetAsset
());
case
CAMPAIGN
:
return
Optional
.
of
(
resource
.
getCampaign
());
case
CAMPAIGN_ASSET
:
return
Optional
.
of
(
resource
.
getCampaignAsset
());
case
CAMPAIGN_ASSET_SET
:
return
Optional
.
of
(
resource
.
getCampaignAssetSet
());
case
CAMPAIGN_BUDGET
:
return
Optional
.
of
(
resource
.
getCampaignBudget
());
case
CAMPAIGN_CRITERION
:
return
Optional
.
of
(
resource
.
getCampaignCriterion
());
case
CUSTOMER_ASSET
:
return
Optional
.
of
(
resource
.
getCustomerAsset
());
default
:
System
.
out
.
println
(
"Unknown entity type: "
+
type
);
return
Optional
.
empty
();
}
}
}
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.Gax.Util
;
using
Google.Ads.GoogleAds.Lib
;
using
Google.Ads.GoogleAds.V21.Errors
;
using
Google.Ads.GoogleAds.V21.Resources
;
using
Google.Ads.GoogleAds.V21.Services
;
using
Google.Protobuf
;
using
System
;
using
System.Collections.Generic
;
using
static
Google
.
Ads
.
GoogleAds
.
V21
.
Enums
.
ChangeEventResourceTypeEnum
.
Types
;
using
static
Google
.
Ads
.
GoogleAds
.
V21
.
Enums
.
ResourceChangeOperationEnum
.
Types
;
using
static
Google
.
Ads
.
GoogleAds
.
V21
.
Resources
.
ChangeEvent
.
Types
;
namespace
Google.Ads.GoogleAds.Examples.V21
{
/// <summary>
/// This code example gets the changes in an account during the last 25 days.
/// </summary>
public
class
GetChangeDetails
:
ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="GetChangeDetails"/> 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>
/// 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
);
GetChangeDetails
codeExample
=
new
GetChangeDetails
();
Console
.
WriteLine
(
codeExample
.
Description
);
codeExample
.
Run
(
new
GoogleAdsClient
(),
options
.
CustomerId
);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public
override
string
Description
=
>
"This code example gets the changes in an account "
+
"during the last 25 days."
;
/// <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>
public
void
Run
(
GoogleAdsClient
client
,
long
customerId
)
{
// Get the GoogleAdsService.
GoogleAdsServiceClient
googleAdsService
=
client
.
GetService
(
Services
.
V21
.
GoogleAdsService
);
// Construct a query to find details for recent changes in your account.
// The LIMIT clause is required for the change_event resource.
// The maximum size is 10000, but a low limit was set here for demonstrative
// purposes.
// The WHERE clause on change_date_time is also required. It must specify a
// window of at most 30 days within the past 30 days.
string
startDate
=
DateTime
.
Today
.
Subtract
(
TimeSpan
.
FromDays
(
25
)).
ToString
(
"yyyyMMdd"
);
string
endDate
=
DateTime
.
Today
.
Add
(
TimeSpan
.
FromDays
(
1
)).
ToString
(
"yyyyMMdd"
);
string
searchQuery
=
$
@"
SELECT
change_event.resource_name,
change_event.change_date_time,
change_event.change_resource_name,
change_event.user_email,
change_event.client_type,
change_event.change_resource_type,
change_event.old_resource,
change_event.new_resource,
change_event.resource_change_operation,
change_event.changed_fields
FROM
change_event
WHERE
change_event.change_date_time >= '{startDate}' AND
change_event.change_date_time <= '{endDate}'
ORDER BY
change_event.change_date_time DESC
LIMIT 5"
;
try
{
// Issue a search request.
googleAdsService
.
SearchStream
(
customerId
.
ToString
(),
searchQuery
,
delegate
(
SearchGoogleAdsStreamResponse
resp
)
{
// Display the results.
foreach
(
GoogleAdsRow
googleAdsRow
in
resp
.
Results
)
{
ChangeEvent
changeEvent
=
googleAdsRow
.
ChangeEvent
;
ChangedResource
oldResource
=
changeEvent
.
OldResource
;
ChangedResource
newResource
=
changeEvent
.
NewResource
;
bool
knownResourceType
=
true
;
IMessage
oldResourceEntity
=
null
;
IMessage
newResourceEntity
=
null
;
switch
(
changeEvent
.
ChangeResourceType
)
{
case
ChangeEventResourceType
.
Ad
:
oldResourceEntity
=
oldResource
.
Ad
;
newResourceEntity
=
newResource
.
Ad
;
break
;
case
ChangeEventResourceType
.
AdGroup
:
oldResourceEntity
=
oldResource
.
AdGroup
;
newResourceEntity
=
newResource
.
AdGroup
;
break
;
case
ChangeEventResourceType
.
AdGroupAd
:
oldResourceEntity
=
oldResource
.
AdGroupAd
;
newResourceEntity
=
newResource
.
AdGroupAd
;
break
;
case
ChangeEventResourceType
.
AdGroupAsset
:
oldResourceEntity
=
oldResource
.
AdGroupAsset
;
newResourceEntity
=
newResource
.
AdGroupAsset
;
break
;
case
ChangeEventResourceType
.
AdGroupBidModifier
:
oldResourceEntity
=
oldResource
.
AdGroupBidModifier
;
newResourceEntity
=
newResource
.
AdGroupBidModifier
;
break
;
case
ChangeEventResourceType
.
AdGroupCriterion
:
oldResourceEntity
=
oldResource
.
AdGroupCriterion
;
newResourceEntity
=
newResource
.
AdGroupCriterion
;
break
;
case
ChangeEventResourceType
.
Asset
:
oldResourceEntity
=
oldResource
.
Asset
;
newResourceEntity
=
newResource
.
Asset
;
break
;
case
ChangeEventResourceType
.
AssetSet
:
oldResourceEntity
=
oldResource
.
AssetSet
;
newResourceEntity
=
newResource
.
AssetSet
;
break
;
case
ChangeEventResourceType
.
AssetSetAsset
:
oldResourceEntity
=
oldResource
.
AssetSetAsset
;
newResourceEntity
=
newResource
.
AssetSetAsset
;
break
;
case
ChangeEventResourceType
.
Campaign
:
oldResourceEntity
=
oldResource
.
Campaign
;
newResourceEntity
=
newResource
.
Campaign
;
break
;
case
ChangeEventResourceType
.
CampaignAsset
:
oldResourceEntity
=
oldResource
.
CampaignAsset
;
newResourceEntity
=
newResource
.
CampaignAsset
;
break
;
case
ChangeEventResourceType
.
CampaignAssetSet
:
oldResourceEntity
=
oldResource
.
CampaignAssetSet
;
newResourceEntity
=
newResource
.
CampaignAssetSet
;
break
;
case
ChangeEventResourceType
.
CampaignBudget
:
oldResourceEntity
=
oldResource
.
CampaignBudget
;
newResourceEntity
=
newResource
.
CampaignBudget
;
break
;
case
ChangeEventResourceType
.
CampaignCriterion
:
oldResourceEntity
=
oldResource
.
CampaignCriterion
;
newResourceEntity
=
newResource
.
CampaignCriterion
;
break
;
case
ChangeEventResourceType
.
CustomerAsset
:
oldResourceEntity
=
oldResource
.
CustomerAsset
;
newResourceEntity
=
newResource
.
CustomerAsset
;
break
;
default
:
knownResourceType
=
false
;
break
;
}
if
(
!
knownResourceType
)
{
Console
.
WriteLine
(
$"Unknown change_resource_type "
+
$"'{changeEvent.ChangeResourceType}'."
);
continue
;
}
Console
.
WriteLine
(
$"On #{changeEvent.ChangeDateTime}, user "
+
$"{changeEvent.UserEmail} used interface {changeEvent.ClientType} "
+
$"to perform a(n) '{changeEvent.ResourceChangeOperation}' "
+
$"operation on a '{changeEvent.ChangeResourceType}' with "
+
$"resource name {changeEvent.ChangeResourceName}."
);
foreach
(
string
fieldMaskPath
in
changeEvent
.
ChangedFields
.
Paths
)
{
if
(
changeEvent
.
ResourceChangeOperation
==
ResourceChangeOperation
.
Create
)
{
object
newValue
=
FieldMasks
.
GetFieldValue
(
fieldMaskPath
,
newResourceEntity
);
Console
.
WriteLine
(
$"\t{fieldMaskPath} set to '{newValue}'."
);
}
else
if
(
changeEvent
.
ResourceChangeOperation
==
ResourceChangeOperation
.
Update
)
{
object
oldValue
=
FieldMasks
.
GetFieldValue
(
fieldMaskPath
,
oldResourceEntity
);
object
newValue
=
FieldMasks
.
GetFieldValue
(
fieldMaskPath
,
newResourceEntity
);
Console
.
WriteLine
(
$"\t{fieldMaskPath} changed from "
+
$"'{oldValue}' to '{newValue}'."
);
}
}
}
});
}
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\AccountManagement;
require __DIR__ . '/../../vendor/autoload.php';
use DateTime;
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\FieldMasks;
use Google\Ads\GoogleAds\V21\Enums\ChangeClientTypeEnum\ChangeClientType;
use Google\Ads\GoogleAds\V21\Enums\ChangeEventResourceTypeEnum\ChangeEventResourceType;
use Google\Ads\GoogleAds\V21\Enums\ResourceChangeOperationEnum\ResourceChangeOperation;
use Google\Ads\GoogleAds\V21\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V21\Services\GoogleAdsRow;
use Google\Ads\GoogleAds\V21\Services\SearchGoogleAdsRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\Internal\Message;
use Google\Protobuf\Internal\RepeatedField;
/**
* This example gets specific details about the most recent changes in your
* account, including which field changed and the old and new values.
*/
class GetChangeDetails
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_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
]);
// 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
);
} 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
*/
public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
// Constructs a query to find details for recent changes in your account.
// The LIMIT clause is required for the change_event resource.
// The maximum size is 10000, but a low limit was set here for demonstrative
// purposes.
// The WHERE clause on change_date_time is also required. It must specify a
// window of at most 30 days within the past 30 days.
$query = 'SELECT change_event.resource_name, '
. 'change_event.change_date_time, '
. 'change_event.change_resource_name, '
. 'change_event.user_email, '
. 'change_event.client_type, '
. 'change_event.change_resource_type, '
. 'change_event.old_resource, '
. 'change_event.new_resource, '
. 'change_event.resource_change_operation, '
. 'change_event.changed_fields '
. 'FROM change_event '
. sprintf(
'WHERE change_event.change_date_time <= %s ',
date_format(new DateTime('+1 day'), 'Ymd')
) . sprintf(
'AND change_event.change_date_time >= %s ',
date_format(new DateTime('-14 days'), 'Ymd')
) . 'ORDER BY change_event.change_date_time DESC '
. 'LIMIT 5';
// Issues a search request.
$response =
$googleAdsServiceClient->search(SearchGoogleAdsRequest::build($customerId, $query));
// Iterates over all rows in all pages and prints the requested field values for
// the change event in each row.
foreach ($response->iterateAllElements() as $googleAdsRow) {
/** @var GoogleAdsRow $googleAdsRow */
$changeEvent = $googleAdsRow->getChangeEvent();
$oldResource = $changeEvent->getOldResource();
$newResource = $changeEvent->getNewResource();
$isResourceTypeKnown = true;
$oldResourceEntity = null;
$newResourceEntity = null;
switch ($changeEvent->getChangeResourceType()) {
case ChangeEventResourceType::AD:
$oldResourceEntity = $oldResource->getAd();
$newResourceEntity = $newResource->getAd();
break;
case ChangeEventResourceType::AD_GROUP:
$oldResourceEntity = $oldResource->getAdGroup();
$newResourceEntity = $newResource->getAdGroup();
break;
case ChangeEventResourceType::AD_GROUP_AD:
$oldResourceEntity = $oldResource->getAdGroupAd();
$newResourceEntity = $newResource->getAdGroupAd();
break;
case ChangeEventResourceType::AD_GROUP_ASSET:
$oldResourceEntity = $oldResource->getAdGroupAsset();
$newResourceEntity = $newResource->getAdGroupAsset();
break;
case ChangeEventResourceType::AD_GROUP_CRITERION:
$oldResourceEntity = $oldResource->getAdGroupCriterion();
$newResourceEntity = $newResource->getAdGroupCriterion();
break;
case ChangeEventResourceType::AD_GROUP_BID_MODIFIER:
$oldResourceEntity = $oldResource->getAdGroupBidModifier();
$newResourceEntity = $newResource->getAdGroupBidModifier();
break;
case ChangeEventResourceType::ASSET:
$oldResourceEntity = $oldResource->getAsset();
$newResourceEntity = $newResource->getAsset();
break;
case ChangeEventResourceType::ASSET_SET:
$oldResourceEntity = $oldResource->getAssetSet();
$newResourceEntity = $newResource->getAssetSet();
break;
case ChangeEventResourceType::ASSET_SET_ASSET:
$oldResourceEntity = $oldResource->getAssetSetAsset();
$newResourceEntity = $newResource->getAssetSetAsset();
break;
case ChangeEventResourceType::CAMPAIGN:
$oldResourceEntity = $oldResource->getCampaign();
$newResourceEntity = $newResource->getCampaign();
break;
case ChangeEventResourceType::CAMPAIGN_ASSET:
$oldResourceEntity = $oldResource->getCampaignAsset();
$newResourceEntity = $newResource->getCampaignAsset();
break;
case ChangeEventResourceType::CAMPAIGN_ASSET_SET:
$oldResourceEntity = $oldResource->getCampaignAssetSet();
$newResourceEntity = $newResource->getCampaignAssetSet();
break;
case ChangeEventResourceType::CAMPAIGN_BUDGET:
$oldResourceEntity = $oldResource->getCampaignBudget();
$newResourceEntity = $newResource->getCampaignBudget();
break;
case ChangeEventResourceType::CAMPAIGN_CRITERION:
$oldResourceEntity = $oldResource->getCampaignCriterion();
$newResourceEntity = $newResource->getCampaignCriterion();
break;
case ChangeEventResourceType::CUSTOMER_ASSET:
$oldResourceEntity = $oldResource->getCustomerAsset();
$newResourceEntity = $newResource->getCustomerAsset();
break;
default:
$isResourceTypeKnown = false;
break;
}
if (!$isResourceTypeKnown) {
printf(
"Unknown change_resource_type %s.%s",
ChangeEventResourceType::name($changeEvent->getChangeResourceType()),
PHP_EOL
);
}
$resourceChangeOperation = $changeEvent->getResourceChangeOperation();
printf(
"On %s, user '%s' used interface '%s' to perform a(n) '%s' operation on a '%s' "
. "with resource name '%s'.%s",
$changeEvent->getChangeDateTime(),
$changeEvent->getUserEmail(),
ChangeClientType::name($changeEvent->getClientType()),
ResourceChangeOperation::name($resourceChangeOperation),
ChangeEventResourceType::name($changeEvent->getChangeResourceType()),
$changeEvent->getChangeResourceName(),
PHP_EOL
);
if (
$resourceChangeOperation !== ResourceChangeOperation::CREATE
&& $resourceChangeOperation !== ResourceChangeOperation::UPDATE
) {
continue;
}
foreach ($changeEvent->getChangedFields()->getPaths() as $path) {
$newValueStr = self::convertToString(
FieldMasks::getFieldValue($path, $newResourceEntity, true)
);
if ($resourceChangeOperation === ResourceChangeOperation::CREATE) {
printf("\t'$path' set to '%s'.%s", $newValueStr, PHP_EOL);
} elseif ($resourceChangeOperation === ResourceChangeOperation::UPDATE) {
printf(
"\t'$path' changed from '%s' to '%s'.%s",
self::convertToString(
FieldMasks::getFieldValue($path, $oldResourceEntity, true)
),
$newValueStr,
PHP_EOL
);
}
}
}
}
/**
* Converts the specified value to string.
*
* @param mixed $value the value to be converted to string
* @return string the value in string
*/
private static function convertToString($value)
{
if (is_null($value)) {
return 'no value';
}
if (gettype($value) === 'boolean') {
return $value ? 'true' : 'false';
} elseif (gettype($value) === 'object') {
if (get_class($value) === RepeatedField::class) {
$strValues = [];
foreach (iterator_to_array($value->getIterator()) as $element) {
/** @type Message $element */
$strValues[] = $element->serializeToJsonString();
}
return '[' . implode(',', $strValues) . ']';
}
return json_encode($value);
} else {
return strval($value);
}
}
}
GetChangeDetails::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.
"""Gets specific details about the most recent changes in the given account.
Changes include the name of the field that changed, and both the old and new
values.
"""
import
argparse
from
datetime
import
datetime
,
timedelta
import
sys
from
typing
import
Any
from
proto.enums
import
ProtoEnumMeta
from
google.ads.googleads.client
import
GoogleAdsClient
from
google.ads.googleads.errors
import
GoogleAdsException
from
google.ads.googleads.util
import
get_nested_attr
from
google.ads.googleads.v21.services.services.google_ads_service.client
import
(
GoogleAdsServiceClient
,
)
from
google.ads.googleads.v21.services.types.google_ads_service
import
(
SearchGoogleAdsRequest
,
SearchPagedResponse
,
GoogleAdsRow
,
)
from
google.ads.googleads.v21.resources.types.change_event
import
ChangeEvent
def
main
(
client
:
GoogleAdsClient
,
customer_id
:
str
)
-
> None
:
"""Gets specific details about the most recent changes in the given account.
Args:
client: The Google Ads client.
customer_id: The Google Ads customer ID.
"""
googleads_service
:
GoogleAdsServiceClient
=
client
.
get_service
(
"GoogleAdsService"
)
# Construct a query to find details for recent changes in your account.
# The LIMIT clause is required for the change_event resource.
# The maximum size is 10000, but a low limit was set here for demonstrative
# purposes. For more information see:
# https://developers.google.com/google-ads/api/docs/change-event#getting_changes
# The WHERE clause on change_date_time is also required. It must specify a
# window within the past 30 days.
tomorrow
:
str
=
(
datetime
.
now
()
+
timedelta
(
1
))
.
strftime
(
"%Y-%m-
%d
"
)
two_weeks_ago
:
str
=
(
datetime
.
now
()
+
timedelta
(
-
14
))
.
strftime
(
"%Y-%m-
%d
"
)
query
:
str
=
f
"""
SELECT
change_event.resource_name,
change_event.change_date_time,
change_event.change_resource_name,
change_event.user_email,
change_event.client_type,
change_event.change_resource_type,
change_event.old_resource,
change_event.new_resource,
change_event.resource_change_operation,
change_event.changed_fields
FROM change_event
WHERE change_event.change_date_time <= '
{
tomorrow
}
'
AND change_event.change_date_time >= '
{
two_weeks_ago
}
'
ORDER BY change_event.change_date_time DESC
LIMIT 5"""
search_request
:
SearchGoogleAdsRequest
=
client
.
get_type
(
"SearchGoogleAdsRequest"
)
search_request
.
customer_id
=
customer_id
search_request
.
query
=
query
results
:
SearchPagedResponse
=
googleads_service
.
search
(
request
=
search_request
)
row
:
GoogleAdsRow
for
row
in
results
:
event
:
ChangeEvent
=
row
.
change_event
resource_type
:
str
=
event
.
change_resource_type
.
name
old_resource
:
Any
new_resource
:
Any
if
resource_type
==
"AD"
:
old_resource
=
event
.
old_resource
.
ad
new_resource
=
event
.
new_resource
.
ad
elif
resource_type
==
"AD_GROUP"
:
old_resource
=
event
.
old_resource
.
ad_group
new_resource
=
event
.
new_resource
.
ad_group
elif
resource_type
==
"AD_GROUP_AD"
:
old_resource
=
event
.
old_resource
.
ad_group_ad
new_resource
=
event
.
new_resource
.
ad_group_ad
elif
resource_type
==
"AD_GROUP_ASSET"
:
old_resource
=
event
.
old_resource
.
ad_group_asset
new_resource
=
event
.
new_resource
.
ad_group_asset
elif
resource_type
==
"AD_GROUP_CRITERION"
:
old_resource
=
event
.
old_resource
.
ad_group_criterion
new_resource
=
event
.
new_resource
.
ad_group_criterion
elif
resource_type
==
"AD_GROUP_BID_MODIFIER"
:
old_resource
=
event
.
old_resource
.
ad_group_bid_modifier
new_resource
=
event
.
new_resource
.
ad_group_bid_modifier
elif
resource_type
==
"AD_GROUP_FEED"
:
old_resource
=
event
.
old_resource
.
ad_group_feed
new_resource
=
event
.
new_resource
.
ad_group_feed
elif
resource_type
==
"ASSET"
:
old_resource
=
event
.
old_resource
.
asset
new_resource
=
event
.
new_resource
.
asset
elif
resource_type
==
"ASSET_SET"
:
old_resource
=
event
.
old_resource
.
asset_set
new_resource
=
event
.
new_resource
.
asset_set
elif
resource_type
==
"ASSET_SET_ASSET"
:
old_resource
=
event
.
old_resource
.
asset_set_asset
new_resource
=
event
.
new_resource
.
asset_set_asset
elif
resource_type
==
"CAMPAIGN"
:
old_resource
=
event
.
old_resource
.
campaign
new_resource
=
event
.
new_resource
.
campaign
elif
resource_type
==
"CAMPAIGN_ASSET"
:
old_resource
=
event
.
old_resource
.
campaign_asset
new_resource
=
event
.
new_resource
.
campaign_asset
elif
resource_type
==
"CAMPAIGN_ASSET_SET"
:
old_resource
=
event
.
old_resource
.
campaign_asset_set
new_resource
=
event
.
new_resource
.
campaign_asset_set
elif
resource_type
==
"CAMPAIGN_BUDGET"
:
old_resource
=
event
.
old_resource
.
campaign_budget
new_resource
=
event
.
new_resource
.
campaign_budget
elif
resource_type
==
"CAMPAIGN_CRITERION"
:
old_resource
=
event
.
old_resource
.
campaign_criterion
new_resource
=
event
.
new_resource
.
campaign_criterion
elif
resource_type
==
"CAMPAIGN_FEED"
:
old_resource
=
event
.
old_resource
.
campaign_feed
new_resource
=
event
.
new_resource
.
campaign_feed
elif
resource_type
==
"CUSTOMER_ASSET"
:
old_resource
=
event
.
old_resource
.
customer_asset
new_resource
=
event
.
new_resource
.
customer_asset
elif
resource_type
==
"FEED"
:
old_resource
=
event
.
old_resource
.
feed
new_resource
=
event
.
new_resource
.
feed
elif
resource_type
==
"FEED_ITEM"
:
old_resource
=
event
.
old_resource
.
feed_item
new_resource
=
event
.
new_resource
.
feed_item
else
:
print
(
"Unknown change_resource_type: '
{event.change_resource_type}
'"
)
# If the resource type is unrecognized then we continue to
# the next row.
continue
print
(
f
"On
{
event
.
change_date_time
}
, user
{
event
.
user_email
}
"
f
"used interface
{
event
.
client_type
.
name
}
to perform a(n) "
f
"
{
event
.
resource_change_operation
.
name
}
operation on a "
f
"
{
event
.
change_resource_type
.
name
}
with resource name "
f
"'
{
event
.
change_resource_name
}
'"
)
operation_type
:
str
=
event
.
resource_change_operation
.
name
if
operation_type
in
(
"UPDATE"
,
"CREATE"
):
for
changed_field_path
in
event
.
changed_fields
.
paths
:
changed_field
:
str
=
changed_field_path
# Change field name from "type" to "type_" so that it doesn't
# raise an exception when accessed on the protobuf object, see:
# https://developers.google.com/google-ads/api/docs/client-libs/python/library-version-10#field_names_that_are_reserved_words
if
changed_field
==
"type"
:
changed_field
=
"type_"
new_value
:
Any
=
get_nested_attr
(
new_resource
,
changed_field
)
# If the field value is an Enum get the human readable name
# so that it is printed instead of the field ID integer.
if
isinstance
(
type
(
new_value
),
ProtoEnumMeta
):
new_value
=
new_value
.
name
if
operation_type
==
"CREATE"
:
print
(
f
"
\t
{
changed_field
}
set to
{
new_value
}
"
)
else
:
old_value
:
Any
=
get_nested_attr
(
old_resource
,
changed_field
)
# If the field value is an Enum get the human readable name
# so that it is printed instead of the field ID integer.
if
isinstance
(
type
(
old_value
),
ProtoEnumMeta
):
old_value
=
old_value
.
name
print
(
f
"
\t
{
changed_field
}
changed from
{
old_value
}
to
{
new_value
}
"
)
if
__name__
==
"__main__"
:
parser
=
argparse
.
ArgumentParser
(
description
=
"This example gets specific details about the most recent "
"changes in the given account."
)
# 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."
,
)
args
=
parser
.
parse_args
()
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client
=
GoogleAdsClient
.
load_from_storage
(
version
=
"v21"
)
try
:
main
(
googleads_client
,
args
.
customer_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 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 gets specific details about the most recent changes in your
# account, including which field changed and the old and new values.
require
'optparse'
require
'date'
require
'google/ads/google_ads'
def
get_change_details
(
customer_id
)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client
=
Google
::
Ads
::
GoogleAds
::
GoogleAdsClient
.
new
# Construct a query to find details for recent changes in your account.
# The LIMIT clause is required for the change_event resource.
# The maximum size is 10000, but a low limit was set here for demonstrative
# purposes.
# The WHERE clause on change_date_time is also required. It must specify a
# window of at most 30 days within the past 30 days.
query
=
<< ~
QUERY
SELECT
change_event
.
resource_name
,
change_event
.
change_date_time
,
change_event
.
change_resource_name
,
change_event
.
user_email
,
change_event
.
client_type
,
change_event
.
change_resource_type
,
change_event
.
old_resource
,
change_event
.
new_resource
,
change_event
.
resource_change_operation
,
change_event
.
changed_fields
FROM
change_event
WHERE
change_event
.
change_date_time
< =
'
#{
(
Date
.
today
+
1
)
.
to_s
}
'
AND
change_event
.
change_date_time
> =
'
#{
(
Date
.
today
-
14
)
.
to_s
}
'
ORDER
BY
change_event
.
change_date_time
DESC
LIMIT
5
QUERY
# Execute the query to fetch results from the API.
response
=
client
.
service
.
google_ads
.
search
(
customer_id
:
customer_id
,
query
:
query
,
)
# Process the results and output changes.
response
.
each
do
|
row
|
event
=
row
.
change_event
old_resource
,
new_resource
=
case
event
.
change_resource_type
when
:AD
[
event
.
old_resource
.
ad
,
event
.
new_resource
.
ad
]
when
:AD_GROUP
[
event
.
old_resource
.
ad_group
,
event
.
new_resource
.
ad_group
]
when
:AD_GROUP_AD
[
event
.
old_resource
.
ad_group_ad
,
event
.
new_resource
.
ad_group_ad
]
when
:AD_GROUP_ASSET
[
event
.
old_resource
.
ad_group_asset
,
event
.
new_resource
.
ad_group_asset
]
when
:AD_GROUP_CRITERION
[
event
.
old_resource
.
ad_group_criterion
,
event
.
new_resource
.
ad_group_criterion
]
when
:AD_GROUP_BID_MODIFIER
[
event
.
old_resource
.
ad_group_bid_modifier
,
event
.
new_resource
.
ad_group_bid_modifier
]
when
:ASSET
[
event
.
old_resource
.
asset
,
event
.
new_resource
.
asset
]
when
:ASSET_SET
[
event
.
old_resource
.
asset_set
,
event
.
new_resource
.
asset_set
]
when
:ASSET_SET_ASSET
[
event
.
old_resource
.
asset_set_asset
,
event
.
new_resource
.
asset_set_asset
]
when
:CAMPAIGN
[
event
.
old_resource
.
campaign
,
event
.
new_resource
.
campaign
]
when
:CAMPAIGN_ASSET
[
event
.
old_resource
.
campaign_asset
,
event
.
new_resource
.
campaign_asset
]
when
:CAMPAIGN_ASSET_SET
[
event
.
old_resource
.
campaign_asset_set
,
event
.
new_resource
.
campaign_asset_set
]
when
:CAMPAIGN_BUDGET
[
event
.
old_resource
.
campaign_budget
,
event
.
new_resource
.
campaign_budget
]
when
:CAMPAIGN_CRITERION
[
event
.
old_resource
.
campaign_criterion
,
event
.
new_resource
.
campaign_criterion
]
when
:ASSET
[
event
.
old_resource
.
asset
,
event
.
new_resource
.
asset
]
when
:CUSTOMER_ASSET
[
event
.
old_resource
.
customer_asset
,
event
.
new_resource
.
customer_asset
]
else
puts
"Unknown change_resource_type
#{
event
.
change_resource_type
}
."
next
end
puts
"On
#{
event
.
change_date_time
}
, user
#{
event
.
user_email
}
used interface "
\
"
#{
event
.
client_type
}
to perform a(n)
#{
event
.
resource_change_operation
}
"
\
"operation on a
#{
event
.
change_resource_type
}
with resource name "
\
"
#{
event
.
change_resource_name
}
."
if
[
:UPDATE
,
:CREATE
].
include?
event
.
resource_change_operation
event
.
changed_fields
.
paths
.
each
do
|
changed_field
|
new_value
=
get_value_from_path
(
changed_field
,
new_resource
)
if
:CREATE
==
event
.
resource_change_operation
puts
"
\t
#{
changed_field
}
set to '
#{
new_value
}
'."
else
old_value
=
get_value_from_path
(
changed_field
,
old_resource
)
puts
"
\t
#{
changed_field
}
changed from '
#{
old_value
}
' to '
#{
new_value
}
'."
end
end
end
end
end
# Given the string value of a path from the response, look up the value of the
# field located at that path on the given object.
def
get_value_from_path
(
path
,
object
)
path
.
split
(
"."
)
.
inject
(
object
)
{
|
obj
,
key
|
obj
.
send
(
key
)}
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_CUSTOMER_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
.
separator
''
opts
.
separator
'Help:'
opts
.
on_tail
(
'-h'
,
'--help'
,
'Show this message'
)
do
puts
opts
exit
end
end
.
parse!
begin
get_change_details
(
options
.
fetch
(
:customer_id
)
.
tr
(
"-"
,
""
))
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 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.
#
# This example gets specific details about the most recent changes in your
# account, including which field changed and the old and new values.
use
strict
;
use
warnings
;
use
utf8
;
use
FindBin
qw($Bin)
;
use
lib
"$Bin/../../lib"
;
use
Google::Ads::GoogleAds::Client
;
use
Google::Ads::GoogleAds::Utils::GoogleAdsHelper
;
use
Google::Ads::GoogleAds::Utils::SearchGoogleAdsIterator
;
use
Google::Ads::GoogleAds::Utils::FieldMasks
;
use
Google::Ads::GoogleAds::V21::Enums::ResourceChangeOperationEnum
qw(CREATE UPDATE)
;
use
Google::Ads::GoogleAds::V21::Enums::ChangeEventResourceTypeEnum
qw(AD AD_GROUP AD_GROUP_AD AD_GROUP_ASSET AD_GROUP_CRITERION AD_GROUP_BID_MODIFIER ASSET ASSET_SET ASSET_SET_ASSET CAMPAIGN CAMPAIGN_ASSET CAMPAIGN_ASSET_SET CAMPAIGN_BUDGET CAMPAIGN_CRITERION CUSTOMER_ASSET)
;
use
Google::Ads::GoogleAds::V21::Services::GoogleAdsService::SearchGoogleAdsRequest
;
use
Getopt::Long
qw(:config auto_help)
;
use
JSON::XS
;
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"
;
sub
get_change_details
{
my
(
$api_client
,
$customer_id
)
=
@_
;
# Construct a query to find details for recent changes in your account.
# The LIMIT clause is required for the change_event resource.
# The maximum size is 10000, but a low limit was set here for demonstrative
# purposes.
# The WHERE clause on change_date_time is also required. It must specify a
# window of at most 30 days within the past 30 days.
my
$search_query
=
"SELECT change_event.resource_name, change_event.change_date_time, "
.
"change_event.change_resource_name, change_event.user_email, "
.
"change_event.client_type, change_event.change_resource_type, "
.
"change_event.old_resource, change_event.new_resource, "
.
"change_event.resource_change_operation, change_event.changed_fields "
.
"FROM change_event "
.
"WHERE change_event.change_date_time DURING LAST_14_DAYS "
.
"ORDER BY change_event.change_date_time DESC LIMIT 5"
;
# Create a search Google Ads request that will retrieve all change events using
# pages of the specified page size.
my
$search_request
=
Google::Ads::GoogleAds::V21::Services::GoogleAdsService::
SearchGoogleAdsRequest
-
> new
({
customerId
=
>
$customer_id
,
query
=
>
$search_query
});
# Get the GoogleAdsService.
my
$google_ads_service
=
$api_client
-
> GoogleAdsService
();
my
$iterator
=
Google::Ads::GoogleAds::Utils::
SearchGoogleAdsIterator
-
> new
({
service
=
>
$google_ads_service
,
request
=
>
$search_request
});
# Iterate over all rows in all pages and print the requested field values for
# the change event in each row.
while
(
$iterator
-
> has_next
)
{
my
$google_ads_row
=
$iterator
-
> next
;
my
$change_event
=
$google_ads_row
-
> {
changeEvent
};
printf
"On %s, user %s used interface %s to perform a(n) %s operation "
.
"on a %s with resource name '%s'.\n"
,
$change_event
-
> {
changeDateTime
},
$change_event
-
> {
userEmail
},
$change_event
-
> {
clientType
},
$change_event
-
> {
resourceChangeOperation
},
$change_event
-
> {
changeResourceType
},
$change_event
-
> {
changeResourceName
};
if
(
grep
/$change_event->{resourceChangeOperation}/
,
(
CREATE
,
UPDATE
))
{
my
(
$old_resource
,
$new_resource
)
=
_get_changed_resources_for_resource_type
(
$change_event
);
foreach
my
$changed_field
(
split
/,/
,
$change_event
-
> {
changedFields
})
{
my
$new_value
=
_convert_to_string
(
get_field_value
(
$new_resource
,
$changed_field
))
||
""
;
if
(
$change_event
-
> {
resourceChangeOperation
}
eq
CREATE
)
{
print
"\t$changed_field set to '$new_value'.\n"
;
}
else
{
my
$old_value
=
_convert_to_string
(
get_field_value
(
$old_resource
,
$changed_field
))
||
""
;
print
"\t$changed_field changed from '$old_value' to '$new_value'.\n"
;
}
}
}
}
return
1
;
}
# This method converts the specified value to a string.
sub
_convert_to_string
{
my
$value
=
shift
;
my
$string_value
=
""
;
if
(
ref
(
$value
)
eq
"ARRAY"
)
{
$string_value
.=
"["
;
foreach
my
$item
(
@$value
)
{
if
(
is_hash_ref
(
$item
))
{
$string_value
.=
(
JSON::
XS
-
> new
-
> utf8
-
> encode
(
$item
)
.
","
);
}
else
{
$string_value
.=
(
$item
.
","
);
}
}
$string_value
.=
"]"
;
}
elsif
(
is_hash_ref
(
$value
))
{
$string_value
.=
JSON::
XS
-
> new
-
> utf8
-
> encode
(
$value
);
}
else
{
$string_value
=
$value
;
}
return
$string_value
;
}
# This method returns the old resource and new resource based on the change
# resource type of a change event.
sub
_get_changed_resources_for_resource_type
{
my
$change_event
=
shift
;
my
$resource_type
=
$change_event
-
> {
changeResourceType
};
if
(
$resource_type
eq
AD
)
{
return
$change_event
-
> {
oldResource
}{
ad
},
$change_event
-
> {
newResource
}{
ad
};
}
elsif
(
$resource_type
eq
AD_GROUP
)
{
return
$change_event
-
> {
oldResource
}{
adGroup
},
$change_event
-
> {
newResource
}{
adGroup
};
}
elsif
(
$resource_type
eq
AD_GROUP_AD
)
{
return
$change_event
-
> {
oldResource
}{
adGroupAd
},
$change_event
-
> {
newResource
}{
adGroupAd
};
}
elsif
(
$resource_type
eq
AD_GROUP_ASSET
)
{
return
$change_event
-
> {
oldResource
}{
adGroupAsset
},
$change_event
-
> {
newResource
}{
adGroupAsset
};
}
elsif
(
$resource_type
eq
AD_GROUP_CRITERION
)
{
return
$change_event
-
> {
oldResource
}{
adGroupCriterion
},
$change_event
-
> {
newResource
}{
adGroupCriterion
};
}
elsif
(
$resource_type
eq
AD_GROUP_BID_MODIFIER
)
{
return
$change_event
-
> {
oldResource
}{
adGroupBidModifier
},
$change_event
-
> {
newResource
}{
adGroupBidModifier
};
}
elsif
(
$resource_type
eq
ASSET
)
{
return
$change_event
-
> {
oldResource
}{
asset
},
$change_event
-
> {
newResource
}{
asset
};
}
elsif
(
$resource_type
eq
ASSET_SET
)
{
return
$change_event
-
> {
oldResource
}{
assetSet
},
$change_event
-
> {
newResource
}{
assetSet
};
}
elsif
(
$resource_type
eq
ASSET_SET_ASSET
)
{
return
$change_event
-
> {
oldResource
}{
assetSetAsset
},
$change_event
-
> {
newResource
}{
assetSetAsset
};
}
elsif
(
$resource_type
eq
CAMPAIGN
)
{
return
$change_event
-
> {
oldResource
}{
campaign
},
$change_event
-
> {
newResource
}{
campaign
};
}
elsif
(
$resource_type
eq
CAMPAIGN_ASSET
)
{
return
$change_event
-
> {
oldResource
}{
campaignAsset
},
$change_event
-
> {
newResource
}{
campaignAsset
};
}
elsif
(
$resource_type
eq
CAMPAIGN_ASSET_SET
)
{
return
$change_event
-
> {
oldResource
}{
campaignAssetSet
},
$change_event
-
> {
newResource
}{
campaignAssetSet
};
}
elsif
(
$resource_type
eq
CAMPAIGN_BUDGET
)
{
return
$change_event
-
> {
oldResource
}{
campaignBudget
},
$change_event
-
> {
newResource
}{
campaignBudget
};
}
elsif
(
$resource_type
eq
CAMPAIGN_CRITERION
)
{
return
$change_event
-
> {
oldResource
}{
campaignCriterion
},
$change_event
-
> {
newResource
}{
campaignCriterion
};
}
elsif
(
$resource_type
eq
CUSTOMER_ASSET
)
{
return
$change_event
-
> {
oldResource
}{
customerAsset
},
$change_event
-
> {
newResource
}{
customerAsset
};
}
else
{
print
"Unknown change_resource_type $resource_type.\n"
;
}
}
# 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
);
# Print the help message if the parameters are not initialized in the code nor
# in the command line.
pod2usage
(
2
)
if
not
check_params
(
$customer_id
);
# Call the example.
get_change_details
(
$api_client
,
$customer_id
=~
s/-//g
r
);
=pod
=head1 NAME
get_change_details
=head1 DESCRIPTION
This example gets specific details about the most recent changes in your
account, including which field changed and the old and new values.
=head1 SYNOPSIS
get_change_details.pl [options]
-help Show the help message.
-customer_id The Google Ads customer 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 examples demonstrate how to retrieve and display recent change details within a Google Ads account using the Google Ads API.\u003c/p\u003e\n"],["\u003cp\u003eThey utilize GAQL queries to fetch changes like ad edits and campaign updates, showing the change date, user, operation type, and modified fields.\u003c/p\u003e\n"],["\u003cp\u003eThe examples include error handling and support various resource types, with language-specific implementations for Java, C#, and PHP.\u003c/p\u003e\n"],["\u003cp\u003eAll examples require a Google Ads Customer ID and can be customized to adjust timeframes and the number of changes retrieved.\u003c/p\u003e\n"],["\u003cp\u003eThese code samples are designed to help advertisers track campaign adjustments, audit account activity, and gain insights into account management.\u003c/p\u003e\n"]]],[],null,[]]
