Documentation

Google_Service_DisplayVideo_Resource_AdvertisersChannelsSites extends Google_Service_Resource
in package

Application

The "sites" collection of methods.

Typical usage is: $displayvideoService = new Google_Service_DisplayVideo(...); $sites = $displayvideoService->sites;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
bulkEdit() : Google_Service_DisplayVideo_BulkEditSitesResponse: Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. (sites.bulkEdit)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_DisplayVideo_Site: Creates a site in a channel. (sites.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_DisplayVideo_DisplayvideoEmpty: Deletes a site from a channel. (sites.delete)
listAdvertisersChannelsSites() : Google_Service_DisplayVideo_ListSitesResponse: Lists sites in a channel. (sites.listAdvertisersChannelsSites)
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 —

bulkEdit()

Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. (sites.bulkEdit)


    public
                bulkEdit(string $advertiserId, string $channelId, Google_Service_DisplayVideo_BulkEditSitesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_BulkEditSitesResponse

Parameters

$advertiserId : string: The ID of the advertiser that owns the parent channel.
$channelId : string: Required. The ID of the parent channel to which the sites belong.
$postBody : Google_Service_DisplayVideo_BulkEditSitesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_BulkEditSitesResponse —

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 —

create()

Creates a site in a channel. (sites.create)


    public
                create(string $advertiserId, string $channelId, Google_Service_DisplayVideo_Site $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_Site

Parameters

$advertiserId : string: The ID of the advertiser that owns the parent channel.
$channelId : string: Required. The ID of the parent channel in which the site will be created.
$postBody : Google_Service_DisplayVideo_Site
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_Site —

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

delete()

Deletes a site from a channel. (sites.delete)


    public
                delete(string $advertiserId, string $channelId, string $urlOrAppId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_DisplayvideoEmpty

Parameters

$advertiserId : string: The ID of the advertiser that owns the parent channel.
$channelId : string: Required. The ID of the parent channel to which the site belongs.
$urlOrAppId : string: Required. The URL or app ID of the site to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_DisplayvideoEmpty —

listAdvertisersChannelsSites()

Lists sites in a channel. (sites.listAdvertisersChannelsSites)


    public
                listAdvertisersChannelsSites(string $advertiserId, string $channelId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_ListSitesResponse

Parameters

$advertiserId : string: The ID of the advertiser that owns the parent channel.
$channelId : string: Required. The ID of the parent channel to which the requested sites belong.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_ListSitesResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —