The code samples below provide examples of common error handling functions using the AdWords API. Client Library.
Handle partial failures
#!/usr/bin/env python
#
# Copyright 2016 Google Inc. All Rights Reserved.
#
# 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 demonstrates how to handle partial failures.
To get ad groups, run get_ad_groups.py.
The LoadFromStorage method is pulling credentials and properties from a
"googleads.yaml" file. By default, it looks for this file in your home
directory. For more information, see the "Caching authentication information"
section of our README.
"""
from googleads import adwords
AD_GROUP_ID = 'INSERT_AD_GROUP_ID_HERE'
def main(client, ad_group_id):
# Enable partial failure.
client.partial_failure = True
# Initialize appropriate service.
ad_group_criterion_service = client.GetService(
'AdGroupCriterionService', version='v201809')
# Construct keyword ad group criteria objects.
keywords = [
{
'xsi_type': 'BiddableAdGroupCriterion',
'adGroupId': ad_group_id,
'criterion': {
'xsi_type': 'Keyword',
'matchType': 'BROAD',
'text': 'mars cruise'
}
},
{
'xsi_type': 'BiddableAdGroupCriterion',
'adGroupId': ad_group_id,
'criterion': {
'xsi_type': 'Keyword',
'matchType': 'BROAD',
'text': r'inv\@lid cruise'
}
},
{
'xsi_type': 'BiddableAdGroupCriterion',
'adGroupId': ad_group_id,
'criterion': {
'xsi_type': 'Keyword',
'matchType': 'BROAD',
'text': 'venus cruise'
}
},
{
'xsi_type': 'BiddableAdGroupCriterion',
'adGroupId': ad_group_id,
'criterion': {
'xsi_type': 'Keyword',
'matchType': 'BROAD',
'text': r'b\(a\)d keyword cruise'
}
}
]
# Construct operations and add ad group criteria.
operations = []
for keyword in keywords:
operations.append(
{
'operator': 'ADD',
'operand': keyword
})
result = ad_group_criterion_service.mutate(operations)
# Display results.
for criterion in result['value']:
if criterion['AdGroupCriterion.Type'] == 'BiddableAdGroupCriterion':
print('Added keyword ad group criterion with ad group id "%s", '
'criterion id "%s", text "%s", and match type "%s" was '
'added.'
% (criterion['adGroupId'], criterion['criterion']['id'],
criterion['criterion']['text'],
criterion['criterion']['matchType']))
for error in result['partialFailureErrors']:
field_path_elements = error['fieldPathElements']
first_field_path_element = None
if field_path_elements:
first_field_path_element = field_path_elements[0]
if (first_field_path_element and
first_field_path_element['field'] == 'operations' and
'index' in first_field_path_element):
operation_index = first_field_path_element['index']
adgroup_criterion = operations[operation_index]['operand']
print('Ad group criterion with ad group ID %s and keyword "%s" triggered '
'a failure for the following reason: %s.'
% (adgroup_criterion['adGroupId'],
adgroup_criterion['criterion']['text'],
error['errorString']))
else:
print('A failure has occurred for the following reasons: %s\n'
% error['errorString'])
if __name__ == '__main__':
# Initialize client object.
adwords_client = adwords.AdWordsClient.LoadFromStorage()
main(adwords_client, AD_GROUP_ID)