Class AdvertisersResource.LineItemsResource
The "lineItems" collection of methods.
Inherited Members
Namespace: Google.Apis.DisplayVideo.v1
Assembly: Google.Apis.DisplayVideo.v1.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
BulkEditLineItemAssignedTargetingOptions(BulkEditLineItemAssignedTargetingOptionsRequest, long, long)
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. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.
Declaration
public virtual AdvertisersResource.LineItemsResource.BulkEditLineItemAssignedTargetingOptionsRequest BulkEditLineItemAssignedTargetingOptions(BulkEditLineItemAssignedTargetingOptionsRequest body, long advertiserId, long lineItemId)
Parameters
Type | Name | Description |
---|---|---|
BulkEditLineItemAssignedTargetingOptionsRequest | body | The body of the request. |
long | advertiserId | Required. The ID of the advertiser the line item belongs to. |
long | lineItemId | Required. The ID of the line item the assigned targeting option will belong to. |
Returns
Type | Description |
---|---|
AdvertisersResource.LineItemsResource.BulkEditLineItemAssignedTargetingOptionsRequest |
BulkListLineItemAssignedTargetingOptions(long, long)
Lists assigned targeting options of a line item across targeting types.
Declaration
public virtual AdvertisersResource.LineItemsResource.BulkListLineItemAssignedTargetingOptionsRequest BulkListLineItemAssignedTargetingOptions(long advertiserId, long lineItemId)
Parameters
Type | Name | Description |
---|---|---|
long | advertiserId | Required. The ID of the advertiser the line item belongs to. |
long | lineItemId | Required. The ID of the line item to list assigned targeting options for. |
Returns
Type | Description |
---|---|
AdvertisersResource.LineItemsResource.BulkListLineItemAssignedTargetingOptionsRequest |
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 |
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.
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 |