WorkflowRequestService (v201902)

Provides methods to retrieve and perform actions on WorkflowRequest 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/v201902/WorkflowRequestService?wsdl

Namespace

https://www.google.com/apis/ads/publisher/v201902

Operations

• getWorkflowRequestsByStatement
• performWorkflowRequestAction

Errors

• ApiVersionError
• AuthenticationError
• CollectionSizeError
• CommonError
• CustomTargetingError
• FeatureError
• ForecastError
• InternalApiError
• LineItemOperationError
• NotNullError
• ParseError
• PermissionError
• ProposalActionError
• ProposalLineItemActionError
• PublisherQueryLanguageContextError
• PublisherQueryLanguageSyntaxError
• QuotaError
• RequiredCollectionError
• RequiredError
• ServerError
• StatementError
• StringFormatError
• StringLengthError
• WorkflowActionError
• WorkflowRequestError

getWorkflowRequestsByStatement

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

PQL Property	Object Property
id	WorkflowRequest.id
workflowRuleName	WorkflowRequest.workflowRuleName
entityType	WorkflowRequest.entityType
entityId	WorkflowRequest.entityId
approvalStatus	WorkflowApprovalRequest.status
conditionStatus	WorkflowExternalConditionRequest.status
type	WorkflowRequest.type

The type filter is required in v201705 and earlier.

Parameters

Field	Type	Description
filterStatement	Statement	a Publisher Query Language statement used to filter a set of workflow requests belonging to an entity

Response

Field	Type	Description
rval	WorkflowRequestPage	the workflow requests that match the given filter

performWorkflowRequestAction

Perform actions on WorkflowRequest objects that match the given Statement.query.

Parameters

Field	Type	Description
action	WorkflowRequestAction ApproveWorkflowApprovalRequ... SkipWorkflowExternalConditi... TriggerWorkflowExternalCond... RejectWorkflowApprovalRequests	the action to perform
filterStatement	Statement	a Publisher Query Language statement used to filter a set of workflow requests

Response

