Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_AdSenseHost_AccountsAdunits_Resource Class Reference

The "adunits" collection of methods. More...

Inheritance diagram for Google_Service_AdSenseHost_AccountsAdunits_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($accountId, $adClientId, $adUnitId, $optParams=array())
 Delete the specified ad unit from the specified publisher AdSense account.
 
 get ($accountId, $adClientId, $adUnitId, $optParams=array())
 Get the specified host ad unit in this AdSense account.
 
 getAdCode ($accountId, $adClientId, $adUnitId, $optParams=array())
 Get ad code for the specified ad unit, attaching the specified host custom channels.
 
 insert ($accountId, $adClientId, Google_Service_AdSenseHost_AdUnit $postBody, $optParams=array())
 Insert the supplied ad unit into the specified publisher AdSense account.
 
 listAccountsAdunits ($accountId, $adClientId, $optParams=array())
 List all ad units in the specified publisher's AdSense account.
 
 patch ($accountId, $adClientId, $adUnitId, Google_Service_AdSenseHost_AdUnit $postBody, $optParams=array())
 Update the supplied ad unit in the specified publisher AdSense account.
 
 update ($accountId, $adClientId, Google_Service_AdSenseHost_AdUnit $postBody, $optParams=array())
 Update the supplied ad unit in the specified publisher AdSense account.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "adunits" collection of methods.

Typical usage is: $adsensehostService = new Google_Service_AdSenseHost(...); $adunits = $adsensehostService->adunits;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_AdSenseHost_AccountsAdunits_Resource::delete ( $accountId,
$adClientId,
$adUnitId,
$optParams = array() )

Delete the specified ad unit from the specified publisher AdSense account.

(adunits.delete)

Parameters
string$accountIdAccount which contains the ad unit.
string$adClientIdAd client for which to get ad unit.
string$adUnitIdAd unit to delete.
array$optParamsOptional parameters.
Return values
Google_Service_AdSenseHost_AdUnit

◆ get()

Google_Service_AdSenseHost_AccountsAdunits_Resource::get ( $accountId,
$adClientId,
$adUnitId,
$optParams = array() )

Get the specified host ad unit in this AdSense account.

(adunits.get)

Parameters
string$accountIdAccount which contains the ad unit.
string$adClientIdAd client for which to get ad unit.
string$adUnitIdAd unit to get.
array$optParamsOptional parameters.
Return values
Google_Service_AdSenseHost_AdUnit

◆ getAdCode()

Google_Service_AdSenseHost_AccountsAdunits_Resource::getAdCode ( $accountId,
$adClientId,
$adUnitId,
$optParams = array() )

Get ad code for the specified ad unit, attaching the specified host custom channels.

(adunits.getAdCode)

Parameters
string$accountIdAccount which contains the ad client.
string$adClientIdAd client with contains the ad unit.
string$adUnitIdAd unit to get the code for.
array$optParamsOptional parameters.

@opt_param string hostCustomChannelId Host custom channel to attach to the ad code.

Return values
Google_Service_AdSenseHost_AdCode

◆ insert()

Google_Service_AdSenseHost_AccountsAdunits_Resource::insert ( $accountId,
$adClientId,
Google_Service_AdSenseHost_AdUnit $postBody,
$optParams = array() )

Insert the supplied ad unit into the specified publisher AdSense account.

(adunits.insert)

Parameters
string$accountIdAccount which will contain the ad unit.
string$adClientIdAd client into which to insert the ad unit.
Google_AdUnit$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AdSenseHost_AdUnit

◆ listAccountsAdunits()

Google_Service_AdSenseHost_AccountsAdunits_Resource::listAccountsAdunits ( $accountId,
$adClientId,
$optParams = array() )

List all ad units in the specified publisher's AdSense account.

(adunits.listAccountsAdunits)

Parameters
string$accountIdAccount which contains the ad client.
string$adClientIdAd client for which to list ad units.
array$optParamsOptional parameters.

@opt_param bool includeInactive Whether to include inactive ad units. Default: true. @opt_param string pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. @opt_param string maxResults The maximum number of ad units to include in the response, used for paging.

Return values
Google_Service_AdSenseHost_AdUnits

◆ patch()

Google_Service_AdSenseHost_AccountsAdunits_Resource::patch ( $accountId,
$adClientId,
$adUnitId,
Google_Service_AdSenseHost_AdUnit $postBody,
$optParams = array() )

Update the supplied ad unit in the specified publisher AdSense account.

This method supports patch semantics. (adunits.patch)

Parameters
string$accountIdAccount which contains the ad client.
string$adClientIdAd client which contains the ad unit.
string$adUnitIdAd unit to get.
Google_AdUnit$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AdSenseHost_AdUnit

◆ update()

Google_Service_AdSenseHost_AccountsAdunits_Resource::update ( $accountId,
$adClientId,
Google_Service_AdSenseHost_AdUnit $postBody,
$optParams = array() )

Update the supplied ad unit in the specified publisher AdSense account.

(adunits.update)

Parameters
string$accountIdAccount which contains the ad client.
string$adClientIdAd client which contains the ad unit.
Google_AdUnit$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AdSenseHost_AdUnit

The documentation for this class was generated from the following file: