Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Google_Service_AdSense_Adunits_Resource Class Reference

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

Inheritance diagram for Google_Service_AdSense_Adunits_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($adClientId, $adUnitId, $optParams=array())
 Gets the specified ad unit in the specified ad client.
 
 getAdCode ($adClientId, $adUnitId, $optParams=array())
 Get ad code for the specified ad unit.
 
 listAdunits ($adClientId, $optParams=array())
 List all ad units in the specified ad client for this AdSense account.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "adunits" collection of methods.

Typical usage is: $adsenseService = new Google_Service_AdSense(...); $adunits = $adsenseService->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

◆ get()

Google_Service_AdSense_Adunits_Resource::get ( $adClientId,
$adUnitId,
$optParams = array() )

Gets the specified ad unit in the specified ad client.

(adunits.get)

Parameters
string$adClientIdAd client for which to get the ad unit.
string$adUnitIdAd unit to retrieve.
array$optParamsOptional parameters.
Return values
Google_Service_AdSense_AdUnit

◆ getAdCode()

Google_Service_AdSense_Adunits_Resource::getAdCode ( $adClientId,
$adUnitId,
$optParams = array() )

Get ad code for the specified ad unit.

(adunits.getAdCode)

Parameters
string$adClientIdAd client with contains the ad unit.
string$adUnitIdAd unit to get the code for.
array$optParamsOptional parameters.
Return values
Google_Service_AdSense_AdCode

◆ listAdunits()

Google_Service_AdSense_Adunits_Resource::listAdunits ( $adClientId,
$optParams = array() )

List all ad units in the specified ad client for this AdSense account.

(adunits.listAdunits)

Parameters
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 int maxResults The maximum number of ad units to include in the response, used for paging.

Return values
Google_Service_AdSense_AdUnits

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