Documentation

Google_Service_DisplayVideo_Resource_AdvertisersCampaigns extends Google_Service_Resource
in package

Application

The "campaigns" collection of methods.

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

$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.
create() : Google_Service_DisplayVideo_Campaign: Creates a new campaign. Returns the newly created campaign if successful.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_DisplayVideo_DisplayvideoEmpty: Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. (campaigns.delete)
get() : Google_Service_DisplayVideo_Campaign: Gets a campaign. (campaigns.get)
listAdvertisersCampaigns() : Google_Service_DisplayVideo_ListCampaignsResponse: Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
patch() : Google_Service_DisplayVideo_Campaign: Updates an existing campaign. Returns the updated campaign if successful.
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 —

create()

Creates a new campaign. Returns the newly created campaign if successful.


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

(campaigns.create)

Parameters

$advertiserId : string: Output only. The unique ID of the advertiser the campaign belongs to.
$postBody : Google_Service_DisplayVideo_Campaign
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_Campaign —

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()

Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. (campaigns.delete)


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

Parameters

$advertiserId : string: The ID of the advertiser this campaign belongs to.
$campaignId : string: The ID of the campaign we need to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_DisplayvideoEmpty —

get()

Gets a campaign. (campaigns.get)


    public
                get(string $advertiserId, string $campaignId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_Campaign

Parameters

$advertiserId : string: Required. The ID of the advertiser this campaign belongs to.
$campaignId : string: Required. The ID of the campaign to fetch.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_Campaign —

listAdvertisersCampaigns()

Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.


    public
                listAdvertisersCampaigns(string $advertiserId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_ListCampaignsResponse

(campaigns.listAdvertisersCampaigns)

Parameters

$advertiserId : string: The ID of the advertiser to list campaigns for.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_ListCampaignsResponse —

patch()

Updates an existing campaign. Returns the updated campaign if successful.


    public
                patch(string $advertiserId, string $campaignId, Google_Service_DisplayVideo_Campaign $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_Campaign

(campaigns.patch)

Parameters

$advertiserId : string: Output only. The unique ID of the advertiser the campaign belongs to.
$campaignId : string: Output only. The unique ID of the campaign. Assigned by the system.
$postBody : Google_Service_DisplayVideo_Campaign
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_Campaign —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —