Joomla! API

Download
Launch

JGoogleDataAdsense

Extends \JGoogleData

Google Adsense data class for the Joomla Platform.

deprecated
since

3.1.4
deprecated

4.0 Use the joomla/google package via Composer instead
package

Joomla.Platform

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JGoogleAuth $auth = null)
inherited
since

3.1.4

Arguments

$options

\Joomla\Registry\RegistryGoogle options object.

$auth

\JGoogleAuthGoogle data http client object.

authenticate

Method to authenticate to Google

authenticate() : boolean
inherited
since

3.1.4

Response

booleanTrue on success.

generateReport

Method to retrieve a list of AdSense Channel URLs

generateReport(string $accountID, mixed $start, mixed $end = false, array $options = array(), integer $maxpages = 1) : mixed
since

3.1.4
throws

\InvalidArgumentException

\UnexpectedValueException

Arguments

$accountID

stringID of account

$start

mixedStart day

$end

mixedEnd day

$options

arraySearch settings

$maxpages

integerMaximum number of pages of accounts to return

Response

mixedData from Google

getAccount

Method to get an Adsense account's settings from Google

getAccount(string $accountID, boolean $subaccounts = true) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$accountID

stringID of account to get

$subaccounts

booleanInclude list of subaccounts

Response

mixedData from Google

getChannel

Method to get an Adsense Channel

getChannel(string $accountID, string $adclientID, string $channelID) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$accountID

stringID of account to get

$adclientID

stringID of client to get

$channelID

stringID of channel to get

Response

mixedData from Google

getOption

Get an option from the JGoogleData instance.

getOption(string $key) : mixed
inherited
since

3.1.4

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

getUnit

Method to get an AdSense AdUnit

getUnit(string $accountID, string $adclientID, string $adunitID) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$accountID

stringID of account to get

$adclientID

stringID of client to get

$adunitID

stringID of adunit to get

Response

mixedData from Google

isAuthenticated

Check authentication

isAuthenticated() : boolean
inherited
since

3.1.4

Response

booleanTrue if authenticated.

listAccounts

Method to retrieve a list of AdSense accounts from Google

listAccounts(array $options = array(), integer $maxpages = 1) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$options

arraySearch settings

$maxpages

integerMaximum number of pages of accounts to return

Response

mixedData from Google

listChannels

Method to retrieve a list of AdSense Custom Channels

listChannels(string $accountID, string $adclientID, array $options = array(), integer $maxpages = 1) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$accountID

stringID of account

$adclientID

stringID of client to list channels from

$options

arraySearch settings

$maxpages

integerMaximum number of pages of accounts to return

Response

mixedData from Google

listChannelUnits

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

listChannelUnits(string $accountID, string $adclientID, string $channelID, array $options = array(), integer $maxpages = 1) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$accountID

stringID of account

$adclientID

stringID of client

$channelID

stringID of channel to list units from

$options

arraySearch settings

$maxpages

integerMaximum number of pages of accounts to return

Response

mixedData from Google

listClients

Method to retrieve a list of AdSense clients from Google

listClients(string $accountID, array $options = array(), integer $maxpages = 1) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$accountID

stringID of account to list the clients from

$options

arraySearch settings

$maxpages

integerMaximum number of pages of accounts to return

Response

mixedData from Google

listGetData

Method to retrieve a list of data

listGetData(array $url, integer $maxpages = 1, string $token = null) : mixed
inherited
since

3.1.4
throws

\UnexpectedValueException

Arguments

$url

arrayURL to GET

$maxpages

integerMaximum number of pages to return

$token

stringNext page token

Response

mixedData from Google

listUnitChannels

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

listUnitChannels(string $accountID, string $adclientID, string $adunitID, array $options = array(), integer $maxpages = 1) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$accountID

stringID of account

$adclientID

stringID of client

$adunitID

stringID of adunit to list channels from

$options

arraySearch settings

$maxpages

integerMaximum number of pages of accounts to return

Response

mixedData from Google

listUrlChannels

Method to generate a report from Google AdSense

listUrlChannels(string $accountID, string $adclientID, array $options = array(), integer $maxpages = 1) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$accountID

stringID of account

$adclientID

stringID of client

$options

arraySearch settings

$maxpages

integerMaximum number of pages of accounts to return

Response

mixedData from Google

query

Method to retrieve data from Google

query(string $url, mixed $data = null, array $headers = null, string $method = 'get') : mixed
inherited
since

3.1.4

Arguments

$url

stringThe URL for the request.

$data

mixedThe data to include in the request.

$headers

arrayThe headers to send with the request.

$method

stringThe type of http request to send.

Response

mixedData from Google.

safeXml

Method to validate XML

safeXml(string $data) : \SimpleXMLElement
inherited static
since

3.1.4
throws

\UnexpectedValueException

Arguments

$data

stringXML data to be parsed

Response

\SimpleXMLElementXMLElement of parsed data

setOption

Set an option for the JGoogleData instance.

setOption(string $key, mixed $value) : \JGoogleData
inherited
since

3.1.4

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\JGoogleDataThis object for method chaining.

Properties

options

Options for the Google data object.

inherited
since

3.1.4

Type(s)

\Joomla\Registry\Registry

auth

Authentication client for the Google data object.

inherited
since

3.1.4

Type(s)

\JGoogleAuth
  • \ \
  • \ JGoogleDataAdsense