Documentation

Google_Service_DisplayVideo_Resource_AdvertisersLocationLists extends Google_Service_Resource
in package

The "locationLists" collection of methods.

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

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.
create()  : Google_Service_DisplayVideo_LocationList
Creates a new location list. Returns the newly created location list if successful. (locationLists.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_DisplayVideo_LocationList
Gets a location list. (locationLists.get)
listAdvertisersLocationLists()  : Google_Service_DisplayVideo_ListLocationListsResponse
Lists location lists based on a given advertiser id.
patch()  : Google_Service_DisplayVideo_LocationList
Updates a location list. Returns the updated location list if successful.
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

create()

Creates a new location list. Returns the newly created location list if successful. (locationLists.create)

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

Required. The ID of the DV360 advertiser to which the location list belongs.

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

Optional parameters.

Return values
Google_Service_DisplayVideo_LocationList

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 location list. (locationLists.get)

public get(string $advertiserId, string $locationListId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_LocationList
Parameters
$advertiserId : string

Required. The ID of the DV360 advertiser to which the fetched location list belongs.

$locationListId : string

Required. The ID of the location list to fetch.

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

Optional parameters.

Return values
Google_Service_DisplayVideo_LocationList

listAdvertisersLocationLists()

Lists location lists based on a given advertiser id.

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

(locationLists.listAdvertisersLocationLists)

Parameters
$advertiserId : string

Required. The ID of the DV360 advertiser to which the fetched location lists belong.

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

Optional parameters.

Tags
opt_param

string filter Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of {field} {operator} {value}. * The operator must be EQUALS (=). * Supported fields: - locationType Examples: * All regional location list: locationType="TARGETING_LOCATION_TYPE_REGIONAL" * All proximity location list: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

opt_param

string orderBy Field by which to sort the list. Acceptable values are: * locationListId (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.

opt_param

int pageSize Requested page size. Must be between 1 and 100. Defaults to 100 if not set. Returns error code INVALID_ARGUMENT if an invalid value is specified.

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 ListLocationLists method. If not specified, the first page of results will be returned.

Return values
Google_Service_DisplayVideo_ListLocationListsResponse

patch()

Updates a location list. Returns the updated location list if successful.

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

(locationLists.patch)

Parameters
$advertiserId : string

Required. The ID of the DV360 advertiser to which the location lists belongs.

$locationListId : string

Output only. The unique ID of the location list. Assigned by the system.

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

Optional parameters.

Tags
opt_param

string updateMask Required. The mask to control which fields to update.

Return values
Google_Service_DisplayVideo_LocationList

convertToArrayAndStripNulls()

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

Search results