-
Notifications
You must be signed in to change notification settings - Fork 473
/
detect_and_apply_recommendations.py
executable file
·185 lines (153 loc) · 6.64 KB
/
detect_and_apply_recommendations.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
#!/usr/bin/env python
# Copyright 2023 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 shows how to retrieve recommendations and apply them in a batch.
Recommendations should be applied shortly after they're retrieved. Depending on
the recommendation type, a recommendation can become obsolete quickly, and
obsolete recommendations throw an error when applied. For more details, see:
https://developers.google.com/google-ads/api/docs/recommendations#take_action
As of Google Ads API v15 users can subscribe to certain recommendation types to
apply them automatically. For more details, see:
https://developers.google.com/google-ads/api/docs/recommendations#auto-apply
As of Google Ads API v16 users can proactively generate certain recommendation
types during the campaign construction process. For more details see:
https://developers.google.com/google-ads/api/docs/recommendations#recommendations-in-campaign-construction
"""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
def main(client, customer_id):
"""The main method that creates all necessary entities for the example.
Args:
client: an initialized GoogleAdsClient instance.
customer_id: a client customer ID.
"""
detect_and_apply_recommendations(client, customer_id)
def detect_and_apply_recommendations(client, customer_id):
"""Detects recommendations and applies them.
Args:
client: an initialized GoogleAdsClient instance.
customer_id: a client customer ID.
"""
# [START detect_keyword_recommendations]
googleads_service = client.get_service("GoogleAdsService")
query = f"""
SELECT
recommendation.campaign,
recommendation.keyword_recommendation
FROM recommendation
WHERE
recommendation.type = KEYWORD"""
# Detects keyword recommendations that exist for the customer account.
response = googleads_service.search(customer_id=customer_id, query=query)
operations = []
for row in response.results:
recommendation = row.recommendation
print(
f"Keyword recommendation ('{recommendation.resource_name}') "
f"was found for campaign '{recommendation.campaign}."
)
keyword = recommendation.keyword_recommendation.keyword
print(
f"\tKeyword = '{keyword.text}'\n" f"\tType = '{keyword.match_type}'"
)
# Create an ApplyRecommendationOperation that will be used to apply
# this recommendation, and add it to the list of operations.
operations.append(
build_recommendation_operation(client, recommendation.resource_name)
)
# [END detect_keyword_recommendations]
# If there are operations present, send a request to apply the
# recommendations.
if operations:
apply_recommendations(client, customer_id, operations)
# [START build_apply_recommendation_operation]
def build_recommendation_operation(client, recommendation):
"""Creates a ApplyRecommendationOperation to apply the given recommendation.
Args:
client: an initialized GoogleAdsClient instance.
customer_id: a client customer ID.
recommendation: a resource name for the recommendation to be applied.
"""
# If you have a recommendation ID instead of a resource name, you can create
# a resource name like this:
#
# googleads_service = client.get_service("GoogleAdsService")
# resource_name = googleads_service.recommendation_path(
# customer_id, recommendation.id
# )
operation = client.get_type("ApplyRecommendationOperation")
# Each recommendation type has optional parameters to override the
# recommended values. Below is an example showing how to override a
# recommended ad when a TextAdRecommendation is applied.
#
# operation.text_ad.ad.resource_name = "INSERT_AD_RESOURCE_NAME"
#
# For more details, see:
# https://developers.google.com/google-ads/api/reference/rpc/latest/ApplyRecommendationOperation#apply_parameters
operation.resource_name = recommendation
return operation
# [END build_apply_recommendation_operation]
# [START apply_recommendation]
def apply_recommendations(client, customer_id, operations):
"""Applies a batch of recommendations.
Args:
client: an initialized GoogleAdsClient instance.
customer_id: a client customer ID.
operations: a list of ApplyRecommendationOperation messages.
"""
# Issues a mutate request to apply the recommendations.
recommendation_service = client.get_service("RecommendationService")
response = recommendation_service.apply_recommendation(
customer_id=customer_id, operations=operations
)
for result in response.results:
print(
"Applied a recommendation with resource name: "
f"'{result[0].resource_name}'."
)
# [END apply_recommendation]
if __name__ == "__main__":
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client = GoogleAdsClient.load_from_storage(version="v16")
parser = argparse.ArgumentParser(
description=(
"Retrieves keyword recommendations for specified customer and "
"applies them."
)
)
# 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()
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'\tError with message "{error.message}".')
if error.location:
for field_path_element in error.location.field_path_elements:
print(f"\t\tOn field: {field_path_element.field_name}")
sys.exit(1)