Change Event provides a detailed breakdown of what changed in your account. When reporting on a create operation, all new field values are returned; and when reporting on an update operation, both new and old values are returned, giving you a complete picture of individual changes.
Additionally, the client type (such as API or web client) that was used to make the change is indicated, as well as which user made the change, assuming that information is also visible in the Change History of the web client.
Change Event types
See the list of resources types for
ChangeEventResourceType.
Query
The list of changes must be filtered by date. The date range must be within the past 30 days.
The query must also include a LIMIT clause restricting results to at most
10,000 rows. If you're interested in more than 10,000 results, make a note of
the timestamp of the last entry in the returned result set, and then set your
date range on the following query to start after that time to continue where you
left off.
A change can take up to three minutes to be reflected in the change event results.
The following example demonstrates how to fetch change events and process them, including determining who made the change, which client type they used to make the change, and the old and new values of each field in the change:
Java
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); } } } } } }
C#
public void Run(GoogleAdsClient client, long customerId) { // Get the GoogleAdsService. GoogleAdsServiceClient googleAdsService = client.GetService( Services.V20.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
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); } }
Python
def main(client, customer_id): """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 = 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 = (datetime.now() + timedelta(1)).strftime("%Y-%m-%d") two_weeks_ago = (datetime.now() + timedelta(-14)).strftime("%Y-%m-%d") query = 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 = client.get_type("SearchGoogleAdsRequest") search_request.customer_id = customer_id search_request.query = query results = googleads_service.search(request=search_request) for row in results: event = row.change_event resource_type = event.change_resource_type.name 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 = event.resource_change_operation.name if operation_type in ("UPDATE", "CREATE"): for changed_field in event.changed_fields.paths: # 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 = 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 = 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}" )
Ruby
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
Perl
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::V20::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"; } }
Limitations
A change event may not include every row from the Change History in the web client. For a similar view to Change History, use the change status resource instead.
The change event resource is intended to drill down into the specifics of an individual change. You can retrieve data such as specific field values that have changed, who made the change, and which client type was used to make the change. However, not all changes to your account will have a corresponding change event entry.
Some key client types that do record their changes for use with change events include:
- Google Ads API
- Google Ads web client