Class AdvertisersResource.InsertionOrdersResource
The "insertionOrders" collection of methods.
Inherited Members
Namespace: Google.Apis.DisplayVideo.v3
Assembly: Google.Apis.DisplayVideo.v3.dll
Syntax
public class AdvertisersResource.InsertionOrdersResource
Constructors
InsertionOrdersResource(IClientService)
Constructs a new resource.
Declaration
public InsertionOrdersResource(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Properties
TargetingTypes
Gets the TargetingTypes resource.
Declaration
public virtual AdvertisersResource.InsertionOrdersResource.TargetingTypesResource TargetingTypes { get; }
Property Value
Type | Description |
---|---|
AdvertisersResource.InsertionOrdersResource.TargetingTypesResource |
Methods
Create(InsertionOrder, long)
Creates a new insertion order. Returns the newly created insertion order if successful.
Declaration
public virtual AdvertisersResource.InsertionOrdersResource.CreateRequest Create(InsertionOrder body, long advertiserId)
Parameters
Type | Name | Description |
---|---|---|
InsertionOrder | body | The body of the request. |
long | advertiserId | Output only. The unique ID of the advertiser the insertion order belongs to. |
Returns
Type | Description |
---|---|
AdvertisersResource.InsertionOrdersResource.CreateRequest |
Delete(long, long)
Deletes an insertion order. Returns error code NOT_FOUND
if the insertion order does not exist. The
insertion order should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED
, to be able
to delete it.
Declaration
public virtual AdvertisersResource.InsertionOrdersResource.DeleteRequest Delete(long advertiserId, long insertionOrderId)
Parameters
Type | Name | Description |
---|---|---|
long | advertiserId | The ID of the advertiser this insertion order belongs to. |
long | insertionOrderId | The ID of the insertion order to delete. |
Returns
Type | Description |
---|---|
AdvertisersResource.InsertionOrdersResource.DeleteRequest |
Get(long, long)
Gets an insertion order. Returns error code NOT_FOUND
if the insertion order does not exist.
Declaration
public virtual AdvertisersResource.InsertionOrdersResource.GetRequest Get(long advertiserId, long insertionOrderId)
Parameters
Type | Name | Description |
---|---|---|
long | advertiserId | Required. The ID of the advertiser this insertion order belongs to. |
long | insertionOrderId | Required. The ID of the insertion order to fetch. |
Returns
Type | Description |
---|---|
AdvertisersResource.InsertionOrdersResource.GetRequest |
List(long)
Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by
entity_status is not specified, insertion orders with ENTITY_STATUS_ARCHIVED
will not be included in
the results.
Declaration
public virtual AdvertisersResource.InsertionOrdersResource.ListRequest List(long advertiserId)
Parameters
Type | Name | Description |
---|---|---|
long | advertiserId | Required. The ID of the advertiser to list insertion orders for. |
Returns
Type | Description |
---|---|
AdvertisersResource.InsertionOrdersResource.ListRequest |
ListAssignedTargetingOptions(long, long)
Lists assigned targeting options of an insertion order across targeting types.
Declaration
public virtual AdvertisersResource.InsertionOrdersResource.ListAssignedTargetingOptionsRequest ListAssignedTargetingOptions(long advertiserId, long insertionOrderId)
Parameters
Type | Name | Description |
---|---|---|
long | advertiserId | Required. The ID of the advertiser the insertion order belongs to. |
long | insertionOrderId | Required. The ID of the insertion order to list assigned targeting options for. |
Returns
Type | Description |
---|---|
AdvertisersResource.InsertionOrdersResource.ListAssignedTargetingOptionsRequest |
Patch(InsertionOrder, long, long)
Updates an existing insertion order. Returns the updated insertion order if successful.
Declaration
public virtual AdvertisersResource.InsertionOrdersResource.PatchRequest Patch(InsertionOrder body, long advertiserId, long insertionOrderId)
Parameters
Type | Name | Description |
---|---|---|
InsertionOrder | body | The body of the request. |
long | advertiserId | Output only. The unique ID of the advertiser the insertion order belongs to. |
long | insertionOrderId | Output only. The unique ID of the insertion order. Assigned by the system. |
Returns
Type | Description |
---|---|
AdvertisersResource.InsertionOrdersResource.PatchRequest |