Provides methods for updating and retrieving Product objects.
A Product
represents a line
item proposal. Products are generated from product templates on
a periodic basis using the product template's attributes. Products
are typically used by inventory managers to restrict what
salespeople can sell.
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/v201905/ProductService?wsdl
- Namespace
-
https://www.google.com/apis/ads/publisher/v201905
- Operations
- Errors
-
- ApiVersionError
- AuthenticationError
- BaseRateError
- CollectionSizeError
- CommonError
- ContentMetadataTargetingError
- CustomFieldValueError
- CustomTargetingError
- DateTimeRangeTargetingError
- DayPartTargetingError
- EntityChildrenLimitReachedError
- FeatureError
- ForecastError
- GenericTargetingError
- GeoTargetingError
- InternalApiError
- InventoryTargetingError
- NonProgrammaticProductError
- NotNullError
- ParseError
- PermissionError
- PreferredDealError
- ProductActionError
- ProductError
- ProgrammaticEntitiesError
- ProgrammaticProductError
- PublisherQueryLanguageContextError
- PublisherQueryLanguageSyntaxError
- QuotaError
- RangeError
- RequiredCollectionError
- RequiredError
- RequiredNumberError
- ServerError
- StatementError
- StringFormatError
- StringLengthError
- TechnologyTargetingError
- TypeError
- UniqueError
- UserDomainTargetingError
- VideoPositionTargetingError
getProductsByStatement
Gets a ProductPage of Product objects that satisfy the criteria specified by given Statement.query.
When using sales management, the following fields are supported for filtering and/or sorting.
PQL Property | Object Property | Filterable | Sortable |
---|---|---|---|
rateCardId
|
Rate card ID which the product is associated with | Yes | No |
status
|
Product.status | Yes | Yes |
lineItemType
|
Product.lineItemType | Yes | Yes |
productType
|
Product.productType | Yes | Yes |
rateType
|
Product.rateType | Yes | Yes |
productTemplateId
|
Product.productTemplateId | Yes | No |
name
|
Product.name | Yes | Yes |
description
|
Product.description | Yes | No |
id
|
Product.id | Yes | Yes |
lastModifiedDateTime
|
Product.lastModifiedDateTime | Yes | Yes |
Parameters
Field | Type | Description |
---|---|---|
statement
|
|
a Publisher Query Language statement which specifies the filtering criteria over products |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the products that match the given statement |
performProductAction
Performs action on Product objects that satisfy the given Statement.
Parameters
Field | Type | Description |
---|---|---|
productAction
|
|
the action to perform |
filterStatement
|
|
a Publisher Query Language statement used to filter a set of products. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the result of the action performed |
updateProducts
Updates the specified Product objects. Note non-updatable fields will not be backfilled.
Parameters
Field | Type | Description |
---|---|---|
products
|
|
the products to update |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the updated products |
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
|
ContentMetadataTargetingError
|
Lists all errors related to ContentMetadataTargeting .
Enumerations
|
CustomFieldValueError
|
Errors specific to editing custom field values
Enumerations
|
CustomTargetingError
|
Lists all errors related to CustomTargetingKey and
CustomTargetingValue objects.
Enumerations
|
DateTimeRangeTargetingError
|
Lists all date time range errors caused by associating a line item with a targeting
expression.
Enumerations
|
|