NAME

VERSION

SYNOPSIS

    use Net::Google::Analytics;
    use Net::Google::Analytics::OAuth2;

    # Insert your numeric Analytics profile ID here. You can find it under
    # profile settings. DO NOT use your account or property ID (UA-nnnnnn).
    my $profile_id    = "1234567";
    # See GETTING STARTED for how to get a client id, client secret, and
    # refresh token
    my $client_id     = "123456789012.apps.googleusercontent.com";
    my $client_secret = "rAnDoMsEcReTrAnDoMsEcReT";
    my $refresh_token = "RaNdOmSeCrEtRaNdOmSeCrEt";

    my $analytics = Net::Google::Analytics->new;

    # Authenticate
    my $oauth = Net::Google::Analytics::OAuth2->new(
        client_id     => $client_id,
        client_secret => $client_secret,
    );
    my $token = $oauth->refresh_access_token($refresh_token);
    $analytics->token($token);

    # Build request
    my $req = $analytics->new_request(
        ids         => "ga:$profile_id",
        dimensions  => "ga:medium,ga:source",
        metrics     => "ga:bounces,ga:visits",
        filters     => "ga:medium==referral",
        sort        => "-ga:visits",
        start_date  => "2011-10-01",
        end_date    => "2011-10-31",
        max_results => 5,
    );

    # Send request
    my $res = $analytics->retrieve($req);
    die("GA error: " . $res->error_message) if !$res->is_success;

    # Print results

    print
        "Results: 1 - ", $res->num_rows,
        " of ", $res->total_results, "\n\n";

    for my $row (@{ $res->rows }) {
        print
            $row->get_source,  ": ",
            $row->get_visits,  " visits, ",
            $row->get_bounces, " bounces\n";
    }

    print
        "\nTotal: ",
        $res->totals("visits"),  " visits, ",
        $res->totals("bounces"), " bounces\n";

DESCRIPTION

See <http://code.google.com/apis/analytics/docs/gdata/home.html> for the complete API documentation.

WARNING: This module is not API compatible with the 0.x releases which target the legacy v2 API.

GETTING STARTED

You will receive a client id and a client secret for your application in the APIs Console. For command line testing, you should use "Installed application" as application type. Then you can obtain a refresh token for your application by running the following script with your client id and secret:

    use Net::Google::Analytics::OAuth2;

    my $oauth = Net::Google::Analytics::OAuth2->new(
        client_id     => 'Your client id',
        client_secret => 'Your client secret',
    );

    $oauth->interactive;

The script will display a URL and prompt for a code. Visit the URL in a browser and follow the directions to grant access to your application. You will be shown the code that you should enter in the Perl script. Then the script retrieves and prints a refresh token which can be used for non-interactive access.

You also have to provide the profile ID of your Analytics profile with every request. You can find this decimal number hidden in the "profile settings" dialog in Google Analytics. Note that this ID is different from your account or property ID of the form UA-nnnnnn-n. Prepend your profile ID with "ga:" and pass it as "ids" parameter to the request object.

The "ids", "metrics", "start_date", and "end_date" parameters are required for every request.

For the exact parameter syntax and a list of supported dimensions and metrics you should consult the Google API documentation.

CONSTRUCTOR

    my $analytics = Net::Google::Analytics->new;

METHODS

    $analytics->auth_params(@auth_params);

    $analytics->token($token);

    my $req = $analytics->new_request(param => $value, ...);

    my $res = $analytics->retrieve($req);

    my $res = $analytics->retrieve_http($req);

    my $res = $analytics->retrieve_paged($req);

    my $uri = $analytics->uri($req);

    $analytics->user_agent($ua);

AUTHOR

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.