Show / Hide Table of Contents

Class Proposal

A Proposal represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.

Inheritance
object
Proposal
Implements
IMessage<Proposal>
IEquatable<Proposal>
IDeepCloneable<Proposal>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public sealed class Proposal : IMessage<Proposal>, IEquatable<Proposal>, IDeepCloneable<Proposal>, IBufferMessage, IMessage

Constructors

Proposal()

Declaration
public Proposal()

Proposal(Proposal)

Declaration
public Proposal(Proposal other)
Parameters
Type Name Description
Proposal other

Properties

Advertiser

Required. The resource name of the [Company][google.ads.admanager.v1.Company] of type [ADVERTISER][google.ads.admanager.v1.CompanyTypeEnum.CompanyType.ADVERTISER] to which this Proposal belongs. This attribute is required when the proposal turns into an order, and will be copied to [Order.advertiser][google.ads.admanager.v1.Order.advertiser]. This attribute becomes read-only once the Proposal has been pushed. Format: networks/{network_code}/companies/{company_id}

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

AdvertiserAsCompanyName

CompanyName-typed view over the Advertiser resource name property.

Declaration
public CompanyName AdvertiserAsCompanyName { get; set; }
Property Value
Type Description
CompanyName

Agencies

Optional. List of agencies and the set of [Contacts][google.ads.admanager.v1.Contact] associated with each agency. A Proposal can have at most one [Company][google.ads.admanager.v1.Company] with [PRIMARY_AGENCY][google.ads.admanager.v1.ProposalCompanyAssociationTypeEnum.ProposalCompanyAssociationType.PRIMARY_AGENCY] type, but a [Company][google.ads.admanager.v1.Company] can appear more than once with different [ProposalCompanyAssociationType][google.ads.admanager.v1.ProposalCompanyAssociationTypeEnum.ProposalCompanyAssociationType] values. If a primary agency exists, its [ProposalCompanyAssociation.company][google.ads.admanager.v1.ProposalCompanyAssociation.company] will be copied to [Order.agency][google.ads.admanager.v1.Order.agency] when the proposal turns into an order.

Declaration
public RepeatedField<ProposalCompanyAssociation> Agencies { get; }
Property Value
Type Description
RepeatedField<ProposalCompanyAssociation>

AppliedLabels

Optional. The set of labels applied directly to the Proposal.

Declaration
public RepeatedField<AppliedLabel> AppliedLabels { get; }
Property Value
Type Description
RepeatedField<AppliedLabel>

AppliedTeams

Optional. The resource names of the teams directly applied to the Proposal. Format: networks/{network_code}/teams/{team_id}

Declaration
public RepeatedField<string> AppliedTeams { get; }
Property Value
Type Description
RepeatedField<string>

AppliedTeamsAsTeamNames

TeamName-typed view over the AppliedTeams resource name property.

Declaration
public ResourceNameList<TeamName> AppliedTeamsAsTeamNames { get; }
Property Value
Type Description
ResourceNameList<TeamName>

Archived

Output only. Whether the Proposal is archived or not.

Declaration
public bool Archived { get; set; }
Property Value
Type Description
bool

BuyerRfp

Output only. The buyer RFP associated with this Proposal. This field will be unset if the proposal is not initiated from an RFP.

Declaration
public BuyerRfp BuyerRfp { get; set; }
Property Value
Type Description
BuyerRfp

CurrencyCode

Optional. The currency code of this Proposal. If not directly set, the currency code will be the network's currency code.

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

CustomFieldValues

Optional. The values of the custom fields associated with the Proposal.

Declaration
public RepeatedField<CustomFieldValue> CustomFieldValues { get; }
Property Value
Type Description
RepeatedField<CustomFieldValue>

DeliveryPausingEnabled

Optional. Non-empty default. Whether delivery of the Proposal can be paused. Defaults to true. If false, the buyer and the seller agree that the Proposal should not be paused.

Declaration
public bool DeliveryPausingEnabled { get; set; }
Property Value
Type Description
bool

DisplayName

Required. The display name of the Proposal. This value has a maximum length of 255 characters. This value is copied to [Order.displayName][google.ads.admanager.v1.Order.display_name] when the proposal turns into an order.

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

EffectiveAppliedLabels

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

Declaration
public RepeatedField<AppliedLabel> EffectiveAppliedLabels { get; }
Property Value
Type Description
RepeatedField<AppliedLabel>

EndTime

Output only. The time at which the [Order][google.ads.admanager.v1.Order] and [LineItems][google.ads.admanager.v1.LineItem] associated with the Proposal stop serving. This attribute is derived from the [ProposalLineItem][] with the latest [endTime][ProposalLineItem.end_time]. This attribute will be empty if this Proposal has no associated [ProposalLineItems][ProposalLineItem] or if none of its [ProposalLineItems][ProposalLineItem] have an end time.

Declaration
public Timestamp EndTime { get; set; }
Property Value
Type Description
Timestamp

HasAdvertiser

Gets whether the "advertiser" field is set

Declaration
public bool HasAdvertiser { get; }
Property Value
Type Description
bool

HasArchived

Gets whether the "archived" field is set

Declaration
public bool HasArchived { get; }
Property Value
Type Description
bool

HasDeliveryPausingEnabled

Gets whether the "delivery_pausing_enabled" field is set

Declaration
public bool HasDeliveryPausingEnabled { get; }
Property Value
Type Description
bool

HasDisplayName

Gets whether the "display_name" field is set

Declaration
public bool HasDisplayName { get; }
Property Value
Type Description
bool

