Note: Version v201902 will be sunset soon. All users of those versions must migrate to a newer one.

ProposalService (v201905)

Provides methods for adding, updating and retrieving Proposal objects.


Production WSDL
https://ads.google.com/apis/ads/publisher/v201905/ProposalService?wsdl
Namespace
https://www.google.com/apis/ads/publisher/v201905
Operations
Errors

createProposals

Creates new Proposal objects. For each proposal, the following fields are required:

Parameters

Field Type Description
proposals Proposal[] the proposals to create

Response

Field Type Description
rval Proposal[] the created proposals with their IDs filled in

getMarketplaceCommentsByStatement

Gets a MarketplaceCommentPage of MarketplaceComment objects that satisfy the given Statement.query. This method only returns comments already sent to Marketplace, local draft ProposalMarketplaceInfo.marketplaceComment are not included. The following fields are supported for filtering:

PQL Property Object Property
proposalId MarketplaceComment.proposalId
The query must specify a proposalId, and only supports a subset of PQL syntax:
[WHERE <condition> {AND <condition> ...}]
[ORDER BY <property> [ASC | DESC]]
[LIMIT {[<offset>,] <count>} | {<count> OFFSET <offset>}]

<condition>
     := <property> = <value>
<condition> := <property> IN <list>
Only supports ORDER BY MarketplaceComment.creationTime.

Parameters

Field Type Description
filterStatement Statement a Publisher Query Language statement used to filter a set of marketplace comments

Response

Field Type Description
rval MarketplaceCommentPage the marketplace comments that match the given filter

getProposalsByStatement

Gets a ProposalPage of Proposal objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property Object Property
id Proposal.id
dfpOrderId Proposal.dfpOrderId
name Proposal.name
status Proposal.status
isArchived Proposal.isArchived
approvalStatus
Only applicable for proposals using sales management
Proposal.approvalStatus
lastModifiedDateTime Proposal.lastModifiedDateTime
thirdPartyAdServerId
Only applicable for non-programmatic proposals using sales management
Proposal.thirdPartyAdServerId
customThirdPartyAdServerName
Only applicable for non-programmatic proposals using sales management
Proposal.customThirdPartyAdServerName
hasOfflineErrors Proposal.hasOfflineErrors
isProgrammatic Proposal.isProgrammatic
negotiationStatus
Only applicable for programmatic proposals
ProposalMarketplaceInfo.negotiationStatus

Parameters

Field Type Description
filterStatement Statement a Publisher Query Language statement used to filter a set of proposals

Response

Field Type Description
rval ProposalPage the proposals that match the given filter

performProposalAction

Performs actions on Proposal objects that match the given Statement.query. The following fields are also required when submitting proposals for approval:

Parameters

Field Type Description
proposalAction
  1. ProposalAction
    1. ArchiveProposals
    2. BypassProposalWorkflowRules
    3. CancelRetractionForProposals
    4. DiscardLocalVersionEdits
    5. EditProposalsForNegotiation
    6. PauseProposals
    7. RequestBuyerAcceptance
    8. RequestBuyerReview
    9. ReserveProposals
    10. ResumeProposals
    11. RetractProposals
    12. SubmitProposalsForApprovalB...
    13. SubmitProposalsForApproval
    14. SubmitProposalsForArchival
    15. TerminateNegotiations
    16. UnarchiveProposals
    17. UpdateOrderWithSellerData
the action to perform
filterStatement Statement a Publisher Query Language statement used to filter a set of proposals

Response

Field Type Description
rval UpdateResult the result of the action performed

updateProposals

Updates the specified Proposal objects.

Parameters

Field Type Description
proposals Proposal[] the proposals to update

Response

Field Type Description
rval Proposal[] the updated proposals

Errors

