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
- 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
|
|
a Publisher Query Language statement used to filter a set of workflow requests belonging to an entity |
Response
Field | Type | Description |
---|---|---|
rval
|
|
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
|
|
the action to perform |
filterStatement
|
|
a Publisher Query Language statement used to filter a set of workflow requests |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the result of the action performed |
Errors
Error | Reasons |
---|---|
ApiVersionError
|
Errors related to the usage of API versions.
Enumerations
|
AuthenticationError
|
An error for an exception that occurred when authenticating.
Enumerations
|
CollectionSizeError
|
Error for the size of the collection being too large
Enumerations
|
CommonError
|
A place for common errors that can be used across services.
Enumerations
|
CustomTargetingError
|
Lists all errors related to CustomTargetingKey and
CustomTargetingValue objects.
Enumerations
|
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
|
ForecastError
|
Errors that can result from a forecast request.
Enumerations
|
InternalApiError
|
Indicates that a server-side error has occured. InternalApiError s
are generally not the result of an invalid request or message sent by the
client.
Enumerations
|
LineItemOperationError
|
Lists all errors for executing operations on line items
Enumerations
|
NotNullError
|
Caused by supplying a null value for an attribute that cannot be null.
Enumerations
|
ParseError
|
Lists errors related to parsing.
Enumerations
|
PermissionError
|
Errors related to incorrect permission.
Enumerations
|
ProposalActionError
|
Lists all errors associated with performing actions on Proposal objects.
Enumerations
|
ProposalLineItemActionError
|
Lists all errors for executing operations on proposal line items.
Enumerations
|
PublisherQueryLanguageContextError
|
An error that occurs while executing a PQL query contained in
a Statement object.
Enumerations
|
PublisherQueryLanguageSyntaxError
|
An error that occurs while parsing a PQL query contained in a
Statement object.
Enumerations
|
QuotaError
|
Describes a client-side error on which a user is attempting
to perform an action to which they have no quota remaining.
Enumerations
|
RequiredCollectionError
|
A list of all errors to be used for validating sizes of collections.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
ServerError
|
Errors related to the server.
Enumerations
|
StatementError
|
An error that occurs while parsing Statement objects.
Enumerations
|
StringFormatError
|
A list of error code for reporting invalid content of input strings.
Enumerations
|
StringLengthError
|
Errors for Strings which do not meet given length constraints.
Enumerations
|
WorkflowActionError
|
Lists all errors associated with performing actions within WorkflowAction .
Enumerations
|
WorkflowRequestError
|
Lists errors associated with workflow requests.
Enumerations
|