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

ProposalLineItemService (v201905)

Provides methods for creating, updating and retrieving ProposalLineItem objects.

To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in DoubleClick for Publishers (DFP), you will not be able to use this service.


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

createProposalLineItems

Creates new ProposalLineItem objects.

Parameters

Field Type Description
proposalLineItems ProposalLineItem[] the proposal line items to create

Response

Field Type Description
rval ProposalLineItem[] the created proposal line items with their IDs filled in

getProposalLineItemsByStatement

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

PQL Property Object Property
id ProposalLineItem.id
name ProposalLineItem.name
proposalId ProposalLineItem.proposalId
startDateTime ProposalLineItem.startDateTime
endDateTime ProposalLineItem.endDateTime
isArchived ProposalLineItem.isArchived
lastModifiedDateTime ProposalLineItem.lastModifiedDateTime
useThirdPartyAdServerFromProposal
Only applicable for non-programmatic proposal line items using sales management
ProposalLineItem.useThirdPartyAdServerFromProposal
thirdPartyAdServerId
Only applicable for non-programmatic proposal line items using sales management
ProposalLineItem.thirdPartyAdServerId
customThirdPartyAdServerName
Only applicable for non-programmatic proposal line items using sales management
ProposalLineItem.customThirdPartyAdServerName
isProgrammatic ProposalLineItem.isProgrammatic

Parameters

Field Type Description
filterStatement Statement a Publisher Query Language statement used to filter a set of proposal line items

Response

Field Type Description
rval ProposalLineItemPage the proposal line items that match the given filter

performProposalLineItemAction

Performs actions on ProposalLineItem objects that match the given Statement.query.

Parameters

Field Type Description
proposalLineItemAction
  1. ProposalLineItemAction
    1. ActualizeProposalLineItems
    2. ArchiveProposalLineItems
    3. PauseProposalLineItems
    4. ReleaseProposalLineItems
    5. ReserveProposalLineItems
    6. ResumeProposalLineItems
    7. UnarchiveProposalLineItems
    8. UnlinkProposalLineItems
the action to perform
filterStatement Statement a Publisher Query Language statement used to filter a set of proposal line items

Response

Field Type Description
rval UpdateResult the result of the action performed

updateProposalLineItems

Updates the specified ProposalLineItem objects.

Parameters

Field Type Description
proposalLineItems ProposalLineItem[] the proposal line items to update

Response

Field Type Description
rval ProposalLineItem[] the updated proposal line items

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.
ContentMetadataTargetingError Lists all errors related to ContentMetadataTargeting.
Enumerations
VALUES_DO_NOT_BELONG_TO_A_HIERARCHY
One or more of the values specified in a ContentMetadataHierarchyTargeting do not belong to the keys defined in any of the hierarchies on the network.
CONTENT_METADATA_TARGETING_DEPRECATED
Content metadata targeting is deprecated.
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.
CustomTargetingError Lists all errors related to CustomTargetingKey and CustomTargetingValue objects.
Enumerations
KEY_NOT_FOUND
Requested CustomTargetingKey is not found.
KEY_COUNT_TOO_LARGE
Number of CustomTargetingKey objects created exceeds the limit allowed for the network.
KEY_NAME_DUPLICATE
CustomTargetingKey with the same CustomTargetingKey.name already exists.
KEY_NAME_EMPTY
CustomTargetingKey.name is empty.
KEY_NAME_INVALID_LENGTH
CustomTargetingKey.name is too long.
KEY_NAME_INVALID_CHARS
CustomTargetingKey.name contains unsupported or reserved characters.
KEY_NAME_RESERVED
CustomTargetingKey.name matches one of the reserved custom targeting key names.
KEY_DISPLAY_NAME_INVALID_LENGTH
CustomTargetingKey.displayName is too long.
VALUE_NOT_FOUND
Requested CustomTargetingValue is not found.
GET_VALUES_BY_STATEMENT_MUST_CONTAIN_KEY_ID
The WHERE clause in the Statement.query must always contain CustomTargetingValue.customTargetingKeyId as one of its columns in a way that it is AND'ed with the rest of the query.
VALUE_COUNT_FOR_KEY_TOO_LARGE
The number of CustomTargetingValue objects associated with a CustomTargetingKey exceeds the network limit. This is only applicable for keys of type CustomTargetingKey.Type#PREDEFINED.
VALUE_NAME_DUPLICATE
CustomTargetingValue with the same CustomTargetingValue.name already exists.
VALUE_NAME_EMPTY
CustomTargetingValue.name is empty.
VALUE_NAME_INVALID_LENGTH
CustomTargetingValue.name is too long.
VALUE_NAME_INVALID_CHARS
CustomTargetingValue.name contains unsupported or reserved characters.
VALUE_DISPLAY_NAME_INVALID_LENGTH
CustomTargetingValue.displayName is too long.
VALUE_MATCH_TYPE_NOT_ALLOWED
Only Ad Manager 360 networks can have