#!/usr/bin/perl -w
#
# Copyright 2021, 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
#
#
# 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 code example retrieves pending invitations for a customer account. To
# create a pending invitation, see invite_user_with_access_role.pl.
use strict;
use utf8;
use FindBin qw($Bin);
use lib "$Bin/../../lib";
use
Google::Ads::GoogleAds::V11::Services::GoogleAdsService::SearchGoogleAdsStreamRequest;
use Getopt::Long qw(:config auto_help);
use Cwd qw(abs_path);
# 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
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
my $customer_id = "INSERT_CUSTOMER_ID_HERE";
# [START get_pending_invitations]
sub get_pending_invitations {
my ($api_client, $customer_id) = @_;
# Create a query that retrieves the pending invitations.
my $search_query =
"SELECT customer_user_access_invitation.invitation_id, " .
"customer_user_access_invitation.email_address, " .
"customer_user_access_invitation.access_role, " .
"customer_user_access_invitation.creation_date_time " .
"FROM customer_user_access_invitation " .
"WHERE customer_user_access_invitation.invitation_status= 'PENDING'";
# Create a search Google Ads stream request that will retrieve the pending
# invitations.
my $search_stream_request =
Google::Ads::GoogleAds::V11::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
->new({
customerId => $customer_id,
query => $search_query,
});
# Get the GoogleAdsService.
my $google_ads_service = $api_client->GoogleAdsService();
my $search_stream_handler =
Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
service => $google_ads_service,
request => $search_stream_request
});
# Issue a search request and process the stream response to print the requested
# field values for the pending invitation in each row.
$search_stream_handler->process_contents(
sub {
my $google_ads_row = shift;
my $access_invitation = $google_ads_row->{customerUserAccessInvitation};
printf
"A pending invitation with invitation ID = %d, email address = '%s', "
. "access role = '%s' and created on %s was found.\n",
$access_invitation->{invitationId},
$access_invitation->{emailAddress}, $access_invitation->{accessRole},
$access_invitation->{creationDateTime};
});
return 1;
}
# [END get_pending_invitations]
# Don't run the example if the file is being included.
if (abs_path($0) ne abs_path(__FILE__)) {
return 1;
}
# Get Google Ads Client, credentials will be read from ~/googleads.properties.
my $api_client = Google::Ads::GoogleAds::Client->new();
# By default examples are set to die on any server returned fault.
$api_client->set_die_on_faults(1);
# Parameters passed on the command line will override any parameters set in code.
GetOptions("customer_id=s" => \$customer_id);
# Print the help message if the parameters are not initialized in the code nor
# in the command line.
pod2usage(2) if not check_params($customer_id);
# Call the example.
get_pending_invitations($api_client, $customer_id =~ s/-//gr);
=pod
=head1 NAME
get_pending_invitations
=head1 DESCRIPTION
This code example retrieves pending invitations for a customer account. To
create a pending invitation, see invite_user_with_access_role.pl.
=head1 SYNOPSIS
get_pending_invitations.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
=cut