Class JGoogleDataAdsense

Description
Description | Vars | Methods (details)

Google Adsense data class for the Joomla Platform.

  • since: 12.3

Located in /libraries/joomla/google/data/adsense.php (line 19) 

JGoogleData
   |
   --JGoogleDataAdsense
Method Summary
Description | Vars | Methods (details)
JGoogleDataAdsense __construct ([JRegistry $options = null], [JGoogleAuth $auth = null])
mixed generateReport (string $accountID, mixed $start, [mixed $end = false], [array $options = array()], [int $maxpages = 1])
mixed getAccount (string $accountID, [boolean $subaccounts = true])
mixed getChannel (string $accountID, string $adclientID, string $channelID)
mixed getUnit (string $accountID, string $adclientID, string $adunitID)
mixed listAccounts ([array $options = array()], [int $maxpages = 1])
mixed listChannels (string $accountID, string $adclientID, [array $options = array()], [int $maxpages = 1])
mixed listChannelUnits (string $accountID, string $adclientID, string $channelID, [array $options = array()], [int $maxpages = 1])
mixed listClients (string $accountID, [array $options = array()], [int $maxpages = 1])
mixed listUnitChannels (string $accountID, string $adclientID, string $adunitID, [array $options = array()], [int $maxpages = 1])
mixed listUrlChannels (string $accountID, string $adclientID, [array $options = array()], [int $maxpages = 1])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JGoogleData

JGoogleData::$auth
 JGoogleData::$options
Methods
Description | Vars Methods (details)
Constructor __construct (line 29)

Constructor.

  • since: 12.3
  • access: public
JGoogleDataAdsense __construct ([JRegistry $options = null], [JGoogleAuth $auth = null])
Redefinition of:
JGoogleData::__construct()
Constructor.
generateReport (line 330)

Method to retrieve a list of AdSense Channel URLs

  • return: Data from Google
  • since: 12.3
  • throws: UnexpectedValueException
  • access: public
mixed generateReport (string $accountID, mixed $start, [mixed $end = false], [array $options = array()], [int $maxpages = 1])
  • string $accountID: ID of account
  • mixed $start: Start day
  • mixed $end: End day
  • array $options: Search settings
  • int $maxpages: Maximum number of pages of accounts to return
getAccount (line 49)

Method to get an Adsense account's settings from Google

  • return: Data from Google
  • since: 12.3
  • access: public
mixed getAccount (string $accountID, [boolean $subaccounts = true])
  • string $accountID: ID of account to get
  • boolean $subaccounts: Include list of subaccounts
getChannel (line 202)

Method to get an Adsense Channel

  • return: Data from Google
  • since: 12.3
  • access: public
mixed getChannel (string $accountID, string $adclientID, string $channelID)
  • string $accountID: ID of account to get
  • string $adclientID: ID of client to get
  • string $channelID: ID of channel to get
getUnit (line 137)

Method to get an AdSense AdUnit

  • return: Data from Google
  • since: 12.3
  • access: public
mixed getUnit (string $accountID, string $adclientID, string $adunitID)
  • string $accountID: ID of account to get
  • string $adclientID: ID of client to get
  • string $adunitID: ID of adunit to get
listAccounts (line 82)

Method to retrieve a list of AdSense accounts from Google

  • return: Data from Google
  • since: 12.3
  • throws: UnexpectedValueException
  • access: public
mixed listAccounts ([array $options = array()], [int $maxpages = 1])
  • array $options: Search settings
  • int $maxpages: Maximum number of pages of accounts to return
listChannels (line 238)

Method to retrieve a list of AdSense Custom Channels

  • return: Data from Google
  • since: 12.3
  • throws: UnexpectedValueException
  • access: public
mixed listChannels (string $accountID, string $adclientID, [array $options = array()], [int $maxpages = 1])
  • string $accountID: ID of account
  • string $adclientID: ID of client to list channels from
  • array $options: Search settings
  • int $maxpages: Maximum number of pages of accounts to return
listChannelUnits (line 269)

Method to retrieve a list of AdSense Adunits for a specific Custom Channel

  • return: Data from Google
  • since: 12.3
  • throws: UnexpectedValueException
  • access: public
mixed listChannelUnits (string $accountID, string $adclientID, string $channelID, [array $options = array()], [int $maxpages = 1])
  • string $accountID: ID of account
  • string $adclientID: ID of client
  • string $channelID: ID of channel to list units from
  • array $options: Search settings
  • int $maxpages: Maximum number of pages of accounts to return
listClients (line 110)

Method to retrieve a list of AdSense clients from Google

  • return: Data from Google
  • since: 12.3
  • throws: UnexpectedValueException
  • access: public
mixed listClients (string $accountID, [array $options = array()], [int $maxpages = 1])
  • string $accountID: ID of account to list the clients from
  • array $options: Search settings
  • int $maxpages: Maximum number of pages of accounts to return
listUnitChannels (line 174)

Method to retrieve a list of AdSense Custom Channels for a specific Adunit

  • return: Data from Google
  • since: 12.3
  • throws: UnexpectedValueException
  • access: public
mixed listUnitChannels (string $accountID, string $adclientID, string $adunitID, [array $options = array()], [int $maxpages = 1])
  • string $accountID: ID of account
  • string $adclientID: ID of client
  • string $adunitID: ID of adunit to list channels from
  • array $options: Search settings
  • int $maxpages: Maximum number of pages of accounts to return
listUrlChannels (line 299)

Method to generate a report from Google AdSense

  • return: Data from Google
  • since: 12.3
  • throws: UnexpectedValueException
  • access: public
mixed listUrlChannels (string $accountID, string $adclientID, [array $options = array()], [int $maxpages = 1])
  • string $accountID: ID of account
  • string $adclientID: ID of client
  • array $options: Search settings
  • int $maxpages: Maximum number of pages of accounts to return

Inherited Methods

Inherited From JGoogleData

JGoogleData::__construct()
JGoogleData::authenticate()
JGoogleData::getOption()
JGoogleData::isAuthenticated()
JGoogleData::listGetData()
JGoogleData::query()
JGoogleData::safeXML()
JGoogleData::setOption()

Documentation generated on Tue, 19 Nov 2013 14:53:37 +0100 by phpDocumentor 1.4.3