Provides methods for creating and retrieving ProductPackageItem objects.
A ProductPackageItem represents a product which will be associated with a ProductPackage.
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/ProductPackageItemService?wsdl
- Namespace
-
https://www.google.com/apis/ads/publisher/v201902
- Operations
- Errors
-
- ApiVersionError
- AuthenticationError
- CollectionSizeError
- CommonError
- EntityChildrenLimitReachedError
- EntityLimitReachedError
- FeatureError
- InternalApiError
- NotNullError
- ParseError
- PermissionError
- ProductError
- ProductPackageActionError
- ProductPackageItemActionError
- ProductPackageItemError
- ProductPackageRateCardAssociationError
- PublisherQueryLanguageContextError
- PublisherQueryLanguageSyntaxError
- QuotaError
- RangeError
- RequiredCollectionError
- RequiredError
- ServerError
- StatementError
- StringFormatError
- StringLengthError
- UniqueError
createProductPackageItems
Creates new ProductPackageItem objects.
Parameters
Field | Type | Description |
---|---|---|
productPackageItems
|
|
the product package items to create |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the created product package items with their IDs filled in |
getProductPackageItemsByStatement
Gets a ProductPackageItemPage of ProductPackageItem
objects
that satisfy the filtering criteria specified by given Statement.query.
The following fields are supported for filtering:
PQL Property | Object Property |
---|---|
id
|
ProductPackageItem.id |
productPackageId
|
ProductPackageItem.productPackageId |
productId
|
ProductPackageItem.productId |
productTemplateId
|
ProductPackageItem.productTemplateId |
mandatory
|
ProductPackageItem.mandatory |
archived
|
ProductPackageItem.archived |
Parameters
Field | Type | Description |
---|---|---|
statement
|
|
a Publisher Query Language statement which specifies the filtering criteria over product packages |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the product package items that match the given statement |
performProductPackageItemAction
Performs actions on ProductPackageItem objects that satisfy the given Statement.query.
Parameters
Field | Type | Description |
---|---|---|
productPackageItemAction
|
|
the action to perform |
statement
|
|
a Publisher Query Language statement used to filter a set of product package items |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the result of the action performed |
updateProductPackageItems
Updates the specified ProductPackageItem objects.
Parameters
Field | Type | Description |
---|---|---|
productPackageItems
|
|
the product package items to update |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the updated product package items |
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
|
EntityChildrenLimitReachedError
|
Lists errors relating to having too many children on an entity.
Enumerations
|
EntityLimitReachedError
|
An error that occurs when creating an entity if the limit on the number of allowed entities for
a network has already been reached.
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
|
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
|
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
|
ProductError
|
Lists all error reasons associated with products.
Enumerations
|
ProductPackageActionError
|
Lists all errors for executing operations on product packages.
Enumerations
|
ProductPackageItemActionError
|
Lists all errors for executing operations on product package items.
Enumerations
|
ProductPackageItemError
|
Lists all errors associated with product package items.
Enumerations
|
ProductPackageRateCardAssociationError
|
Lists all errors associated with product packages rate card associations.
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
|
RangeError
|
A list of all errors associated with the Range constraint.
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
|
UniqueError
|
An error for a field which must satisfy a uniqueness constraint |