Documentation

Google_Service_Dfareporting_Resource_Ads extends Google_Service_Resource
in package

Application

The "ads" collection of methods.

Typical usage is: $dfareportingService = new Google_Service_Dfareporting(...); $ads = $dfareportingService->ads;

$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_Dfareporting_Ad: Gets one ad by ID. (ads.get)
insert() : Google_Service_Dfareporting_Ad: Inserts a new ad. (ads.insert)
listAds() : Google_Service_Dfareporting_AdsListResponse: Retrieves a list of ads, possibly filtered. This method supports paging.
patch() : Google_Service_Dfareporting_Ad: Updates an existing ad. This method supports patch semantics. (ads.patch)
update() : Google_Service_Dfareporting_Ad: Updates an existing ad. (ads.update)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

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>

Return values

string —

$requestUrl

get()

Gets one ad by ID. (ads.get)


    public
                get(string $profileId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Ad

Parameters

$profileId : string: User profile ID associated with this request.
$id : string: Ad ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dfareporting_Ad —

insert()

Inserts a new ad. (ads.insert)


    public
                insert(string $profileId, Google_Service_Dfareporting_Ad $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Ad

Parameters

$profileId : string: User profile ID associated with this request.
$postBody : Google_Service_Dfareporting_Ad
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dfareporting_Ad —

listAds()

Retrieves a list of ads, possibly filtered. This method supports paging.


    public
                listAds(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_AdsListResponse

(ads.listAds)

Parameters

$profileId : string: User profile ID associated with this request.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dfareporting_AdsListResponse —

patch()

Updates an existing ad. This method supports patch semantics. (ads.patch)


    public
                patch(string $profileId, string $id, Google_Service_Dfareporting_Ad $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Ad

Parameters

$profileId : string: User profile ID associated with this request.
$id : string: Ad ID.
$postBody : Google_Service_Dfareporting_Ad
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dfareporting_Ad —

update()

Updates an existing ad. (ads.update)


    public
                update(string $profileId, Google_Service_Dfareporting_Ad $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Ad

Parameters

$profileId : string: User profile ID associated with this request.
$postBody : Google_Service_Dfareporting_Ad
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dfareporting_Ad —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —