Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 42 additions & 9 deletions examples/account_management/invite_user_with_access_role.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright 2021 Google LLC
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -21,11 +21,21 @@
require 'optparse'
require 'google/ads/google_ads'

ACCESS_ROLES = %w[
ADMIN
STANDARD
READ_ONLY
EMAIL_ONLY
].freeze

def invite_user_with_access_role(customer_id, email_address, access_role)
Comment thread
dorasun marked this conversation as resolved.
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new

# Sanitizes the customer ID to handle hyphenated inputs.
customer_id = customer_id.to_s.tr('-', '')

# [START invite_user_with_access_role]
operation = client.operation.create_resource.customer_user_access_invitation do |inv|
inv.email_address = email_address
Expand All @@ -38,10 +48,19 @@ def invite_user_with_access_role(customer_id, email_address, access_role)
operation: operation,
)

# Prints out information of the created invitation.
puts "Customer user access invitation was sent for customerId = #{customer_id} " \
"email address = '#{email_address}', " \
"access role = '#{access_role}'."
if !response.result.multi_party_auth_review.to_s.empty?
puts "A multi-party auth review was triggered. The MPA review resource " \
"name is #{response.result.multi_party_auth_review}. Ask a second " \
"administrator to approve this request to send the user access invitation. " \
"See advanced_operations/fetch_and_approve_pending_multi_party_auth_reviews.rb " \
"for an example on how to approve an MPA auth review using the API."
else
# Print out information of the created invitation.
puts "Customer user access invitation was sent for customerId = #{customer_id} " \
"email address = '#{email_address}', " \
"access role = '#{access_role}'. The invitation resource name is " \
"#{response.result.resource_name}."
end
# [END invite_user_with_access_role]
Comment thread
dorasun marked this conversation as resolved.
end
Comment thread
dorasun marked this conversation as resolved.

Expand All @@ -59,7 +78,7 @@ def invite_user_with_access_role(customer_id, email_address, access_role)
options[:email_address] = 'INSERT_EMAIL_ADDRESS_HERE'
options[:access_role] = 'INSERT_ACCESS_ROLE_HERE'

OptionParser.new do |opts|
parser = OptionParser.new do |opts|
opts.banner = sprintf('Usage: ruby %s [options]', File.basename(__FILE__))

opts.separator ''
Expand All @@ -84,13 +103,27 @@ def invite_user_with_access_role(customer_id, email_address, access_role)
puts opts
exit
end
end.parse!
end
parser.parse!

if options[:customer_id].nil? || options[:customer_id] == 'INSERT_CUSTOMER_ID_HERE' ||
Comment thread
dorasun marked this conversation as resolved.
options[:email_address].nil? || options[:email_address] == 'INSERT_EMAIL_ADDRESS_HERE' ||
options[:access_role].nil? || options[:access_role] == 'INSERT_ACCESS_ROLE_HERE'
puts "Missing required arguments. Customer ID (-C), Email Address (-E), and Access Role (-R) are required.\n\n"
puts parser
exit 1
end

unless ACCESS_ROLES.include?(options[:access_role]&.upcase)
puts "Invalid access role. Must be one of: #{ACCESS_ROLES.join(', ')}"
exit 1
end

begin
invite_user_with_access_role(
options.fetch(:customer_id).tr("-", ""),
options.fetch(:customer_id),
options.fetch(:email_address),
options.fetch(:access_role).to_sym,
options.fetch(:access_role).upcase.to_sym,
)
rescue Google::Ads::GoogleAds::Errors::GoogleAdsError => e
Comment thread
dorasun marked this conversation as resolved.
e.failure.errors.each do |error|
Expand Down
57 changes: 41 additions & 16 deletions examples/account_management/update_user_access.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright 2020 Google LLC
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -26,11 +26,21 @@
require 'optparse'
require 'google/ads/google_ads'

ACCESS_ROLES = %w[
ADMIN
STANDARD
READ_ONLY
EMAIL_ONLY
].freeze

def update_user_access(customer_id, email_address, access_role)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new

# Sanitizes the customer ID to handle hyphenated inputs.
customer_id = customer_id.to_s.tr('-', '')

if !ACCESS_ROLES.include?(access_role)
raise "Illegal access role specified. Expected one of " \
"#{ACCESS_ROLES.join(" ")}"
Expand Down Expand Up @@ -83,18 +93,19 @@ def modify_user_access(client, customer_id, user_id, access_role)
operation: operation,
)

puts "Successfully updated customer user access with resource name " \
"#{response.result.resource_name}."
if !response.result.multi_party_auth_review.to_s.empty?
puts "A multi-party auth review was triggered. The MPA review resource " \
"name is #{response.result.multi_party_auth_review}. Ask a second " \
"administrator to approve this request to make the requested user " \
"access changes. See advanced_operations/fetch_and_approve_pending_multi_party_auth_reviews.rb " \
"for an example on how to approve an MPA auth review using the API."
Comment thread
dorasun marked this conversation as resolved.
else
puts "Successfully updated customer user access with resource name " \
"#{response.result.resource_name}."
end
end

if __FILE__ == $0
ACCESS_ROLES = %w[
ADMIN
STANDARD
READ_ONLY
EMAIL_ONLY
]

options = {}
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
Expand All @@ -108,7 +119,7 @@ def modify_user_access(client, customer_id, user_id, access_role)
options[:email_address] = 'INSERT_EMAIL_ADDRESS_HERE'
options[:access_role] = 'INSERT_ACCESS_ROLE_HERE'

OptionParser.new do |opts|
parser = OptionParser.new do |opts|
opts.banner = sprintf('Usage: %s [options]', File.basename(__FILE__))

opts.separator ''
Expand All @@ -118,11 +129,11 @@ def modify_user_access(client, customer_id, user_id, access_role)
options[:customer_id] = v
end

opts.on('-e', '--email-address EMAIL-ADDRESS', String, 'Email Address') do |v|
opts.on('-E', '--email-address EMAIL-ADDRESS', String, 'Email Address') do |v|
options[:email_address] = v
end

opts.on('-a', '--access-role ACCESS-ROLE', String, 'Access Role') do |v|
opts.on('-R', '--access-role ACCESS-ROLE', String, 'Access Role') do |v|
options[:access_role] = v
end

Expand All @@ -133,13 +144,27 @@ def modify_user_access(client, customer_id, user_id, access_role)
puts opts
exit
end
end.parse!
end
parser.parse!

if options[:customer_id].nil? || options[:customer_id] == 'INSERT_CUSTOMER_ID_HERE' ||
Comment thread
dorasun marked this conversation as resolved.
options[:email_address].nil? || options[:email_address] == 'INSERT_EMAIL_ADDRESS_HERE' ||
options[:access_role].nil? || options[:access_role] == 'INSERT_ACCESS_ROLE_HERE'
puts "Missing required arguments. Customer ID (-C), Email Address (-E), and Access Role (-R) are required.\n\n"
puts parser
exit 1
end

unless ACCESS_ROLES.include?(options[:access_role]&.upcase)
puts "Invalid access role. Must be one of: #{ACCESS_ROLES.join(', ')}"
exit 1
end

begin
Comment thread
dorasun marked this conversation as resolved.
update_user_access(
options.fetch(:customer_id).tr("-", ""),
options.fetch(:customer_id),
options.fetch(:email_address),
options.fetch(:access_role),
options.fetch(:access_role).upcase.to_sym,
)
rescue Google::Ads::GoogleAds::Errors::GoogleAdsError => e
e.failure.errors.each do |error|
Expand Down
Loading