Documentation

Google_Service_DisplayVideo_Resource_InventorySourceGroupsAssignedInventorySources extends Google_Service_Resource
in package

The "assignedInventorySources" collection of methods.

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

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_BulkEditAssignedInventorySourcesResponse
Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_DisplayVideo_AssignedInventorySource
Creates an assignment between an inventory source and an inventory source group. (assignedInventorySources.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DisplayVideo_DisplayvideoEmpty
Deletes the assignment between an inventory source and an inventory source group. (assignedInventorySources.delete)
listInventorySourceGroupsAssignedInventorySources()  : Google_Service_DisplayVideo_ListAssignedInventorySourcesResponse
Lists inventory sources assigned to an inventory source group.
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 inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.

public bulkEdit(string $inventorySourceGroupId, Google_Service_DisplayVideo_BulkEditAssignedInventorySourcesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_BulkEditAssignedInventorySourcesResponse

(assignedInventorySources.bulkEdit)

Parameters
$inventorySourceGroupId : string

Required. The ID of the inventory source group to which the assignments are assigned.

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

Optional parameters.

Return values
Google_Service_DisplayVideo_BulkEditAssignedInventorySourcesResponse —

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 an inventory source and an inventory source group. (assignedInventorySources.create)

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

Required. The ID of the inventory source group to which the assignment will be assigned.

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

Optional parameters.

Tags
opt_param

string advertiserId The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.

opt_param

string partnerId The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.

Return values
Google_Service_DisplayVideo_AssignedInventorySource —

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 an inventory source and an inventory source group. (assignedInventorySources.delete)

public delete(string $inventorySourceGroupId, string $assignedInventorySourceId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_DisplayvideoEmpty
Parameters
$inventorySourceGroupId : string

Required. The ID of the inventory source group to which this assignment is assigned.

$assignedInventorySourceId : string

Required. The ID of the assigned inventory source to delete.

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

Optional parameters.

Tags
opt_param

string advertiserId The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.

opt_param

string partnerId The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.

Return values
Google_Service_DisplayVideo_DisplayvideoEmpty —

listInventorySourceGroupsAssignedInventorySources()

Lists inventory sources assigned to an inventory source group.

public listInventorySourceGroupsAssignedInventorySources(string $inventorySourceGroupId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_ListAssignedInventorySourcesResponse

(assignedInventorySources.listInventorySourceGroupsAssignedInventorySources)

Parameters
$inventorySourceGroupId : string

Required. The ID of the inventory source group to which these assignments are assigned.

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

Optional parameters.

Tags
opt_param

string filter Allows filtering by assigned inventory source 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: - assignedInventorySourceId 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: * assignedInventorySourceId (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: assignedInventorySourceId 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 ListAssignedInventorySources method. If not specified, the first page of results will be returned.

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 assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.

opt_param

string partnerId The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.

Return values
Google_Service_DisplayVideo_ListAssignedInventorySourcesResponse —

convertToArrayAndStripNulls()

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

Search results