Documentation

Google_Service_DisplayVideo_Resource_AdvertisersLineItems extends Google_Service_Resource
in package

Application

The "lineItems" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
bulkEditLineItemAssignedTargetingOptions() : Google_Service_DisplayVideo_BulkEditLineItemAssignedTargetingOptionsResponse: Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .
bulkListLineItemAssignedTargetingOptions() : Google_Service_DisplayVideo_BulkListLineItemAssignedTargetingOptionsResponse: Lists assigned targeting options of a line item across targeting types.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_DisplayVideo_LineItem: Creates a new line item. Returns the newly created line item if successful.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_DisplayVideo_DisplayvideoEmpty: Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. (lineItems.delete)
get() : Google_Service_DisplayVideo_LineItem: Gets a line item. (lineItems.get)
listAdvertisersLineItems() : Google_Service_DisplayVideo_ListLineItemsResponse: Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
patch() : Google_Service_DisplayVideo_LineItem: Updates an existing line item. Returns the updated line item if successful.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

bulkEditLineItemAssignedTargetingOptions()

Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .


    public
                bulkEditLineItemAssignedTargetingOptions(string $advertiserId, string $lineItemId, Google_Service_DisplayVideo_BulkEditLineItemAssignedTargetingOptionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_BulkEditLineItemAssignedTargetingOptionsResponse

(lineItems.bulkEditLineItemAssignedTargetingOptions)

Parameters

$advertiserId : string: Required. The ID of the advertiser the line item belongs to.
$lineItemId : string: Required. The ID of the line item the assigned targeting option will belong to.
$postBody : Google_Service_DisplayVideo_BulkEditLineItemAssignedTargetingOptionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_BulkEditLineItemAssignedTargetingOptionsResponse —

bulkListLineItemAssignedTargetingOptions()

Lists assigned targeting options of a line item across targeting types.


    public
                bulkListLineItemAssignedTargetingOptions(string $advertiserId, string $lineItemId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_BulkListLineItemAssignedTargetingOptionsResponse

(lineItems.bulkListLineItemAssignedTargetingOptions)

Parameters

$advertiserId : string: Required. The ID of the advertiser the line item belongs to.
$lineItemId : string: Required. The ID of the line item to list assigned targeting options for.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_BulkListLineItemAssignedTargetingOptionsResponse —

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

Return values

Google_Http_Request|expectedClass —

create()

Creates a new line item. Returns the newly created line item if successful.


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

(lineItems.create)

Parameters

$advertiserId : string: Output only. The unique ID of the advertiser the line item belongs to.
$postBody : Google_Service_DisplayVideo_LineItem
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_LineItem —

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>

Return values

string —

$requestUrl

delete()

Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. (lineItems.delete)


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

Parameters

$advertiserId : string: The ID of the advertiser this line item belongs to.
$lineItemId : string: The ID of the line item we need to fetch.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_DisplayvideoEmpty —

get()

Gets a line item. (lineItems.get)


    public
                get(string $advertiserId, string $lineItemId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_LineItem

Parameters

$advertiserId : string: Required. The ID of the advertiser this line item belongs to.
$lineItemId : string: Required. The ID of the line item to fetch.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_LineItem —

listAdvertisersLineItems()

Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.


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

(lineItems.listAdvertisersLineItems)

Parameters

$advertiserId : string: Required. The ID of the advertiser to list line items for.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_ListLineItemsResponse —

patch()

Updates an existing line item. Returns the updated line item if successful.


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

(lineItems.patch)

Parameters

$advertiserId : string: Output only. The unique ID of the advertiser the line item belongs to.
$lineItemId : string: Output only. The unique ID of the line item. Assigned by the system.
$postBody : Google_Service_DisplayVideo_LineItem
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_LineItem —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —