Documentation

Google_Service_DisplayVideo_Resource_InventorySourceGroups extends Google_Service_Resource
in package

The "inventorySourceGroups" collection of methods.

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

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_InventorySourceGroup
Creates a new inventory source group. Returns the newly created inventory source group if successful. (inventorySourceGroups.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DisplayVideo_DisplayvideoEmpty
Deletes an inventory source group. (inventorySourceGroups.delete)
get()  : Google_Service_DisplayVideo_InventorySourceGroup
Gets an inventory source group. (inventorySourceGroups.get)
listInventorySourceGroups()  : Google_Service_DisplayVideo_ListInventorySourceGroupsResponse
Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
patch()  : Google_Service_DisplayVideo_InventorySourceGroup
Updates an inventory source group. Returns the updated inventory source group if successful. (inventorySourceGroups.patch)
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 inventory source group. Returns the newly created inventory source group if successful. (inventorySourceGroups.create)

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

Optional parameters.

Tags
opt_param

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

opt_param

string partnerId The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.

Return values
Google_Service_DisplayVideo_InventorySourceGroup —

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

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

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

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

Optional parameters.

Tags
opt_param

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

opt_param

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

Return values
Google_Service_DisplayVideo_DisplayvideoEmpty —

get()

Gets an inventory source group. (inventorySourceGroups.get)

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

Required. The ID of the inventory source group 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 inventory source group. A partner cannot access an advertiser-owned inventory source group.

opt_param

string advertiserId The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.

Return values
Google_Service_DisplayVideo_InventorySourceGroup —

listInventorySourceGroups()

Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.

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

(inventorySourceGroups.listInventorySourceGroups)

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

Optional parameters.

Tags
opt_param

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

opt_param

string advertiserId The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.

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 ListInventorySources 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.

opt_param

string filter Allows filtering by inventory source group properties. 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: - inventorySourceGroupId The length of this field should be no more than 500 characters.

opt_param

string partnerId The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.

Return values
Google_Service_DisplayVideo_ListInventorySourceGroupsResponse —

patch()

Updates an inventory source group. Returns the updated inventory source group if successful. (inventorySourceGroups.patch)

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

Output only. The unique ID of the inventory source group. Assigned by the system.

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

Optional parameters.

Tags
opt_param

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

opt_param

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

opt_param

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

Return values
Google_Service_DisplayVideo_InventorySourceGroup —

convertToArrayAndStripNulls()

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

Search results