Documentation

Google_Service_DisplayVideo_Resource_AdvertisersLocationListsAssignedLocations extends Google_Service_Resource
in package

The "assignedLocations" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
bulkEdit()  : Google_Service_DisplayVideo_BulkEditAssignedLocationsResponse
Bulk edits multiple assignments between locations and a single location list.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_DisplayVideo_AssignedLocation
Creates an assignment between a location and a location list.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DisplayVideo_DisplayvideoEmpty
Deletes the assignment between a location and a location list.
listAdvertisersLocationListsAssignedLocations()  : Google_Service_DisplayVideo_ListAssignedLocationsResponse
Lists locations assigned to a location list.
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 —

bulkEdit()

Bulk edits multiple assignments between locations and a single location list.

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

The operation will delete the assigned locations provided in BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create the assigned locations provided in BulkEditAssignedLocationsRequest.created_assigned_locations. (assignedLocations.bulkEdit)

Parameters
$advertiserId : string

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

$locationListId : string

Required. The ID of the location list to which these assignments are assigned.

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

Optional parameters.

Return values
Google_Service_DisplayVideo_BulkEditAssignedLocationsResponse —

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 an assignment between a location and a location list.

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

(assignedLocations.create)

Parameters
$advertiserId : string

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

$locationListId : string

Required. The ID of the location list for which the assignment will be created.

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

Optional parameters.

Return values
Google_Service_DisplayVideo_AssignedLocation —

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

delete()

Deletes the assignment between a location and a location list.

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

(assignedLocations.delete)

Parameters
$advertiserId : string

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

$locationListId : string

Required. The ID of the location list to which this assignment is assigned.

$assignedLocationId : string

Required. The ID of the assigned location to delete.

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

Optional parameters.

Return values
Google_Service_DisplayVideo_DisplayvideoEmpty —

listAdvertisersLocationListsAssignedLocations()

Lists locations assigned to a location list.

public listAdvertisersLocationListsAssignedLocations(string $advertiserId, string $locationListId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_ListAssignedLocationsResponse

(assignedLocations.listAdvertisersLocationListsAssignedLocations)

Parameters
$advertiserId : string

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

$locationListId : string

Required. The ID of the location list to which these assignments are assigned.

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

Optional parameters.

Tags
opt_param

string filter Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of {field} {operator} {value}. * The operator must be EQUALS (=). * Supported fields: - assignedLocationId The length of this field should be no more than 500 characters.

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 orderBy Field by which to sort the list. Acceptable values are: * assignedLocationId (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: assignedLocationId desc.

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

Return values
Google_Service_DisplayVideo_ListAssignedLocationsResponse —

convertToArrayAndStripNulls()

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

Search results