Show / Hide Table of Contents

Class AdvertisersResource.LineItemsResource

The "lineItems" collection of methods.

Inheritance
object
AdvertisersResource.LineItemsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.DisplayVideo.v2
Assembly: Google.Apis.DisplayVideo.v2.dll
Syntax
public class AdvertisersResource.LineItemsResource

Constructors

LineItemsResource(IClientService)

Constructs a new resource.

Declaration
public LineItemsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

TargetingTypes

Gets the TargetingTypes resource.

Declaration
public virtual AdvertisersResource.LineItemsResource.TargetingTypesResource TargetingTypes { get; }
Property Value
Type Description
AdvertisersResource.LineItemsResource.TargetingTypesResource

Methods

BulkEditAssignedTargetingOptions(BulkEditAssignedTargetingOptionsRequest, long)

Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.

Declaration
public virtual AdvertisersResource.LineItemsResource.BulkEditAssignedTargetingOptionsRequest BulkEditAssignedTargetingOptions(BulkEditAssignedTargetingOptionsRequest body, long advertiserId)
Parameters
Type Name Description
BulkEditAssignedTargetingOptionsRequest body

The body of the request.

long advertiserId

Required. The ID of the advertiser the line items belong to.

Returns
Type Description
AdvertisersResource.LineItemsResource.BulkEditAssignedTargetingOptionsRequest

BulkListAssignedTargetingOptions(long)

Lists assigned targeting options for multiple line items across targeting types.

Declaration
public virtual AdvertisersResource.LineItemsResource.BulkListAssignedTargetingOptionsRequest BulkListAssignedTargetingOptions(long advertiserId)
Parameters
Type Name Description
long advertiserId

Required. The ID of the advertiser the line items belongs to.

Returns
Type Description
AdvertisersResource.LineItemsResource.BulkListAssignedTargetingOptionsRequest

BulkUpdate(BulkUpdateLineItemsRequest, long)

Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.

Declaration
public virtual AdvertisersResource.LineItemsResource.BulkUpdateRequest BulkUpdate(BulkUpdateLineItemsRequest body, long advertiserId)
Parameters
Type Name Description
BulkUpdateLineItemsRequest body

The body of the request.

long advertiserId

Required. The ID of the advertiser this line item belongs to.

Returns
Type Description
AdvertisersResource.LineItemsResource.BulkUpdateRequest

Create(LineItem, long)

Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API.

Declaration
public virtual AdvertisersResource.LineItemsResource.CreateRequest Create(LineItem body, long advertiserId)
Parameters
Type Name Description
LineItem body

The body of the request.

long advertiserId

Output only. The unique ID of the advertiser the line item belongs to.

Returns
Type Description
AdvertisersResource.LineItemsResource.CreateRequest

Delete(long, long)

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. YouTube & Partners line items cannot be created or updated using the API.

Declaration
public virtual AdvertisersResource.LineItemsResource.DeleteRequest Delete(long advertiserId, long lineItemId)
Parameters
Type Name Description
long advertiserId

The ID of the advertiser this line item belongs to.

long lineItemId

The ID of the line item to delete.

Returns
Type Description
AdvertisersResource.LineItemsResource.DeleteRequest

Duplicate(DuplicateLineItemRequest, long, long)

Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Declaration
public virtual AdvertisersResource.LineItemsResource.DuplicateRequest Duplicate(DuplicateLineItemRequest body, long advertiserId, long lineItemId)
Parameters
Type Name Description
DuplicateLineItemRequest body

The body of the request.

long advertiserId

Required. The ID of the advertiser this line item belongs to.

long lineItemId

Required. The ID of the line item to duplicate.

Returns
Type Description
AdvertisersResource.LineItemsResource.DuplicateRequest

GenerateDefault(GenerateDefaultLineItemRequest, long)

Creates a new line item with settings (including targeting) inherited from the insertion order and an ENTITY_STATUS_DRAFT entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API.

Declaration
public virtual AdvertisersResource.LineItemsResource.GenerateDefaultRequest GenerateDefault(GenerateDefaultLineItemRequest body, long advertiserId)
Parameters
Type Name Description
GenerateDefaultLineItemRequest body

The body of the request.

long advertiserId

Required. The ID of the advertiser this line item belongs to.

Returns
Type Description
AdvertisersResource.LineItemsResource.GenerateDefaultRequest

Get(long, long)

Gets a line item.

Declaration
public virtual AdvertisersResource.LineItemsResource.GetRequest Get(long advertiserId, long lineItemId)
Parameters
Type Name Description
long advertiserId

Required. The ID of the advertiser this line item belongs to.

long lineItemId

Required. The ID of the line item to fetch.

Returns
Type Description
AdvertisersResource.LineItemsResource.GetRequest

List(long)

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.

Declaration
public virtual AdvertisersResource.LineItemsResource.ListRequest List(long advertiserId)
Parameters
Type Name Description
long advertiserId

Required. The ID of the advertiser to list line items for.

Returns
Type Description
AdvertisersResource.LineItemsResource.ListRequest

Patch(LineItem, long, long)

Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Declaration
public virtual AdvertisersResource.LineItemsResource.PatchRequest Patch(LineItem body, long advertiserId, long lineItemId)
Parameters
Type Name Description
LineItem body

The body of the request.

long advertiserId

Output only. The unique ID of the advertiser the line item belongs to.

long lineItemId

Output only. The unique ID of the line item. Assigned by the system.

Returns
Type Description
AdvertisersResource.LineItemsResource.PatchRequest
In this article
Back to top Generated by DocFX