NAME

SYNOPSIS

  use VUser::Google::ProvisioningAPI;
  my $google = new VUser::Google::ProvisioningAPI($domain,$admin,$password);

  $google->CreateAccount($userName, $firstName, $lastName, $password);
  $google->RetrieveAccount($userName);

REQUIREMENTS

• "LWP::UserAgent"
• "HTTP::Request"
• "Encode"
• "XML::Simple"

DESCRIPTION

        #create the object
        $google = new Google:ProvisioningAPI($domain,$admin,$password) || die "Cannot create google object";
        
        print 'Module version: ' . $google->VERSION . "\nAPI Version: " . $google->version() . "\n";
        
        #create a hosted account
        if( $google->CreateAccount( $userName, $firstName, $lastName, $password ) ) 
        {
                print "Account created!\N";
        }
        
        #add email services to the account
        $google->UpdateAccountEmail($userName);
        
        #retrieving account data
        if($google->RetrieveAccount($userName))
        {
                print 'Username: ' . $google->{result}->{RetrievalSection}->{userName} . "\n";
                print 'firstName: ' . $google->{result}->{RetrievalSection}->{firstName} . "\n";
                print 'lastName: ' . $google->{result}->{RetrievalSection}->{lastName} . "\n";
                print 'accountStatus: ' . $google->{result}->{RetrievalSection}->{accountStatus} . "\n";
                
        }
        
        #see what the result hash after a request looks like
        use Data::Dumper;
        print Dumper($google->{result});
        
        #delete an account
        $ret = DeleteAccount($userName);
        
        #accessing the HTML data as it was received from the Google servers:
        print $google->replyheaders();
        print $google->replycontent();

CONSTRUCTOR

This is the constructor for a new VUser::Google::ProvisioningAPI object. $domain is the domain name registered with Google Apps For Your Domain, $admin is an account in the above domain that has the right to manage that domain, and $adminpassword is the password for that account.

Note that the constructor will NOT attempt to perform the 'ClientLogin' call to the Google Provisioning API (see below). Authentication happens automatically when the first API call is performed. The token will be remembered for the duration of the object, and will be automatically refreshed as needed. If you want to verify that you can get a valid token before performing any operations, follow the constructor with a call to IsAuthenticated() as such:

        print "Authentication OK\n" unless not $google->IsAuthenticated();

METHODS

If the web post fails (as determined by the "HTTP::Request" method IsSuccess() ), the method returns 0, and the {reason} hash is set to a descriptive error. You can then examine the raw data to get an idea of what went wrong.

        UpdateAccount( $username, undef, undef, 'newpassword' );

        UpdateAccount( $username, 'newfirstname', 'newlastname', undef );

ACCESSING RESULTING DATA

        $google->{result}->{reason}             #this typically has the textual reason for a failure
        $google->{result}->{extendedMessage}    #a more extensive description of the failure reason may be here
        $google->{result}->{result}             #typically empty!
        $google->{result}->{type}               #should be same of query type, eg 'Account', 'Alias', 'MailingList'

The retrieval section contains data when you are querying. Here is what this section looks like when you call the RetrieveAccount method:

        $google->{result}->{RetrievalSection}->{firstName}
        $google->{result}->{RetrievalSection}->{lastName}
        $google->{result}->{RetrievalSection}->{accountStatus}
        $google->{result}->{RetrievalSection}->{aliases}->{alias}
        $google->{result}->{RetrievalSection}->{emailLists}->{emailList}

To see the structure of the result hash, use the Data::Dumper module as such:

        use Data::Dumper;
        print Dumper($google->{result});

ACCESSING RAW GOOGLE POST AND RESULT DATA

        print $google->requestcontent();

The most recent received HTML data is stored in two parts, the headers and the content. Both are strings. They can be accessed as such:

        print $google->replyheaders();
        print $google->replycontent();

Note the headers are new-line separated and can easily be parsed:

        foreach my $headerline ( split/\n/, $g->replyheaders() )
        {
                my ($header, $value) = split/:/, $headerline;
        }

EXPORT

SEE ALSO

For support, see the Google Group at http://groups.google.com/group/apps-for-your-domain-apis

For additional support specific to this modules, email me at johan at reinalda dot net.

AUTHOR

COPYRIGHT AND LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.5 or, at your option, any later version of Perl 5 you may have available.

If you make useful modification, kindly consider emailing then to me for inclusion in a future version of this module.