Field	Type	Description
rval	UpdateResult	the result of the action performed

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.
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.
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.
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 CustomTargetingValue.matchType other than CustomTargetingValue.MatchType.EXACT. VALUE_MATCH_TYPE_NOT_EXACT_FOR_PREDEFINED_KEY You can only create CustomTargetingValue objects with match type CustomTargetingValue.MatchType.EXACT when associating with CustomTargetingKey objects of type CustomTargetingKey.Type.PREDEFINED SUFFIX_MATCH_TYPE_NOT_ALLOWED CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType.SUFFIX when adding a CustomTargetingValue to a line item. CONTAINS_MATCH_TYPE_NOT_ALLOWED CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType.CONTAINS when adding a CustomTargetingValue to targeting expression of a line item. KEY_WITH_MISSING_VALUES The CustomTargetingKey does not have any CustomTargetingValue associated with it. INVALID_VALUE_FOR_KEY The CustomTargetingKey has a CustomTargetingValue specified for which the value is not a valid child. CANNOT_OR_DIFFERENT_KEYS CustomCriteriaSet.LogicalOperator.OR operation cannot be applied to values with different keys. INVALID_TARGETING_EXPRESSION Targeting expression is invalid. This can happen if the sequence of operators is wrong, or a node contains invalid number of children. DELETED_KEY_CANNOT_BE_USED_FOR_TARGETING The key has been deleted. CustomCriteria cannot have deleted keys. DELETED_VALUE_CANNOT_BE_USED_FOR_TARGETING The value has been deleted. CustomCriteria cannot have deleted values. VIDEO_BROWSE_BY_KEY_CANNOT_BE_USED_FOR_CUSTOM_TARGETING The key is set as the video browse-by key, which cannot be used for custom targeting. CANNOT_DELETE_CUSTOM_KEY_USED_IN_CONTENT_METADATA_MAPPING Only active custom-criteria keys are supported in content metadata mapping. CANNOT_DELETE_CUSTOM_VALUE_USED_IN_CONTENT_METADATA_MAPPING Only active custom-criteria values are supported in content metadata mapping. CANNOT_DELETE_CUSTOM_KEY_USED_IN_PARTNER_ASSIGNMENT_TARGETING Cannot delete a custom criteria key that is targeted by an active partner assignment. CANNOT_DELETE_CUSTOM_VALUE_USED_IN_PARTNER_ASSIGNMENT_TARGETING Cannot delete a custom criteria value that is targeted by an active partner assignment. CANNOT_TARGET_AUDIENCE_SEGMENT AudienceSegment object cannot be targeted. CANNOT_TARGET_INACTIVE_AUDIENCE_SEGMENT Inactive AudienceSegment object cannot be targeted. INVALID_AUDIENCE_SEGMENTS Targeted AudienceSegment object is not valid. ONLY_APPROVED_AUDIENCE_SEGMENTS_CAN_BE_TARGETED Targeted AudienceSegment objects have not been approved. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
FeatureError	Errors related to feature management. If you attempt using a feature that is not available to the current network you'll receive a FeatureError with the missing feature as the trigger. Enumerations MISSING_FEATURE A feature is being used that is not enabled on the current network. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
ForecastError	Errors that can result from a forecast request. Enumerations SERVER_NOT_AVAILABLE The forecast could not be retrieved due to a server side connection problem. Please try again soon. INTERNAL_ERROR There was an unexpected internal error. NO_FORECAST_YET The forecast could not be retrieved because there is not enough forecasting data available yet. It may take up to one week before enough data is available. NOT_ENOUGH_INVENTORY There's not enough inventory for the requested reservation. SUCCESS No error from forecast. ZERO_LENGTH_RESERVATION The requested reservation is of zero length. No forecast is returned. EXCEEDED_QUOTA The number of requests made per second is too high and has exceeded the allowable limit. The recommended approach to handle this error is to wait about 5 seconds and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time. Another way to mitigate this error is to limit requests to 2 per second. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
InternalApiError	Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client. Enumerations UNEXPECTED_INTERNAL_API_ERROR API encountered an unexpected internal error. TRANSIENT_ERROR A temporary error occurred during the request. Please retry. UNKNOWN The cause of the error is not known or only defined in newer versions. DOWNTIME The API is currently unavailable for a planned downtime. ERROR_GENERATING_RESPONSE Mutate succeeded but server was unable to build response. Client should not retry mutate.
LineItemOperationError	Lists all errors for executing operations on line items Enumerations NOT_ALLOWED The operation is not allowed due to lack of permissions. NOT_APPLICABLE The operation is not applicable for the current state of the LineItem. HAS_COMPLETED The LineItem is completed. A LineItemAction cannot be applied to a line item that is completed. HAS_NO_ACTIVE_CREATIVES The LineItem has no active creatives. A line item cannot be activated with no active creatives. CANNOT_ACTIVATE_LEGACY_DFP_LINE_ITEM A LineItem of type LineItemType.LEGACY_DFP cannot be Activated. CANNOT_ACTIVATE_UNCONFIGURED_LINE_ITEM A LineItem with publisher creative source cannot be activated if the corresponding deal is not yet configured by the buyer. CANNOT_DELETE_DELIVERED_LINE_ITEM Deleting an LineItem that has delivered is not allowed CANNOT_RESERVE_COMPANY_CREDIT_STATUS_NOT_ACTIVE Reservation cannot be made for line item because the LineItem.advertiserId it is associated with has Company.creditStatus that is not ACTIVE or ON_HOLD. CANNOT_ACTIVATE_INVALID_COMPANY_CREDIT_STATUS Cannot activate line item because the LineItem.advertiserId it is associated with has Company.creditStatus that is not ACTIVE, INACTIVE, or ON_HOLD. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
NotNullError	Caused by supplying a null value for an attribute that cannot be null. Enumerations ARG1_NULL Assuming that a method will not have more than 3 arguments, if it does, return NULL ARG2_NULL ARG3_NULL NULL UNKNOWN The value returned if the actual value is not exposed by the requested API version.
ParseError	Lists errors related to parsing. Enumerations UNPARSABLE Indicates an error in parsing an attribute. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
PermissionError	Errors related to incorrect permission. Enumerations PERMISSION_DENIED User does not have the required permission for the request. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
ProposalActionError	Lists all errors associated with performing actions on Proposal objects. Enumerations NOT_APPLICABLE The operation is not applicable to the current state. IS_ARCHIVED The operation cannot be applied because the proposal is archived. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
ProposalLineItemActionError	Lists all errors for executing operations on proposal line items. Enumerations NOT_APPLICABLE The operation is not applicable to the current state. PROPOSAL_NOT_EDITABLE The operation is not applicable because the containing proposal is not editable. CANNOT_SELECTIVELY_ARCHIVE_PROPOSAL_LINE_ITEMS_FROM_MANDATORY_PRODUCTS The archive operation is not applicable because it would cause some mandatory products to have no unarchived proposal line items in the package. CANNOT_SELECTIVELY_UNARCHIVE_PROPOSAL_LINE_ITEMS_FROM_MANDATORY_PRODUCTS The unarchive operation is not applicable because it would cause some mandatory products to have no unarchived proposal line items in the package. CANNOT_UNARCHIVE_SOLD_PROGRAMMATIC_PROPOSAL_LINE_ITEM Sold programmatic ProposalLineItem cannot be unarchived. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
PublisherQueryLanguageContextError	An error that occurs while executing a PQL query contained in a Statement object. Enumerations UNEXECUTABLE Indicates that there was an error executing the PQL. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
PublisherQueryLanguageSyntaxError	An error that occurs while parsing a PQL query contained in a Statement object. Enumerations UNPARSABLE Indicates that there was a PQL syntax error. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
QuotaError	Describes a client-side error on which a user is attempting to perform an action to which they have no quota remaining. Enumerations EXCEEDED_QUOTA The number of requests made per second is too high and has exceeded the allowable limit. The recommended approach to handle this error is to wait about 5 seconds and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time. Another way to mitigate this error is to limit requests to 8 per second for Ad Manager 360 accounts, or 2 per second for Ad Manager accounts. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error. UNKNOWN The value returned if the actual value is not exposed by the requested API version. REPORT_JOB_LIMIT This user has exceeded the allowed number of new report requests per hour (this includes both reports run via the UI and reports run via ReportService.runReportJob). The recommended approach to handle this error is to wait about 10 minutes and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time. Another way to mitigate this error is to limit the number of new report requests to 250 per hour per user. Once again, this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.
RequiredCollectionError	A list of all errors to be used for validating sizes of collections. Enumerations REQUIRED A required collection is missing. TOO_LARGE Collection size is too large. TOO_SMALL Collection size is too small. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
RequiredError	Errors due to missing required field. Enumerations REQUIRED Missing required field.
ServerError	Errors related to the server. Enumerations SERVER_ERROR Indicates that an unexpected error occured. SERVER_BUSY Indicates that the server is currently experiencing a high load. Please wait and try your request again. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
StatementError	An error that occurs while parsing Statement objects. Enumerations VARIABLE_NOT_BOUND_TO_VALUE A bind variable has not been bound to a value. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
StringFormatError	A list of error code for reporting invalid content of input strings. Enumerations UNKNOWN ILLEGAL_CHARS The input string value contains disallowed characters. INVALID_FORMAT The input string value is invalid for the associated field.
StringLengthError	Errors for Strings which do not meet given length constraints. Enumerations TOO_LONG TOO_SHORT UNKNOWN The value returned if the actual value is not exposed by the requested API version.
WorkflowActionError	Lists all errors associated with performing actions within WorkflowAction. Enumerations NOT_APPLICABLE The action does not exist or is not applicable to the current state. WORKFLOW_DEFINITION_NOT_FOUND Means there's no workflow definition found for the entity. EMPTY_ACTION_LIST Means no action is given, when user approve/reject a proposal, the action id list cannot be empty. NOT_ACTION_APPROVER Means the user is not an approver of this action. WORKFLOW_ALREADY_COMPLETED Means the workflow is already completed. WORKFLOW_ALREADY_FAILED Means the workflow is already failed. WORKFLOW_ALREADY_CANCELED Means the workflow is already canceled. ACTION_COMPLETED Means the action is already completed. ACTION_FAILED Means the action is already failed. ACTION_CANCELED Means the action is already canceled. ACTION_NOT_ACTIVE Means the action currently is not active. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
WorkflowRequestError	Lists errors associated with workflow requests. Enumerations REQUEST_ALREADY_PROCESSED The request has already been processed. WORKFLOW_NOT_IN_PROGRESS The workflow is not in progress. INVALID_REQUEST_ID The request ID is invalid. INVALID_ACTION The action could not be performed on a request of that type. UNKNOWN The value returned if the actual value is not exposed by the requested API version.