Documentation

Google_Service_DisplayVideo_Resource_CombinedAudiences extends Google_Service_Resource
in package

The "combinedAudiences" collection of methods.

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

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_DisplayVideo_CombinedAudience
Gets a combined audience. (combinedAudiences.get)
listCombinedAudiences()  : Google_Service_DisplayVideo_ListCombinedAudiencesResponse
Lists combined audiences. The order is defined by the order_by parameter.
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 a combined audience. (combinedAudiences.get)

public get(string $combinedAudienceId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_CombinedAudience
Parameters
$combinedAudienceId : string

Required. The ID of the combined audience to fetch.

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

Optional parameters.

Tags
opt_param

string partnerId The ID of the partner that has access to the fetched combined audience.

opt_param

string advertiserId The ID of the advertiser that has access to the fetched combined audience.

Return values
Google_Service_DisplayVideo_CombinedAudience —

listCombinedAudiences()

Lists combined audiences. The order is defined by the order_by parameter.

public listCombinedAudiences([array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_ListCombinedAudiencesResponse

(combinedAudiences.listCombinedAudiences)

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

Optional parameters.

Tags
opt_param

int pageSize Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

opt_param

string advertiserId The ID of the advertiser that has access to the fetched combined audiences.

opt_param

string partnerId The ID of the partner that has access to the fetched combined audiences.

opt_param

string pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCombinedAudiences method. If not specified, the first page of results will be returned.

opt_param

string filter Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences currently can only contain at most one restriction. * A restriction has the form of {field} {operator} {value}. * The operator must be CONTAINS (:). * Supported fields: - displayName Examples: * All combined audiences for which the display name contains "Google": displayName : "Google". The length of this field should be no more than 500 characters.

opt_param

string orderBy Field by which to sort the list. Acceptable values are: * combinedAudienceId (default) * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

Return values
Google_Service_DisplayVideo_ListCombinedAudiencesResponse —

convertToArrayAndStripNulls()

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

Search results