-
Notifications
You must be signed in to change notification settings - Fork 479
/
update_user_access.py
executable file
·188 lines (161 loc) · 6.34 KB
/
update_user_access.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
186
187
188
#!/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.
"""Updates the access role of a user, given the email address.
This code example should be run as a user who is an Administrator on the Google
Ads account with the specified customer ID.
See https://support.google.com/google-ads/answer/9978556 to learn more about
account access levels.
"""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
from google.api_core import protobuf_helpers
_ACCESS_ROLES = ["ADMIN", "STANDARD", "READ_ONLY", "EMAIL_ONLY"]
def main(client, customer_id, email_address, access_role):
"""Runs the example.
Args:
client: The Google Ads client.
customer_id: The customer ID.
email_address: The email address of the user whose access role should
be updated
access_role: The updated access role.
"""
user_id = get_user_access(client, customer_id, email_address)
if user_id:
modify_user_access(client, customer_id, user_id, access_role)
def get_user_access(client, customer_id, email_address):
"""Gets the customer user access given an email address.
Args:
client: The Google Ads client.
customer_id: The customer ID.
email_address: The email address of the user whose access role should
be updated.
Returns:
The user ID integer if a customer is found, otherwise None.
"""
googleads_service = client.get_service("GoogleAdsService")
# Creates a query that retrieves all customer user accesses.
# Use the LIKE query for filtering to ignore the text case for email
# address when searching for a match.
query = f"""
SELECT
customer_user_access.user_id,
customer_user_access.email_address,
customer_user_access.access_role,
customer_user_access.access_creation_date_time
FROM customer_user_access
WHERE customer_user_access.email_address LIKE '{email_address}'"""
search_request = client.get_type("SearchGoogleAdsRequest")
search_request.customer_id = customer_id
search_request.query = query
response = googleads_service.search(request=search_request)
try:
user_access = next(iter(response)).customer_user_access
print(
"Customer user access with "
f"User ID = '{user_access.user_id}', "
f"Access Role = '{user_access.access_role}', and "
f"Creation Time = {user_access.access_creation_date_time} "
f"was found in Customer ID: {customer_id}."
)
return user_access.user_id
except StopIteration:
# If a StopIteration exception is raised it indicates that the response
# was empty, no results were found, and this method should return None.
print("No customer user access with requested email was found.")
return None
def modify_user_access(client, customer_id, user_id, access_role):
"""Modifies the user access role to a specified value.
Args:
client: The Google Ads client.
customer_id: The customer ID.
user_id: ID of the user whose access role is being modified.
access_role: The updated access role.
"""
customer_user_access_service = client.get_service(
"CustomerUserAccessService"
)
customer_user_access_op = client.get_type("CustomerUserAccessOperation")
access_role_enum = client.enums.AccessRoleEnum
customer_user_access = customer_user_access_op.update
customer_user_access.resource_name = (
customer_user_access_service.customer_user_access_path(
customer_id, user_id
)
)
customer_user_access.access_role = getattr(access_role_enum, access_role)
client.copy_from(
customer_user_access_op.update_mask,
protobuf_helpers.field_mask(None, customer_user_access._pb),
)
response = customer_user_access_service.mutate_customer_user_access(
customer_id=customer_id, operation=customer_user_access_op
)
print(
"Successfully modified customer user access with resource name: "
f"{response.result.resource_name}."
)
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="This code example updates the access role of a user, "
"given the email address."
)
# 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(
"-e",
"--email_address",
type=str,
required=True,
help="The email address of the user whose access role should be "
"updated.",
)
parser.add_argument(
"-a",
"--access_role",
type=str,
required=True,
help="The access role that the given email address should be set to.",
choices=_ACCESS_ROLES,
)
args = parser.parse_args()
try:
main(
googleads_client,
args.customer_id,
args.email_address,
args.access_role,
)
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)