Error Reasons
ApiVersionError Errors related to the usage of API versions.
Enumerations
UPDATE_TO_NEWER_VERSION
Indicates that the operation is not allowed in the version the request was made in.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
AudienceSegmentError Errors that could occur on audience segment related requests.
Enumerations
FIRST_PARTY_AUDIENCE_SEGMENT_NOT_SUPPORTED
First party audience segment is not supported.
ONLY_RULE_BASED_FIRST_PARTY_AUDIENCE_SEGMENTS_CAN_BE_CREATED
Only rule-based first-party audience segments can be created.
AUDIENCE_SEGMENT_ID_NOT_FOUND
Audience segment for the given id is not found.
INVALID_AUDIENCE_SEGMENT_RULE
Audience segment rule is invalid.
AUDIENCE_SEGMENT_RULE_TOO_LONG
Audience segment rule contains too many ad units and/or custom criteria.
INVALID_AUDIENCE_SEGMENT_NAME
Audience segment name is invalid.
DUPLICATE_AUDIENCE_SEGMENT_NAME
Audience segment with this name already exists.
INVALID_AUDIENCE_SEGMENT_DESCRIPTION
Audience segment description is invalid.
INVALID_AUDIENCE_SEGMENT_PAGEVIEWS
Audience segment pageviews value is invalid. It must be between 1 and 12.
INVALID_AUDIENCE_SEGMENT_RECENCY
Audience segment recency value is invalid. It must be between 1 and 90 if pageviews > 1.
INVALID_AUDIENCE_SEGMENT_MEMBERSHIP_EXPIRATION
Audience segment membership expiration value is invalid. It must be between 1 and 180.
INVALID_AUDIENCE_SEGMENT_CUSTOM_KEY_NAME
The given custom key cannot be part of audience segment rule due to unsupported characters.
INVALID_AUDIENCE_SEGMENT_CUSTOM_VALUE_NAME
The given custom value cannot be part of audience segment rule due to unsupported characters.
INVALID_AUDIENCE_SEGMENT_CUSTOM_VALUE_MATCH_TYPE
Broad-match custom value cannot be part of audience segment rule.
INVALID_NESTED_FIRST_PARTY_AUDIENCE_SEGMENT
Audience segment rule cannot contain itself.
INVALID_NESTED_THIRD_PARTY_AUDIENCE_SEGMENT
Audience segment rule cannot contain a nested third-party segment.
INACTIVE_NESTED_AUDIENCE_SEGMENT
Audience segment rule cannot contain a nested inactive segment.
AUDIENCE_SEGMENT_GLOBAL_LICENSE_ERROR
An error occured when purchasing global licenses.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
AuthenticationError An error for an exception that occurred when authenticating.
Enumerations
AMBIGUOUS_SOAP_REQUEST_HEADER
The SOAP message contains a request header with an ambiguous definition of the authentication header fields. This means either the authToken and oAuthToken fields were both null or both were specified. Exactly one value should be specified with each request.
INVALID_EMAIL
The login provided is invalid.
AUTHENTICATION_FAILED
Tried to authenticate with provided information, but failed.
INVALID_OAUTH_SIGNATURE
The OAuth provided is invalid.
INVALID_SERVICE
The specified service to use was not recognized.
MISSING_SOAP_REQUEST_HEADER
The SOAP message is missing a request header with an authToken and optional networkCode.
MISSING_AUTHENTICATION_HTTP_HEADER
The HTTP request is missing a request header with an authToken
MISSING_AUTHENTICATION
The request is missing an authToken
NOT_WHITELISTED_FOR_API_ACCESS
The customer is not whitelisted for API access.
NO_NETWORKS_TO_ACCESS
The user is not associated with any network.
NETWORK_NOT_FOUND
No network for the given networkCode was found.
NETWORK_CODE_REQUIRED
The user has access to more than one network, but did not provide a networkCode.
CONNECTION_ERROR
An error happened on the server side during connection to authentication service.
GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK
The user tried to create a test network using an account that already is associated with a network.
UNDER_INVESTIGATION
The account is blocked and under investigation by the collections team. Please contact Google for more information.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
AvailableBillingError Lists all errors associated with the availability of billing settings based on proposal network settings.
Enumerations
BILLING_SOURCE_IS_NOT_AVAILABLE
The billing source provided is not available in proposal network settings.
BILLING_SCHEDULE_IS_NOT_AVAILABLE
The billing schedule provided is not available in proposal network settings.
BILLING_CAP_IS_NOT_AVAILABLE
The billing cap provided is not available in proposal network settings.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
BillingError Lists all errors associated with the billing settings of a proposal or proposal line item.
Enumerations
UNSUPPORTED_BILLING_SCHEDULE
Found unsupported billing schedule.
UNSUPPORTED_BILLING_CAP
Found unsupported billing cap.
MISSING_BILLING_SOURCE
Billing source is missing when either billing scheule or billing cap is provided.
MISSING_BILLING_SCHEDULE
Billing schedule is missing when the provided billing source is CONSTRACTED.
MISSING_BILLING_CAP
Billing cap is missing when the provided billing source is not CONSTRACTED.
INVALID_BILLING_SOURCE_FOR_OFFLINE
The billing source is invalid for offline proposal line item.
UPDATE_BILLING_NOT_ALLOWED
Billing settings cannot be updated once the proposal has been approved.
MISSING_BILLING_BASE
Billing base is missing when the provided billing source is CONTRACTED.
INVALID_BILLING_BASE
The billing base is invalid for the provided billing source.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CollectionSizeError Error for the size of the collection being too large
Enumerations
TOO_LARGE
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CommonError A place for common errors that can be used across services.
Enumerations
NOT_FOUND
Indicates that an attempt was made to retrieve an entity that does not exist.
ALREADY_EXISTS
Indicates that an attempt was made to create an entity that already exists.
NOT_APPLICABLE
Indicates that a value is not applicable for given use case.
DUPLICATE_OBJECT
Indicates that two elements in the collection were identical.
CANNOT_UPDATE
Indicates that an attempt was made to change an immutable field.
CONCURRENT_MODIFICATION
Indicates that another request attempted to update the same data in the same network at about the same time. Please wait and try the request again.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CustomFieldValueError Errors specific to editing custom field values
Enumerations
CUSTOM_FIELD_NOT_FOUND
An attempt was made to modify or create a CustomFieldValue for a CustomField that does not exist.
CUSTOM_FIELD_INACTIVE
An attempt was made to create a new value for a custom field that is inactive.
CUSTOM_FIELD_OPTION_NOT_FOUND
An attempt was made to modify or create a CustomFieldValue corresponding to a CustomFieldOption that could not be found.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
DealError Errors associated with creating or updating programmatic proposals.
Enumerations
CANNOT_ADD_LINE_ITEM_WHEN_SOLD
Cannot add new proposal line items to a Proposal when Proposal.isSold is true.
CANNOT_ARCHIVE_LINE_ITEM_WHEN_SOLD
Cannot archive proposal line items from a Proposal when Proposal.isSold is true.
CANNOT_ARCHIVE_PROPOSAL_WHEN_SOLD
Cannot archive a Proposal when Proposal.isSold is true.
CANNOT_CHANGE_FIELD_REQUIRING_BUYER_APPROVAL
Cannot change a field that requires buyer approval during the current operation.
CANNOT_GET_SELLER_ID
Cannot find seller ID for the Proposal.
CAN_ONLY_EXECUTE_IF_LOCAL_EDITS
Proposal must be marked as editable by EditProposalsForNegotiation before performing requested action.
MISSING_PROPOSAL_LINE_ITEMS
Proposal contains no proposal line items.
MISSING_ENVIRONMENT
No environment set for Proposal.
MISSING_AD_EXCHANGE_PROPERTY </