Documentation

Google_Service_AdSense_Resource_AccountsAdunits extends Google_Service_Resource
in package

The "adunits" collection of methods.

Typical usage is: $adsenseService = new Google_Service_AdSense(...); $adunits = $adsenseService->adunits;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_AdSense_AdUnit
Gets the specified ad unit in the specified ad client for the specified account. (adunits.get)
getAdCode()  : Google_Service_AdSense_AdCode
Get ad code for the specified ad unit. (adunits.getAdCode)
listAccountsAdunits()  : Google_Service_AdSense_AdUnits
List all ad units in the specified ad client for the specified account.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

Gets the specified ad unit in the specified ad client for the specified account. (adunits.get)

public get(string $accountId, string $adClientId, string $adUnitId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdSense_AdUnit
Parameters
$accountId : string

Account to which the ad client belongs.

$adClientId : string

Ad client for which to get the ad unit.

$adUnitId : string

Ad unit to retrieve.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AdSense_AdUnit —

getAdCode()

Get ad code for the specified ad unit. (adunits.getAdCode)

public getAdCode(string $accountId, string $adClientId, string $adUnitId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdSense_AdCode
Parameters
$accountId : string

Account which contains the ad client.

$adClientId : string

Ad client with contains the ad unit.

$adUnitId : string

Ad unit to get the code for.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AdSense_AdCode —

listAccountsAdunits()

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

public listAccountsAdunits(string $accountId, string $adClientId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdSense_AdUnits

(adunits.listAccountsAdunits)

Parameters
$accountId : string

Account to which the ad client belongs.

$adClientId : string

Ad client for which to list ad units.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results