Provides methods for updating and retrieving ProductPackage objects.
A ProductPackage represents a group of products which will be sold together.
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/ProductPackageService?wsdl
- Namespace
-
https://www.google.com/apis/ads/publisher/v201902
- Operations
- Errors
-
- ApiVersionError
- AuthenticationError
- BaseRateError
- CollectionSizeError
- CommonError
- EntityChildrenLimitReachedError
- EntityLimitReachedError
- FeatureError
- InternalApiError
- NotNullError
- NullError
- ParseError
- PermissionError
- ProductPackageActionError
- ProductPackageItemError
- ProductPackageRateCardAssociationError
- PublisherQueryLanguageContextError
- PublisherQueryLanguageSyntaxError
- QuotaError
- RangeError
- RateCardError
- RequiredCollectionError
- RequiredError
- ServerError
- StatementError
- StringFormatError
- StringLengthError
- UniqueError
createProductPackages
Creates new ProductPackage objects.
Parameters
Field | Type | Description |
---|---|---|
productPackages
|
|
the product packages to create |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the persisted product packages with their ID filled in |
getProductPackagesByStatement
Gets a ProductPackagePage of ProductPackage objects that satisfy the filtering criteria specified by given Statement.query. The following fields are supported for filtering:
PQL Property | Object Property |
---|---|
id
|
ProductPackage.id |
name
|
ProductPackage.name |
notes
|
ProductPackage.notes |
status
|
ProductPackage.status |
isArchived
|
ProductPackage.isArchived |
lastModifiedDateTime
|
ProductPackage.lastModifiedDateTime |
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 packages that match the given statement |
performProductPackageAction
Performs actions on ProductPackage objects that match the given Statement.query.
Parameters
Field | Type | Description |
---|---|---|
action
|
|
the action to perform |
statement
|
|
a Publisher Query Language statement used to filter a set of product packages |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the result of the action performed |
updateProductPackages
Updates the specified ProductPackage objects.
Parameters
Field | Type | Description |
---|---|---|
productPackages
|
|
the product packages to update |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the updated product packages |
Errors
Error | Reasons |
---|---|
ApiVersionError
|
Errors related to the usage of API versions.
Enumerations
|
AuthenticationError
|
An error for an exception that occurred when authenticating.
Enumerations
|
BaseRateError
|
An error having to do with BaseRate.
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
|
NullError
|
Errors associated with violation of a NOT NULL check.
Enumerations
|
ParseError
|
Lists errors related to parsing.
Enumerations
|
PermissionError
|
Errors related to incorrect permission.
Enumerations
|
ProductPackageActionError
|
Lists all errors for executing operations on product packages.
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
|
RateCardError
|
An error having to do with RateCard.
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 |