Show / Hide Table of Contents

Class GuaranteedOrder

A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.

Inheritance
object
GuaranteedOrder
Implements
IDirectResponseSchema
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.v1.Data
Assembly: Google.Apis.DisplayVideo.v1.dll
Syntax
public class GuaranteedOrder : IDirectResponseSchema

Properties

DefaultAdvertiserId

Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.

Declaration
[JsonProperty("defaultAdvertiserId")]
public virtual long? DefaultAdvertiserId { get; set; }
Property Value
Type Description
long?

DefaultCampaignId

The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.

Declaration
[JsonProperty("defaultCampaignId")]
public virtual long? DefaultCampaignId { get; set; }
Property Value
Type Description
long?

DisplayName

Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Exchange

Required. Immutable. The exchange where the guaranteed order originated.

Declaration
[JsonProperty("exchange")]
public virtual string Exchange { get; set; }
Property Value
Type Description
string

GuaranteedOrderId

Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format {exchange}-{legacy_guaranteed_order_id}.

Declaration
[JsonProperty("guaranteedOrderId")]
public virtual string GuaranteedOrderId { get; set; }
Property Value
Type Description
string

LegacyGuaranteedOrderId

Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.

Declaration
[JsonProperty("legacyGuaranteedOrderId")]
public virtual string LegacyGuaranteedOrderId { get; set; }
Property Value
Type Description
string

Name

Output only. The resource name of the guaranteed order.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PublisherName

Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.

Declaration
[JsonProperty("publisherName")]
public virtual string PublisherName { get; set; }
Property Value
Type Description
string

ReadAccessInherited

Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.

Declaration
[JsonProperty("readAccessInherited")]
public virtual bool? ReadAccessInherited { get; set; }
Property Value
Type Description
bool?

ReadAdvertiserIds

The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.

Declaration
[JsonProperty("readAdvertiserIds")]
public virtual IList<long?> ReadAdvertiserIds { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><long?>

ReadWriteAdvertiserId

The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.

Declaration
[JsonProperty("readWriteAdvertiserId")]
public virtual long? ReadWriteAdvertiserId { get; set; }
Property Value
Type Description
long?

ReadWritePartnerId

The partner with read/write access to the guaranteed order.

Declaration
[JsonProperty("readWritePartnerId")]
public virtual long? ReadWritePartnerId { get; set; }
Property Value
Type Description
long?

Status

The status settings of the guaranteed order.

Declaration
[JsonProperty("status")]
public virtual GuaranteedOrderStatus Status { get; set; }
Property Value
Type Description
GuaranteedOrderStatus

UpdateTime

Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.

Declaration
[JsonProperty("updateTime")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX