/
get_ad_group_bid_modifiers.py
executable file
·141 lines (123 loc) · 5.25 KB
/
get_ad_group_bid_modifiers.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
#!/usr/bin/env python
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""This example illustrates how to retrieve ad group bid modifiers."""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
_DEFAULT_PAGE_SIZE = 1000
def main(client, customer_id, page_size, ad_group_id=None):
ga_service = client.get_service("GoogleAdsService")
query = """
SELECT
campaign.id,
ad_group.id,
ad_group_bid_modifier.criterion_id,
ad_group_bid_modifier.bid_modifier,
ad_group_bid_modifier.device.type,
ad_group_bid_modifier.hotel_date_selection_type.type,
ad_group_bid_modifier.hotel_advance_booking_window.min_days,
ad_group_bid_modifier.hotel_advance_booking_window.max_days,
ad_group_bid_modifier.hotel_length_of_stay.min_nights,
ad_group_bid_modifier.hotel_length_of_stay.max_nights,
ad_group_bid_modifier.hotel_check_in_day.day_of_week,
ad_group_bid_modifier.hotel_check_in_date_range.start_date,
ad_group_bid_modifier.hotel_check_in_date_range.end_date
FROM ad_group_bid_modifier"""
if ad_group_id:
query += f" WHERE ad_group.id = {ad_group_id}"
# Limit results to 10,000 rows as the number of bid modifiers can be large.
query += " LIMIT 10000"
search_request = client.get_type("SearchGoogleAdsRequest")
search_request.customer_id = customer_id
search_request.query = query
search_request.page_size = _DEFAULT_PAGE_SIZE
results = ga_service.search(request=search_request)
for row in results:
modifier = row.ad_group_bid_modifier
print(
"Ad group bid modifier with criterion ID "
f"'{modifier.criterion_id}', bid modifier value "
f"'{modifier.bid_modifier or 0.00}', device type "
f"'{modifier.device.type_.name}' was found in ad group with ID "
f"'{row.ad_group.id}' of campaign with ID '{row.campaign.id}'."
)
criterion_field = type(modifier).pb(modifier).WhichOneof("criterion")
criterion_details = f" - Criterion type: {criterion_field}, "
if criterion_field == "device":
criterion_details += f"Type: {modifier.device.type_}"
elif criterion_field == "hotel_advance_booking_window":
criterion_details += (
f"Min Days: {modifier.hotel_advance_booking_window.min_days}, "
f"Max Days: {modifier.hotel_advance_booking_window.max_days}"
)
elif criterion_field == "hotel_check_in_day":
criterion_details += (
f"Day of the week: {modifier.hotel_check_in_day.day_of_week}"
)
elif criterion_field == "hotel_date_selection_type":
criterion_details += f"Date selection type: {modifier.hotel_date_selection_type.type_}"
elif criterion_field == "hotel_length_of_stay":
criterion_details += (
f"Min Nights: {modifier.hotel_length_of_stay.min_nights}, "
f"Max Nights: {modifier.hotel_length_of_stay.max_nights}"
)
else:
criterion_details = " - No Criterion type found."
print(criterion_details)
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="List ad group bid modifiers for specified customer."
)
# The following argument(s) should be provided to run the example.
parser.add_argument(
"-c",
"--customer_id",
type=str,
required=True,
help="The Google Ads customer ID.",
)
parser.add_argument(
"-a",
"--ad_group_id",
type=str,
required=False,
help=(
"The ad group ID. Specify this to list ad group "
"bid modifiers solely for this ad group ID."
),
)
args = parser.parse_args()
try:
main(
googleads_client,
args.customer_id,
_DEFAULT_PAGE_SIZE,
ad_group_id=args.ad_group_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)