ProductPackageService (v201902)

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

• createProductPackages
• getProductPackagesByStatement
• performProductPackageAction
• updateProductPackages

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	ProductPackage[]	the product packages to create

Response

Field	Type	Description
rval	ProductPackage[]	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	Statement	a Publisher Query Language statement which specifies the filtering criteria over product packages

Response

Field	Type	Description
rval	ProductPackagePage	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	ProductPackageAction ActivateProductPackages ArchiveProductPackages DeactivateProductPackages UnarchiveProductPackages	the action to perform
statement	Statement	a Publisher Query Language statement used to filter a set of product packages

Response

Field	Type	Description
rval	UpdateResult	the result of the action performed

updateProductPackages

Updates the specified ProductPackage objects.

Parameters

Field	Type	Description
productPackages	ProductPackage[]	the product packages to update

Response

Field	Type	Description
rval	ProductPackage[]	the updated product packages

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.
BaseRateError	An error having to do with BaseRate. Enumerations INVALID_CURRENCY_CODE The currency code is invalid. PRODUCT_TEMPLATE_ARCHIVED Cannot create or activate a base rate if the product template is archived. PRODUCT_PACKAGE_ITEM_ARCHIVED Cannot create or activate a product package item base rate if the product package item is archived. CANNOT_QUERY_ON_MULTIPLE_TYPES The PQL statement can only contain one of productTemplateId, productId or productPackageItemId. PRODUCT_PACKAGE_RATE_CARD_ASSOCIATION_MISSING Product package must be associated with the rate card of the product package item base rate. See ProductPackage.rateCardIds. UNSUPPORTED_OPERATION Indicates that the requested operation is not supported. PRODUCT_PACKAGE_ACTIVE Cannot delete a product package item base rate when its product package is active. PRODUCT_TEMPLATE_BASE_RATE_NOT_FOUND Cannot create a base rate to a product if its product template does not have a base rate on this rate card. PRODUCT_BASE_RATE_EXISTS Cannot delete a base rate on a product template if its products still have base rates on this rate card. INVALID_RATE_CARD_CHANNEL Marketplace rate cards should only have Marketplace Product/ProductTemplate base rates. Non-Marketplace rate cards should use traditional base rates. ZERO_MARKETPLACE_RATE_NOT_SUPPORTED Marketplace does not support base rates with zero-value rates. 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.
EntityChildrenLimitReachedError	Lists errors relating to having too many children on an entity. Enumerations LINE_ITEM_LIMIT_FOR_ORDER_REACHED The number of line items on the order exceeds the max number of line items allowed per order in the network. CREATIVE_ASSOCIATION_LIMIT_FOR_LINE_ITEM_REACHED The number of creatives associated with the line item exceeds the max number of creatives allowed to be associated with a line item in the network. AD_UNIT_LIMIT_FOR_PLACEMENT_REACHED The number of ad units on the placement exceeds the max number of ad units allowed per placement in the network. TARGETING_EXPRESSION_LIMIT_FOR_LINE_ITEM_REACHED The number of targeting expressions on the line item exceeds the max number of targeting expressions allowed per line item in the network. CUSTOM_TARGETING_VALUES_FOR_KEY_LIMIT_REACHED The number of custom targeting values for the free-form or predefined custom targeting key exceeds the max number allowed. TARGETING_EXPRESSION_LIMIT_FOR_CREATIVES_ON_LINE_ITEM_REACHED The total number of targeting expressions on the creatives for the line item exceeds the max number allowed per line item in the network. ATTACHMENT_LIMIT_FOR_PROPOSAL_REACHED The number of attachments added to the proposal exceeds the max number allowed per proposal in the network. PROPOSAL_LINE_ITEM_LIMIT_FOR_PROPOSAL_REACHED The number of proposal line items on the proposal exceeds the max number allowed per proposal in the network. PRODUCT_LIMIT_FOR_PRODUCT_PACKAGE_REACHED The number of product package items on the product package exceeds the max number allowed per product package in the network. PRODUCT_TEMPLATE_AND_PRODUCT_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED The number of product template and product base rates on the rate card (including excluded product base rates) exceeds the max number allowed per rate card in the network. PRODUCT_PACKAGE_ITEM_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED The number of product package item base rates on the rate card exceeds the max number allowed per rate card in the network. PREMIUM_LIMIT_FOR_RATE_CARD_REACHED The number of premiums of the rate card exceeds the max number allowed per rate card in the network. AD_UNIT_LIMIT_FOR_AD_EXCLUSION_RULE_TARGETING_REACHED The number of ad units on AdExclusionRule.inventoryTargeting exceeds the max number of ad units allowed per ad exclusion rule inventory targeting in the network. NATIVE_STYLE_LIMIT_FOR_NATIVE_AD_FORMAT_REACHED The number of native styles under the native creative template exceeds the max number of native styles allowed per native creative template in the network. TARGETING_EXPRESSION_LIMIT_FOR_PRESENTATION_ASSIGNMENT_REACHED The number of targeting expressions on the native style exceeds the max number of targeting expressions allowed per native style in the network. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
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 CUSTOM_TARGETING_VALUES_LIMIT_REACHED The number of custom targeting values exceeds the max number allowed in the network. AD_EXCLUSION_RULES_LIMIT_REACHED The number of ad exclusion rules exceeds the max number allowed in the network. FIRST_PARTY_AUDIENCE_SEGMENTS_LIMIT_REACHED The number of first party audience segments exceeds the max number allowed in the network. PLACEMENTS_LIMIT_REACHED The number of active placements exceeds the max number allowed in the network. LINE_ITEMS_LIMIT_REACHED The number of line items excceeds the max number allowed in the network. ACTIVE_LINE_ITEMS_LIMIT_REACHED The number of active line items exceeds the max number allowed in the network. 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.
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.
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.
NullError	Errors associated with violation of a NOT NULL check. Enumerations NULL_CONTENT Specified list/container must not contain any null elements
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.
ProductPackageActionError	Lists all errors for executing operations on product packages. Enumerations ACTIVATE_WITH_INACTIVE_MANDATORY_PRODUCT The activate operation is not applicable if there's any inactive mandatory product. NOT_APPLICABLE The operation is not applicable to the current state. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
ProductPackageItemError	Lists all errors associated with product package items. Enumerations ARCHIVED_PRODUCT_NOT_ALLOWED Add a archived product to product package is not allowed. INACTIVE_MANDATORY_PRODUCT_NOT_ALLOWED Inactive mandatory product is not allowed in active product package. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
ProductPackageRateCardAssociationError	Lists all errors associated with product packages rate card associations. Enumerations INVALID_RATE_CARD_ID The id of associated rate card is invalid or invisible to user. INVALID_PRODUCT_PACKAGE_ID The id of associated package is invalid. 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.
RangeError	A list of all errors associated with the Range constraint. Enumerations TOO_HIGH TOO_LOW UNKNOWN The value returned if the actual value is not exposed by the requested API version.
RateCardError	An error having to do with RateCard. Enumerations INVALID_CURRENCY_CODE The currency code is invalid and does not follow ISO 4217. INVALID_PRICING_MODEL The PricingModel is invalid. PRODUCT_PACKAGE_NOT_APPLICABLE_ON_MARKETPLACE_RATE_CARD Marketplace RateCard cannot have ProductPackage association. UNSUPPORTED_CURRENCY_CODE The currency code is not supported by current network. A supported currency can be either Network.currencyCode or one of Network.secondaryCurrencyCodes. UNCHANGEABLE_CURRENCY_CODE The currency code is unchangeable as long as there is any proposal line item created with the rate card. UNCHANGEABLE_PRICING_MODEL The PricingModel cannot be changed after proposal line items have been created using the RateCard. MARKETPLACE_RATE_CARD_NOT_UNIQUE Only one Marketplace RateCard per Network is allowed. NOT_ACCEPT_DEALS_SALES_ON_LEGAL_AGREEMENT Legal agreement must be accepted before activating the Marketplace RateCard. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
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.
UniqueError	An error for a field which must satisfy a uniqueness constraint