HasNotes

Gets whether the "notes" field is set

Declaration
public bool HasNotes { get; }
Property Value
Type Description
bool

HasOrder

Gets whether the "order" field is set

Declaration
public bool HasOrder { get; }
Property Value
Type Description
bool

HasPrimarySalesperson

Gets whether the "primary_salesperson" field is set

Declaration
public bool HasPrimarySalesperson { get; }
Property Value
Type Description
bool

HasSold

Gets whether the "sold" field is set

Declaration
public bool HasSold { get; }
Property Value
Type Description
bool

HasSupplyPath

Gets whether the "supply_path" field is set

Declaration
public bool HasSupplyPath { get; }
Property Value
Type Description
bool

HasTrafficker

Gets whether the "trafficker" field is set

Declaration
public bool HasTrafficker { get; }
Property Value
Type Description
bool

MarketplaceInfo

Optional. The marketplace info of this Proposal if it has a corresponding Order in Marketplace.

Declaration
public ProposalMarketplaceInfo MarketplaceInfo { get; set; }
Property Value
Type Description
ProposalMarketplaceInfo

Name

Identifier. The resource name of the Proposal. Format: networks/{network_code}/proposals/{proposal_id}

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

Notes

Optional. Provides any additional notes that may annotate the Proposal. This attribute has a maximum length of 65,535 characters.

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

Order

Output only. The resource name of the corresponding Order. This will not be set if the Proposal has not been pushed to Ad Manager. Format: networks/{network_code}/orders/{order_id}

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

OrderAsOrderName

OrderName-typed view over the Order resource name property.

Declaration
public OrderName OrderAsOrderName { get; set; }
Property Value
Type Description
OrderName

PrimarySalesperson

Optional. The resource name of the [User][google.ads.admanager.v1.User] representing the primary salesperson who brokered the transaction with the [advertiser][google.ads.admanager.v1.Proposal.advertiser]. This attribute is required when the proposal turns into an order. Format: networks/{network_code}/users/{user_id}

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

PrimarySalespersonAsUserName

UserName-typed view over the PrimarySalesperson resource name property.

Declaration
public UserName PrimarySalespersonAsUserName { get; set; }
Property Value
Type Description
UserName

ProposalName

ProposalName-typed view over the Name resource name property.

Declaration
public ProposalName ProposalName { get; set; }
Property Value
Type Description
ProposalName

SalesPlannerUsers

Optional. The resource names of the [Users][google.ads.admanager.v1.User] representing the sales planners of the Proposal. A Proposal can have at most 8 sales planners. Format: networks/{network_code}/users/{user_id}

Declaration
public RepeatedField<string> SalesPlannerUsers { get; }
Property Value
Type Description
RepeatedField<string>

SalesPlannerUsersAsUserNames

UserName-typed view over the SalesPlannerUsers resource name property.

Declaration
public ResourceNameList<UserName> SalesPlannerUsersAsUserNames { get; }
Property Value
Type Description
ResourceNameList<UserName>

SellerContactUsers

Optional. The resource names of the [Users][google.ads.admanager.v1.User] who are the seller's contacts. Format: networks/{network_code}/users/{user_id}

Declaration
public RepeatedField<string> SellerContactUsers { get; }
Property Value
Type Description
RepeatedField<string>

SellerContactUsersAsUserNames

UserName-typed view over the SellerContactUsers resource name property.

Declaration
public ResourceNameList<UserName> SellerContactUsersAsUserNames { get; }
Property Value
Type Description
ResourceNameList<UserName>

Sold

Output only. Indicates whether the proposal has been sold, i.e., corresponds to whether the status of an Order is [APPROVED][google.ads.admanager.v1.OrderStatusEnum.OrderStatus.APPROVED] or [PAUSED][google.ads.admanager.v1.OrderStatusEnum.OrderStatus.PAUSED].

Declaration
public bool Sold { get; set; }
Property Value
Type Description
bool

StartTime

Output only. The time at which the [Order][google.ads.admanager.v1.Order] and [LineItems][google.ads.admanager.v1.LineItem] associated with the Proposal are eligible to begin serving. This attribute is derived from the [ProposalLineItem][] with the earliest [startTime][ProposalLineItem.start_time]. This attribute will be empty if this Proposal has no associated [ProposalLineItems][ProposalLineItem] or if none of its [ProposalLineItems][ProposalLineItem] have a start time.

Declaration
public Timestamp StartTime { get; set; }
Property Value
Type Description
Timestamp

SupplyPath

Optional. Non-empty default. The supply path type of this Proposal. If no value is provided on creation, defaults to [DEMAND_SIDE_PLATFORM][google.ads.admanager.v1.SupplyPathTypeEnum.SupplyPathType.DEMAND_SIDE_PLATFORM].

Declaration
public SupplyPathTypeEnum.Types.SupplyPathType SupplyPath { get; set; }
Property Value
Type Description
SupplyPathTypeEnum.Types.SupplyPathType

Trafficker

Optional. The resource name of the [User][google.ads.admanager.v1.User] who is the primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to [Order.trafficker][google.ads.admanager.v1.Order.trafficker]. Format: networks/{network_code}/users/{user_id}

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

TraffickerAsUserName

UserName-typed view over the Trafficker resource name property.

Declaration
public UserName TraffickerAsUserName { get; set; }
Property Value
Type Description
UserName

UpdateTime

Output only. The time this Proposal was last modified.

Declaration
public Timestamp UpdateTime { get; set; }
Property Value
Type Description
Timestamp
In this article
Back to top Generated by DocFX