Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 2166 lines (62 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 30 classes
Google_Service_AdSenseHost:: (1 method):
__construct()
Google_Service_AdSenseHost_Accounts_Resource:: (2 methods):
get()
listAccounts()
Google_Service_AdSenseHost_AccountsAdclients_Resource:: (2 methods):
get()
listAccountsAdclients()
Google_Service_AdSenseHost_AccountsAdunits_Resource:: (7 methods):
delete()
get()
getAdCode()
insert()
listAccountsAdunits()
patch()
update()
Google_Service_AdSenseHost_AccountsReports_Resource:: (1 method):
generate()
Google_Service_AdSenseHost_Adclients_Resource:: (2 methods):
get()
listAdclients()
Google_Service_AdSenseHost_Associationsessions_Resource:: (2 methods):
start()
verify()
Google_Service_AdSenseHost_Customchannels_Resource:: (6 methods):
delete()
get()
insert()
listCustomchannels()
patch()
update()
Google_Service_AdSenseHost_Reports_Resource:: (1 method):
generate()
Google_Service_AdSenseHost_Urlchannels_Resource:: (3 methods):
delete()
insert()
listUrlchannels()
Google_Service_AdSenseHost_Account:: (8 methods):
setId()
getId()
setKind()
getKind()
setName()
getName()
setStatus()
getStatus()
Google_Service_AdSenseHost_Accounts:: (6 methods):
setEtag()
getEtag()
setItems()
getItems()
setKind()
getKind()
Google_Service_AdSenseHost_AdClient:: (10 methods):
setArcOptIn()
getArcOptIn()
setId()
getId()
setKind()
getKind()
setProductCode()
getProductCode()
setSupportsReporting()
getSupportsReporting()
Google_Service_AdSenseHost_AdClients:: (8 methods):
setEtag()
getEtag()
setItems()
getItems()
setKind()
getKind()
setNextPageToken()
getNextPageToken()
Google_Service_AdSenseHost_AdCode:: (4 methods):
setAdCode()
getAdCode()
setKind()
getKind()
Google_Service_AdSenseHost_AdStyle:: (8 methods):
setColors()
getColors()
setCorners()
getCorners()
setFont()
getFont()
setKind()
getKind()
Google_Service_AdSenseHost_AdStyleColors:: (10 methods):
setBackground()
getBackground()
setBorder()
getBorder()
setText()
getText()
setTitle()
getTitle()
setUrl()
getUrl()
Google_Service_AdSenseHost_AdStyleFont:: (4 methods):
setFamily()
getFamily()
setSize()
getSize()
Google_Service_AdSenseHost_AdUnit:: (16 methods):
setCode()
getCode()
setContentAdsSettings()
getContentAdsSettings()
setCustomStyle()
getCustomStyle()
setId()
getId()
setKind()
getKind()
setMobileContentAdsSettings()
getMobileContentAdsSettings()
setName()
getName()
setStatus()
getStatus()
Google_Service_AdSenseHost_AdUnitContentAdsSettings:: (6 methods):
setBackupOption()
getBackupOption()
setSize()
getSize()
setType()
getType()
Google_Service_AdSenseHost_AdUnitContentAdsSettingsBackupOption:: (6 methods):
setColor()
getColor()
setType()
getType()
setUrl()
getUrl()
Google_Service_AdSenseHost_AdUnitMobileContentAdsSettings:: (8 methods):
setMarkupLanguage()
getMarkupLanguage()
setScriptingLanguage()
getScriptingLanguage()
setSize()
getSize()
setType()
getType()
Google_Service_AdSenseHost_AdUnits:: (8 methods):
setEtag()
getEtag()
setItems()
getItems()
setKind()
getKind()
setNextPageToken()
getNextPageToken()
Google_Service_AdSenseHost_AssociationSession:: (18 methods):
setAccountId()
getAccountId()
setId()
getId()
setKind()
getKind()
setProductCodes()
getProductCodes()
setRedirectUrl()
getRedirectUrl()
setStatus()
getStatus()
setUserLocale()
getUserLocale()
setWebsiteLocale()
getWebsiteLocale()
setWebsiteUrl()
getWebsiteUrl()
Google_Service_AdSenseHost_CustomChannel:: (8 methods):
setCode()
getCode()
setId()
getId()
setKind()
getKind()
setName()
getName()
Google_Service_AdSenseHost_CustomChannels:: (8 methods):
setEtag()
getEtag()
setItems()
getItems()
setKind()
getKind()
setNextPageToken()
getNextPageToken()
Google_Service_AdSenseHost_Report:: (14 methods):
setAverages()
getAverages()
setHeaders()
getHeaders()
setKind()
getKind()
setRows()
getRows()
setTotalMatchedRows()
getTotalMatchedRows()
setTotals()
getTotals()
setWarnings()
getWarnings()
Google_Service_AdSenseHost_ReportHeaders:: (6 methods):
setCurrency()
getCurrency()
setName()
getName()
setType()
getType()
Google_Service_AdSenseHost_UrlChannel:: (6 methods):
setId()
getId()
setKind()
getKind()
setUrlPattern()
getUrlPattern()
Google_Service_AdSenseHost_UrlChannels:: (8 methods):
setEtag()
getEtag()
setItems()
getItems()
setKind()
getKind()
setNextPageToken()
getNextPageToken()
Class: Google_Service_AdSenseHost - X-Ref
Service definition for AdSenseHost (v4.1).<p>
Gives AdSense Hosts access to report generation, ad code generation, and
publisher management capabilities.</p>
<p>
For more information about this service, see the API
<a href="https://developers.google.com/adsense/host/" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the AdSenseHost service. param: Google_Client $client |
Class: Google_Service_AdSenseHost_Accounts_Resource - X-Ref
The "accounts" collection of methods.Typical usage is:
<code>
$adsensehostService = new Google_Service_AdSenseHost(...);
$accounts = $adsensehostService->accounts;
</code>
| get($accountId, $optParams = array() X-Ref |
| Get information about the selected associated AdSense account. (accounts.get) param: string $accountId Account to get information about. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_Account |
| listAccounts($filterAdClientId, $optParams = array() X-Ref |
| List hosted accounts associated with this AdSense account by ad client id. (accounts.listAccounts) param: string $filterAdClientId Ad clients to list accounts for. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_Accounts |
Class: Google_Service_AdSenseHost_AccountsAdclients_Resource - X-Ref
The "adclients" collection of methods.Typical usage is:
<code>
$adsensehostService = new Google_Service_AdSenseHost(...);
$adclients = $adsensehostService->adclients;
</code>
| get($accountId, $adClientId, $optParams = array() X-Ref |
| Get information about one of the ad clients in the specified publisher's AdSense account. (adclients.get) param: string $accountId Account which contains the ad client. param: string $adClientId Ad client to get. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AdClient |
| listAccountsAdclients($accountId, $optParams = array() X-Ref |
| List all hosted ad clients in the specified hosted account. (adclients.listAccountsAdclients) param: string $accountId Account for which to list ad clients. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AdClients |
Class: Google_Service_AdSenseHost_AccountsAdunits_Resource - X-Ref
The "adunits" collection of methods.Typical usage is:
<code>
$adsensehostService = new Google_Service_AdSenseHost(...);
$adunits = $adsensehostService->adunits;
</code>
| delete($accountId, $adClientId, $adUnitId, $optParams = array() X-Ref |
| Delete the specified ad unit from the specified publisher AdSense account. (adunits.delete) param: string $accountId Account which contains the ad unit. param: string $adClientId Ad client for which to get ad unit. param: string $adUnitId Ad unit to delete. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AdUnit |
| get($accountId, $adClientId, $adUnitId, $optParams = array() X-Ref |
| Get the specified host ad unit in this AdSense account. (adunits.get) param: string $accountId Account which contains the ad unit. param: string $adClientId Ad client for which to get ad unit. param: string $adUnitId Ad unit to get. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AdUnit |
| getAdCode($accountId, $adClientId, $adUnitId, $optParams = array() X-Ref |
| Get ad code for the specified ad unit, attaching the specified host custom channels. (adunits.getAdCode) param: string $accountId Account which contains the ad client. param: string $adClientId Ad client with contains the ad unit. param: string $adUnitId Ad unit to get the code for. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AdCode |
| insert($accountId, $adClientId, Google_Service_AdSenseHost_AdUnit $postBody, $optParams = array() X-Ref |
| Insert the supplied ad unit into the specified publisher AdSense account. (adunits.insert) param: string $accountId Account which will contain the ad unit. param: string $adClientId Ad client into which to insert the ad unit. param: Google_AdUnit $postBody param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AdUnit |
| listAccountsAdunits($accountId, $adClientId, $optParams = array() X-Ref |
| List all ad units in the specified publisher's AdSense account. (adunits.listAccountsAdunits) param: string $accountId Account which contains the ad client. param: string $adClientId Ad client for which to list ad units. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AdUnits |
| patch($accountId, $adClientId, $adUnitId, Google_Service_AdSenseHost_AdUnit $postBody, $optParams = array() X-Ref |
| Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics. (adunits.patch) param: string $accountId Account which contains the ad client. param: string $adClientId Ad client which contains the ad unit. param: string $adUnitId Ad unit to get. param: Google_AdUnit $postBody param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AdUnit |
| update($accountId, $adClientId, Google_Service_AdSenseHost_AdUnit $postBody, $optParams = array() X-Ref |
| Update the supplied ad unit in the specified publisher AdSense account. (adunits.update) param: string $accountId Account which contains the ad client. param: string $adClientId Ad client which contains the ad unit. param: Google_AdUnit $postBody param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AdUnit |
Class: Google_Service_AdSenseHost_AccountsReports_Resource - X-Ref
The "reports" collection of methods.Typical usage is:
<code>
$adsensehostService = new Google_Service_AdSenseHost(...);
$reports = $adsensehostService->reports;
</code>
| generate($accountId, $startDate, $endDate, $optParams = array() X-Ref |
| Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. (reports.generate) param: string $accountId Hosted account upon which to report. param: string $startDate Start of the date range to report on in "YYYY-MM-DD" param: string $endDate End of the date range to report on in "YYYY-MM-DD" param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_Report |
Class: Google_Service_AdSenseHost_Adclients_Resource - X-Ref
The "adclients" collection of methods.Typical usage is:
<code>
$adsensehostService = new Google_Service_AdSenseHost(...);
$adclients = $adsensehostService->adclients;
</code>
| get($adClientId, $optParams = array() X-Ref |
| Get information about one of the ad clients in the Host AdSense account. (adclients.get) param: string $adClientId Ad client to get. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AdClient |
| listAdclients($optParams = array() X-Ref |
| List all host ad clients in this AdSense account. (adclients.listAdclients) param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AdClients |
Class: Google_Service_AdSenseHost_Associationsessions_Resource - X-Ref
The "associationsessions" collection of methods.Typical usage is:
<code>
$adsensehostService = new Google_Service_AdSenseHost(...);
$associationsessions = $adsensehostService->associationsessions;
</code>
| start($productCode, $websiteUrl, $optParams = array() X-Ref |
| Create an association session for initiating an association with an AdSense user. (associationsessions.start) param: string $productCode Products to associate with the user. param: string $websiteUrl The URL of the user's hosted website. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AssociationSession |
| verify($token, $optParams = array() X-Ref |
| Verify an association session after the association callback returns from AdSense signup. (associationsessions.verify) param: string $token The token returned to the association callback URL. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_AssociationSession |
Class: Google_Service_AdSenseHost_Customchannels_Resource - X-Ref
The "customchannels" collection of methods.Typical usage is:
<code>
$adsensehostService = new Google_Service_AdSenseHost(...);
$customchannels = $adsensehostService->customchannels;
</code>
| delete($adClientId, $customChannelId, $optParams = array() X-Ref |
| Delete a specific custom channel from the host AdSense account. (customchannels.delete) param: string $adClientId Ad client from which to delete the custom channel. param: string $customChannelId Custom channel to delete. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_CustomChannel |
| get($adClientId, $customChannelId, $optParams = array() X-Ref |
| Get a specific custom channel from the host AdSense account. (customchannels.get) param: string $adClientId Ad client from which to get the custom channel. param: string $customChannelId Custom channel to get. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_CustomChannel |
| insert($adClientId, Google_Service_AdSenseHost_CustomChannel $postBody, $optParams = array() X-Ref |
| Add a new custom channel to the host AdSense account. (customchannels.insert) param: string $adClientId Ad client to which the new custom channel will be param: Google_CustomChannel $postBody param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_CustomChannel |
| listCustomchannels($adClientId, $optParams = array() X-Ref |
| List all host custom channels in this AdSense account. (customchannels.listCustomchannels) param: string $adClientId Ad client for which to list custom channels. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_CustomChannels |
| patch($adClientId, $customChannelId, Google_Service_AdSenseHost_CustomChannel $postBody, $optParams = array() X-Ref |
| Update a custom channel in the host AdSense account. This method supports patch semantics. (customchannels.patch) param: string $adClientId Ad client in which the custom channel will be param: string $customChannelId Custom channel to get. param: Google_CustomChannel $postBody param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_CustomChannel |
| update($adClientId, Google_Service_AdSenseHost_CustomChannel $postBody, $optParams = array() X-Ref |
| Update a custom channel in the host AdSense account. (customchannels.update) param: string $adClientId Ad client in which the custom channel will be param: Google_CustomChannel $postBody param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_CustomChannel |
Class: Google_Service_AdSenseHost_Reports_Resource - X-Ref
The "reports" collection of methods.Typical usage is:
<code>
$adsensehostService = new Google_Service_AdSenseHost(...);
$reports = $adsensehostService->reports;
</code>
| generate($startDate, $endDate, $optParams = array() X-Ref |
| Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. (reports.generate) param: string $startDate Start of the date range to report on in "YYYY-MM-DD" param: string $endDate End of the date range to report on in "YYYY-MM-DD" param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_Report |
Class: Google_Service_AdSenseHost_Urlchannels_Resource - X-Ref
The "urlchannels" collection of methods.Typical usage is:
<code>
$adsensehostService = new Google_Service_AdSenseHost(...);
$urlchannels = $adsensehostService->urlchannels;
</code>
| delete($adClientId, $urlChannelId, $optParams = array() X-Ref |
| Delete a URL channel from the host AdSense account. (urlchannels.delete) param: string $adClientId Ad client from which to delete the URL channel. param: string $urlChannelId URL channel to delete. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_UrlChannel |
| insert($adClientId, Google_Service_AdSenseHost_UrlChannel $postBody, $optParams = array() X-Ref |
| Add a new URL channel to the host AdSense account. (urlchannels.insert) param: string $adClientId Ad client to which the new URL channel will be param: Google_UrlChannel $postBody param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_UrlChannel |
| listUrlchannels($adClientId, $optParams = array() X-Ref |
| List all host URL channels in the host AdSense account. (urlchannels.listUrlchannels) param: string $adClientId Ad client for which to list URL channels. param: array $optParams Optional parameters. return: Google_Service_AdSenseHost_UrlChannels |
Class: Google_Service_AdSenseHost_Account - X-Ref
Class: Google_Service_AdSenseHost_Accounts - X-Ref
Class: Google_Service_AdSenseHost_AdClient - X-Ref
| setArcOptIn($arcOptIn) X-Ref |
| No description |
| getArcOptIn() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setProductCode($productCode) X-Ref |
| No description |
| getProductCode() X-Ref |
| No description |
| setSupportsReporting($supportsReporting) X-Ref |
| No description |
| getSupportsReporting() X-Ref |
| No description |
Class: Google_Service_AdSenseHost_AdCode - X-Ref
Class: Google_Service_AdSenseHost_AdStyle - X-Ref
| setColors(Google_Service_AdSenseHost_AdStyleColors $colors) X-Ref |
| No description |
| getColors() X-Ref |
| No description |
| setCorners($corners) X-Ref |
| No description |
| getCorners() X-Ref |
| No description |
| setFont(Google_Service_AdSenseHost_AdStyleFont $font) X-Ref |
| No description |
| getFont() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
Class: Google_Service_AdSenseHost_AdStyleColors - X-Ref
| setBackground($background) X-Ref |
| No description |
| getBackground() X-Ref |
| No description |
| setBorder($border) X-Ref |
| No description |
| getBorder() X-Ref |
| No description |
| setText($text) X-Ref |
| No description |
| getText() X-Ref |
| No description |
| setTitle($title) X-Ref |
| No description |
| getTitle() X-Ref |
| No description |
| setUrl($url) X-Ref |
| No description |
| getUrl() X-Ref |
| No description |
Class: Google_Service_AdSenseHost_AdUnit - X-Ref
| setCode($code) X-Ref |
| No description |
| getCode() X-Ref |
| No description |
| setContentAdsSettings(Google_Service_AdSenseHost_AdUnitContentAdsSettings $contentAdsSettings) X-Ref |
| No description |
| getContentAdsSettings() X-Ref |
| No description |
| setCustomStyle(Google_Service_AdSenseHost_AdStyle $customStyle) X-Ref |
| No description |
| getCustomStyle() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setMobileContentAdsSettings(Google_Service_AdSenseHost_AdUnitMobileContentAdsSettings $mobileContentAdsSettings) X-Ref |
| No description |
| getMobileContentAdsSettings() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setStatus($status) X-Ref |
| No description |
| getStatus() X-Ref |
| No description |
Class: Google_Service_AdSenseHost_AdUnitContentAdsSettings - X-Ref
| setBackupOption(Google_Service_AdSenseHost_AdUnitContentAdsSettingsBackupOption $backupOption) X-Ref |
| No description |
| getBackupOption() X-Ref |
| No description |
| setSize($size) X-Ref |
| No description |
| getSize() X-Ref |
| No description |
| setType($type) X-Ref |
| No description |
| getType() X-Ref |
| No description |
Class: Google_Service_AdSenseHost_AdUnitMobileContentAdsSettings - X-Ref
| setMarkupLanguage($markupLanguage) X-Ref |
| No description |
| getMarkupLanguage() X-Ref |
| No description |
| setScriptingLanguage($scriptingLanguage) X-Ref |
| No description |
| getScriptingLanguage() X-Ref |
| No description |
| setSize($size) X-Ref |
| No description |
| getSize() X-Ref |
| No description |
| setType($type) X-Ref |
| No description |
| getType() X-Ref |
| No description |
Class: Google_Service_AdSenseHost_AdUnits - X-Ref
Class: Google_Service_AdSenseHost_AssociationSession - X-Ref
| setAccountId($accountId) X-Ref |
| No description |
| getAccountId() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setProductCodes($productCodes) X-Ref |
| No description |
| getProductCodes() X-Ref |
| No description |
| setRedirectUrl($redirectUrl) X-Ref |
| No description |
| getRedirectUrl() X-Ref |
| No description |
| setStatus($status) X-Ref |
| No description |
| getStatus() X-Ref |
| No description |
| setUserLocale($userLocale) X-Ref |
| No description |
| getUserLocale() X-Ref |
| No description |
| setWebsiteLocale($websiteLocale) X-Ref |
| No description |
| getWebsiteLocale() X-Ref |
| No description |
| setWebsiteUrl($websiteUrl) X-Ref |
| No description |
| getWebsiteUrl() X-Ref |
| No description |
Class: Google_Service_AdSenseHost_Report - X-Ref
| setAverages($averages) X-Ref |
| No description |
| getAverages() X-Ref |
| No description |
| setHeaders($headers) X-Ref |
| No description |
| getHeaders() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setRows($rows) X-Ref |
| No description |
| getRows() X-Ref |
| No description |
| setTotalMatchedRows($totalMatchedRows) X-Ref |
| No description |
| getTotalMatchedRows() X-Ref |
| No description |
| setTotals($totals) X-Ref |
| No description |
| getTotals() X-Ref |
| No description |
| setWarnings($warnings) X-Ref |
| No description |
| getWarnings() X-Ref |
| No description |
Class: Google_Service_AdSenseHost_UrlChannel - X-Ref
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setUrlPattern($urlPattern) X-Ref |
| No description |
| getUrlPattern() X-Ref |
| No description |
