NAME

WebService::Eulerian::Analytics::Website::TPPublisher - access to the TPPublisher service for a given website : partners for outbound traffic.

DESCRIPTION

This module allow you to access the TPPublisher service holding information about all the partners for your outbound traffic.

SYNOPSIS

        use WebService::Eulerian::Analytics::Website::TPPublisher;
        #
        my $api = new WebService::Eulerian::Analytics::Website::TPPublisher(
         apikey => 'THE KEY PROVIDED BY YOUR ACCOUNT MANAGER FOR API ACCESS',
         host   => 'THE HOST ON WHICH THE API IS HOSTED'
        );

METHODS

getById : return a tppublisher given it's id

input

• id of the targetted website

• id of the tppublisher

output

• hash reference containing the attributes of the tppublisher

sample

        my $rh_tppublisher = $api->getById($my_website_id, 1);
        #
        if ( $api->fault ) {
         die $api->faultstring();
        }
        #
        foreach ( keys %{ $rh_tppublisher } ) {
         print $_." => ".$rh_tppublisher->{$_}."\n";
        }

getByName : return a tppublisher given it's name

input

• id of the targetted website

• name of the tppublisher

output

• hash reference containing the attributes of the tppublisher

sample

        my $rh_tppublisher = $api->getByName($my_website_id, 'test');
        #
        if ( $api->fault ) {
         die $api->faultstring();
        }
        #
        foreach ( keys %{ $rh_tppublisher } ) {
         print $_." => ".$rh_tppublisher->{$_}."\n";
        }

search : search for a tppublisher

input

• id of the targetted website

• hash of search parameters

• hash of optionnal search parameters

  o sortkey : key on which the sorting can be done, defaults to tppublisher_name

  o sortdir : direction of the sorting, defaults to asc

  o start : for paging, indicate the start index, defaults to 0

  o limit : for paging, indicate the numer of results requested, default to 30

output

• hash reference containing the following keys

  o results : array of hash containing the list of tppublisher matching the search

  o totalcount : total number of items matching the search, used for paging.

sample

        my $rh_result = $api->search($my_website_id, { }, { limit => 20 });
        print "Total count : ".($rh_result->{totalcount} || 0)."<\n";
        for ( @{ $rh_result->{results} || [] } ) {
          print "\t name=".$_->{tppublisher_name}." | id=".$_->{tppublisher_id}."<\n";
        }

SEE ALSO

WebService::Eulerian::Analytics

AUTHOR

Mathieu Jondet <mathieu@eulerian.com>

COPYRIGHT

Copyright (c) 2008 Eulerian Technologies Ltd http://www.eulerian.com

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

cpanm WebService::Eulerian::Analytics

perl -MCPAN -e shell
install WebService::Eulerian::Analytics