ProductTemplateService (v201808)

Provides methods for creating, updating and retrieving ProductTemplate objects.

A product template is used to generate a set of products. Products allow inventory managers to control 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/v201808/ProductTemplateService?wsdl
Namespace
https://www.google.com/apis/ads/publisher/v201808
Operations
Errors

createProductTemplates

Creates new ProductTemplate objects.

Parameters

Field Type Description
productTemplates ProductTemplate[] the productTemplates to create

Response

Field Type Description
rval ProductTemplate[] the persisted product templates with their Ids filled in

getProductTemplatesByStatement

Gets a ProductTemplatePage of ProductTemplate objects that satisfy the filtering criteria specified by given Statement.query. The following fields are supported for filtering:

PQL Property Object Property
id ProductTemplate.id
name ProductTemplate.name
nameMacro ProductTemplate.nameMacro
description ProductTemplate.description
status ProductTemplate.status
lastModifiedDateTime ProductTemplate.lastModifiedDateTime
lineItemType LineItemType
productType ProductType
rateType RateType

Parameters

Field Type Description
statement Statement a Publisher Query Language statement which specifies the filtering criteria over productTemplates

Response

Field Type Description
rval ProductTemplatePage the productTemplates that match the given statement

performProductTemplateAction

Performs action on ProductTemplate objects that satisfy the given Statement.query.

Parameters

Field Type Description
action
  1. ProductTemplateAction
    1. ActivateProductTemplates
    2. ArchiveProductTemplates
    3. DeactivateProductTemplates
    4. UnarchiveProductTemplates
the action to perform
filterStatement Statement a Publisher Query Language statement used to filter a set of product templates

Response

Field Type Description
rval UpdateResult the result of the action performed

updateProductTemplates

Updates the specified ProductTemplate objects.

Parameters

Field Type Description
productTemplates ProductTemplate[] the product templates to update

Response

Field Type Description
rval ProductTemplate[] the updated product templates

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.
ContentMetadataTargetingError Lists all errors related to ContentMetadataTargeting.
Enumerations
VALUES_DO_NOT_BELONG_TO_A_HIERARCHY
One or more of the values specified in a ContentMetadataHierarchyTargeting do not belong to the keys defined in any of the hierarchies on the network.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CustomFieldValueError Errors specific to editing custom field values
Enumerations
CUSTOM_FIELD_NOT_FOUND
An attempt was made to modify or create a CustomFieldValue for a CustomField that does not exist.
CUSTOM_FIELD_INACTIVE
An attempt was made to create a new value for a custom field that is inactive.
CUSTOM_FIELD_OPTION_NOT_FOUND
An attempt was made to modify or create a CustomFieldValue corresponding to a CustomFieldOption that could not be found.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CustomTargetingError Lists all errors related to CustomTargetingKey and CustomTargetingValue objects.
Enumerations
KEY_NOT_FOUND
Requested CustomTargetingKey is not found.
KEY_COUNT_TOO_LARGE
Number of CustomTargetingKey objects created exceeds the limit allowed for the network.
KEY_NAME_DUPLICATE
CustomTargetingKey with the same CustomTargetingKey.name already exists.
KEY_NAME_EMPTY
CustomTargetingKey.name is empty.
KEY_NAME_INVALID_LENGTH
CustomTargetingKey.name is too long.
KEY_NAME_INVALID_CHARS
CustomTargetingKey.name contains unsupported or reserved characters.
KEY_NAME_RESERVED
CustomTargetingKey.name matches one of the reserved custom targeting key names.
KEY_DISPLAY_NAME_INVALID_LENGTH
CustomTargetingKey.displayName is too long.
VALUE_NOT_FOUND
Requested CustomTargetingValue is not found.
GET_VALUES_BY_STATEMENT_MUST_CONTAIN_KEY_ID
The WHERE clause in the Statement.query must always contain CustomTargetingValue.customTargetingKeyId as one of its columns in a way that it is AND'ed with the rest of the query.
VALUE_COUNT_FOR_KEY_TOO_LARGE
The number of CustomTargetingValue objects associated with a CustomTargetingKey exceeds the network limit. This is only applicable for keys of type CustomTargetingKey.Type#PREDEFINED.
VALUE_NAME_DUPLICATE
CustomTargetingValue with the same CustomTargetingValue.name already exists.
VALUE_NAME_EMPTY
CustomTargetingValue.name is empty.
VALUE_NAME_INVALID_LENGTH
CustomTargetingValue.name is too long.
VALUE_NAME_INVALID_CHARS
CustomTargetingValue.name contains unsupported or reserved characters.
VALUE_DISPLAY_NAME_INVALID_LENGTH
CustomTargetingValue.displayName is too long.
VALUE_MATCH_TYPE_NOT_ALLOWED
Only Ad Manager 360 networks can have CustomTargetingValue.matchType other than CustomTargetingValue.MatchType.EXACT.
VALUE_MATCH_TYPE_NOT_EXACT_FOR_PREDEFINED_KEY
You can only create CustomTargetingValue objects with match type CustomTargetingValue.MatchType.EXACT when associating with CustomTargetingKey objects of type CustomTargetingKey.Type.PREDEFINED
SUFFIX_MATCH_TYPE_NOT_ALLOWED
CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType.SUFFIX when adding a CustomTargetingValue to a line item.
CONTAINS_MATCH_TYPE_NOT_ALLOWED
CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType.CONTAINS when adding a CustomTargetingValue to targeting expression of a line item.
KEY_WITH_MISSING_VALUES
The CustomTargetingKey does not have any CustomTargetingValue associated with it.
CANNOT_OR_DIFFERENT_KEYS
CustomCriteriaSet.LogicalOperator.OR operation cannot be applied to values with different keys.
INVALID_TARGETING_EXPRESSION
Targeting expression is invalid. This can happen if the sequence of operators is wrong, or a node contains invalid number of children.
DELETED_KEY_CANNOT_BE_USED_FOR_TARGETING
The key has been deleted. CustomCriteria cannot have deleted keys.
DELETED_VALUE_CANNOT_BE_USED_FOR_TARGETING
The value has been deleted. CustomCriteria cannot have deleted values.
VIDEO_BROWSE_BY_KEY_CANNOT_BE_USED_FOR_CUSTOM_TARGETING
The key is set as the video browse-by key, which cannot be used for custom targeting.
CANNOT_DELETE_CUSTOM_KEY_USED_IN_CONTENT_METADATA_MAPPING
Only active custom-criteria keys are supported in content metadata mapping.
CANNOT_DELETE_CUSTOM_VALUE_USED_IN_CONTENT_METADATA_MAPPING
Only active custom-criteria values are supported in content metadata mapping.
CANNOT_DELETE_CUSTOM_KEY_USED_IN_PARTNER_ASSIGNMENT_TARGETING
Cannot delete a custom criteria key that is targeted by an active partner assignment.
CANNOT_DELETE_CUSTOM_VALUE_USED_IN_PARTNER_ASSIGNMENT_TARGETING
Cannot delete a custom criteria value that is targeted by an active partner assignment.
CANNOT_TARGET_AUDIENCE_SEGMENT
AudienceSegment object cannot be targeted.
CANNOT_TARGET_INACTIVE_AUDIENCE_SEGMENT
Inactive AudienceSegment object cannot be targeted.
INVALID_AUDIENCE_SEGMENTS
Targeted AudienceSegment object is not valid.
ONLY_APPROVED_AUDIENCE_SEGMENTS_CAN_BE_TARGETED
Targeted AudienceSegment objects have not been approved.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
DateTimeRangeTargetingError Lists all date time range errors caused by associating a line item with a targeting expression.
Enumerations
EMPTY_RANGES
No targeted ranges exists.
NOT_SPONSORSHIP_LINEITEM
Type of lineitem is not sponsorship.
PAST_RANGES_CHANGED
Past ranges are changed.
RANGES_OVERLAP
Targeted date time ranges overlap.
RANGES_OUT_OF_LINEITEM_ACTIVE_PERIOD
Targeted date time ranges fall out the active period of lineitem.
START_TIME_IS_NOT_START_OF_DAY
Start time of range (except the earliest range) is not at start of day. Start of day is 00:00:00.
END_TIME_IS_NOT_END_OF_DAY
End time of range (except the latest range) is not at end of day. End of day is 23:59:59.
START_DATE_TIME_IS_IN_PAST
Start date time of earliest targeted ranges is in past.
RANGE_END_TIME_BEFORE_START_TIME
The end time of range is before the start time. Could happen when start type is IMMEDIATE or ONE_HOUR_LATER.
END_DATE_TIME_IS_TOO_LATE
End date time of latest targeted ranges is too late.
LIMITED_RANGES_IN_UNLIMITED_LINEITEM
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
DayPartTargetingError Lists all errors associated with day-part targeting for a line item.
Enumerations
INVALID_HOUR
Hour of day must be between 0 and 24, inclusive.
INVALID_MINUTE
Minute of hour must be one of 0, 15,30, 45.
END_TIME_NOT_AFTER_START_TIME
The DayPart.endTime cannot be after DayPart.startTime.
TIME_PERIODS_OVERLAP
Cannot create day-parts that overlap.
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.
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.
FrequencyCapError Lists all errors associated with frequency caps.
Enumerations
IMPRESSION_LIMIT_EXCEEDED
IMPRESSIONS_TOO_LOW
RANGE_LIMIT_EXCEEDED
RANGE_TOO_LOW
DUPLICATE_TIME_RANGE
TOO_MANY_FREQUENCY_CAPS
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
GenericTargetingError Targeting validation errors that can be used by different targeting types.
Enumerations
CONFLICTING_INCLUSION_OR_EXCLUSION_OF_SIBLINGS
Both including and excluding sibling criteria is disallowed.
INCLUDING_DESCENDANTS_OF_EXCLUDED_CRITERIA
Including descendants of excluded criteria is disallowed.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
GeoTargetingError Lists all errors associated with geographical targeting for a LineItem.
Enumerations
TARGETED_LOCATIONS_NOT_EXCLUDABLE
A location that is targeted cannot also be excluded.
EXCLUDED_LOCATIONS_CANNOT_HAVE_CHILDREN_TARGETED
Excluded locations cannot have any of their children targeted.
POSTAL_CODES_CANNOT_BE_EXCLUDED
Postal codes cannot be excluded.
UNTARGETABLE_LOCATION
Indicates that location targeting is not allowed.
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.
InventoryTargetingError Lists all inventory errors caused by associating a line item with a targeting expression.
Enumerations
AT_LEAST_ONE_PLACEMENT_OR_INVENTORY_UNIT_REQUIRED
At least one placement or inventory unit is required
INVENTORY_CANNOT_BE_TARGETED_AND_EXCLUDED
The same inventory unit or placement cannot be targeted and excluded at the same time
INVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_TARGETED
A child inventory unit cannot be targeted if its ancestor inventory unit is also targeted.
INVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_EXCLUDED
A child inventory unit cannot be targeted if its ancestor inventory unit is excluded.
INVENTORY_UNIT_CANNOT_BE_EXCLUDED_IF_ANCESTOR_IS_EXCLUDED
A child inventory unit cannot be excluded if its ancestor inventory unit is also excluded.
EXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_TARGETED
An explicitly targeted inventory unit cannot be targeted.
EXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_EXCLUDED
An explicitly targeted inventory unit cannot be excluded.
SELF_ONLY_INVENTORY_UNIT_NOT_ALLOWED
A landing page-only ad unit cannot be targeted.
SELF_ONLY_INVENTORY_UNIT_WITHOUT_DESCENDANTS
A landing page-only ad unit cannot be targeted if it doesn't have any children.
YOUTUBE_AUDIENCE_SEGMENTS_CAN_ONLY_BE_TARGETED_WITH_YOUTUBE_SHARED_INVENTORY
Audience segments shared from YouTube can only be targeted with inventory shared from YouTube for cross selling.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
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.
PreferredDealError Errors associated with preferred deal proposal line items.
Enumerations
INVALID_PRIORITY
INVALID_RATE_TYPE
Preferred deal proposal line items only support RateType.CPM.
INVALID_FREQUENCY_CAPS
Preferred deal proposal line items do not support frequency caps.
INVALID_ROADBLOCKING_TYPE
Preferred deal proposal line items only support RoadblockingType.ONE_OR_MORE.
INVALID_DELIVERY_RATE_TYPE
Preferred deal proposal line items only support DeliveryRateType.FRONTLOADED.
UNKNOWN
ProductTemplateActionError An error lists all error reasons associated with performing action on ProductTemplate objects.
Enumerations
NOT_APPLICABLE
The operation is not applicable to the current status.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ProductTemplateError A catch-all error that lists all generic errors associated with ProductTemplate.
Enumerations
INVALID_FEATURE_EXPANDED_EXCLUSIVE
One feature affinity should be expanded or not-expanded exclusively.
INVALID_EXPANDED_FEATURE_DEFAULT_NOT_TARGETED
Expanded feature should have false default targeting type.
INVALID_EXPANDED_FEATURE_DEFAULT_LOCKED
Expanded feature should be default locked.
INVALID_EXPANDED_FEATURE_VALUE_TARGETED
Expanded feature value should have true targeting type.
INVALID_EXPANDED_FEATURE_VALUE_LOCKED
Expanded feature value should be default locked.
INVALID_FEATURE_TYPE
The feature type is mismatch with feature value's type.
INVALID_ROADBLOCKING_TYPE
The roadblocking type is invalid.
INVALID_DELIVERY_RATE_TYPE
The delivery rate type is invalid.
INVALID_CREATIVE_ROTATION_TYPE
The creative rotation type is invalid.
INVALID_COMPANION_DELIVERY_OPTION
The companion delivery option is invalid.
INVALID_TARGETING
The targeting is invalid.
INVALID_FREQUENCY_CAPS
The frequency cap is invalid.
INVALID_TECHNOLOGY_INCLUDE_EXCLUDE
The technology criteria is included and excluded at same time.
INVALID_EXPANDED_PRODUCT_COUNT
INVALID_TARGET_PLATFORM
The target platform should always be WEB.
INVALID_NON_TARGETING_FEATURE
The non-targeting feature cannot have default target type TRUE.
INVALID_FEATURE_CARDINALITY_AT_LEAST_ONE
The feature's targeted value number breaks the cardinality request, it should have at least one value.
INVALID_FEATURE_CARDINALITY_AT_MOST_ONE
The feature's targeted value number breaks the cardinality request, it should have at most one value.
INVALID_FEATURE_CARDINALITY_EXACTLY_ONE
The feature's targeted value number breaks the cardinality request, it should have exactly one value.
INVALID_FEATURE_FOR_OFFLINE
The feature is invalid for offline product template.
INVALID_RATE_TYPE_FOR_OFFLINE
The rate type is invalid for offline product template.
INVALID_RATE_TYPE_FOR_DFP
The rate type should be in the valid set for corresponding line item type of a dfp product template.
INVALID_RATE_TYPE_FOR_NON_DFP
The rate type should be in the valid set for corresponding line item type of a ProductType.NON_DFP product template.
INVALID_VALUES_FOR_CLICK_TRACKING_LINE_ITEM_TYPE
One or more values on the product template are not valid for a LineItemType.CLICK_TRACKING line item type.
INVALID_SEGMENTATION_OR_TARGETING_FOR_CLICK_TRACKING_LINE_ITEM_TYPE
The segmentation or targeting on the product template is not valid for a LineItemType.CLICK_TRACKING line item type.
INVALID_LINE_ITEM_PRIORITY
The line item priority feature is not match with line item type feature.
INVALID_LINE_ITEM_TYPE
The line item type value is not supported.
INVALID_ENVIRONMENT_TYPE
The environment type is not valid.
DUPLICATED_PLACEHOLDER_IN_NAMEMACRO
Duplication of placeholder for feature type affinity exists in name macro.
INVALID_EXPANDED_FEATURE_IN_NON_EXPANDABLE_AFFINITY
Expanded features are not allowed in non expandable feature affinity.
INVALID_FEATURE_DEFAULT_TARGET_TYPE
The default target type of the feature is not supported.
INVALID_FEATURE_VALUE_TARGET_TYPE
The target type of the value is invalid.
INVALID_FEATURE_AND_VALUE_LOCK_EXCLUSIVE
The default locked of feature is different with locked of feature values.
INVALID_CREATIVE_PLACEHOLDER
The creative placeholder should have at least a master size, or has one master and multiple companion sizes.
DUPLICATED_FEATURE
Duplicated features with the same feature type.
DUPLICATED_CUSTOM_TARGETING_KEY
Duplicated custom criteria key.
DUPLICATED_CUSTOM_TARGETING_VALUE
Duplicated custom criteria value.
INVALID_CUSTOM_TARGETING_KEY_ID
The id of custom criteria key is invalid.
INVALID_CUSTOM_TARGETING_VALUE_ID
The id of custom criteria value is invalid.
MISSING_CUSTOM_TARGETING_VALUES
Missing custom targeting values.
LOCATION_CANNOT_BE_TARGETED_IF_PARENT_IS_TARGETED
A child location can not be targeted if any one of its parent locations is also targeted.
LOCATION_CANNOT_BE_EXCLUDED_IF_PARENT_IS_EXCLUDED
A child location can not be excluded if any one of its parent locations is also excluded.
LOCATION_CANNOT_BE_EXCLUDED_DIRECTLY_WHEN_HAVE_TARGETED_LOCATION
An excluded location must have one targeted parent when targeted location is not empty.
CUSTOMIZABLE_CUSTOM_KEY_CANNOT_BE_SEGMENTED
Customizable key is used in custom targeting segment.
CUSTOM_KEY_USED_IN_TARGETING_CANNOT_BE_SEGMENTED
Custom targeting key is already used in custom targeting segment.
MISSING_EXPANDED_FEATURE_PLACEHOLDER_IN_NAMEMACRO
A placeholder for an expanded feature type affinity is missing in name macro.
MISSING_FEATURE_VALUE_OF_NAMEMACRO_PLACEHOLDER
The feature type affinity with placeholder been added is missing corresponding value.
MISSING_FEATURE_OF_NAMEMACRO_PLACEHOLDER
The feature type affinity with placeholder been added is not specified.
MISSING_SUBTYPE_FOR_CUSTOM_TARGETING
The SubTypeId of custom criteria feature is not specified.
COMPANION_NOT_ALLOWED
A placeholder contains companions but the roadblocking type is not CREATIVE_SET or the product type is offline.
MISSING_COMPANION
A placeholder does not contain companions but the roadblocking type is CREATIVE_SET.
DUPLICATED_MASTER_SIZE
A placeholder's master size is the same as another placeholder.
CANNOT_HAVE_CREATIVE_TEMPLATE
Non-native placeholders cannot have creative templates.
NATIVE_CREATIVE_TEMPLATE_REQUIRED
Placeholders can only have native creative templates.
CANNOT_INCLUDE_NATIVE_PLACEHOLDER_WITHOUT_TEMPLATE_ID
Cannot include native placeholders without native creative templates.
CANNOT_MODIFY_READONLY_FEATURE
The feature is readonly.
CANNOT_MODIFY_PRODUCT_TYPE
The product type can not be modified after creation.
CANNOT_ADD_SEGMENTATION
Cannot add new segmentations after product template is saved.
CANNOT_REMOVE_SEGMENTATION
Cannot remove segmentations after product template is saved.
CANNOT_REMOVE_VALUE_FROM_SEGMENTATION
Cannot remove value from segmentation after product template is saved.
CANNOT_ADD_FEATURE_VALUE_FOR_CUSTOM_TARGETING
Cannot add feature value for custom targeting.
CANNOT_MODIFY_BUILTIN_TARGETING_FEATURE
Cannot modify a builtin targeting feature.
CANNOT_UPDATE_ARCHIVED_PRODUCT_TEMPLATE
Cannot update an archived product template.
INVALID_VIDEO_POSITION_VALUE_FOR_LINE_ITEM_TYPE
There are video position values that are invalid for the LineItemType.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ProgrammaticEntitiesError Lists all programmatic errors associated with entities which can be used in Marketplace.
Enumerations
INVALID_RATE_TYPE
RateType is not supported.
INVALID_ENVIRONMENT_TYPE
EnvironmentType must match AdExchange environment.
INVALID_PRODUCT_TYPE
ProductType is not supported.
INVALID_LINE_ITEM_TYPE
LineItemType is not supported.
INVALID_ROADBLOCKING_TYPE
RoadblockingType is not supported.
INVALID_DELIVERY_RATE_TYPE
DeliveryRateType is not supported.
INVALID_COMPANION_DELIVERY_OPTION
CompanionDeliveryOption is not supported.
INVALID_CREATIVE_ROTATION_TYPE
CreativeRotationType is not supported.
INVALID_COMPANION_CREATIVE_PLACEHOLDER
CreativePlaceholder should not have companions.
EMPTY_CREATIVE_PLACEHOLDER
Creative placeholders cannot be null or empty.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ProgrammaticProductError Lists all programmatic errors associated with products which can be used in Marketplace.
Enumerations
PRODUCT_MARKETPLACE_INFO_IS_NULL
Product Marketplace info cannot be null.
ENVIRONMENT_IS_NULL
AdExchange environment cannot be null.
INVALID_AD_EXCHANGE_ENVIRONMENT
AdExchange environment 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.
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.
RequiredNumberError A list of all errors to be used in conjunction with required number validators.
Enumerations
REQUIRED
TOO_LARGE
TOO_SMALL
TOO_LARGE_WITH_DETAILS
TOO_SMALL_WITH_DETAILS
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
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.
TechnologyTargetingError Technology targeting validation errors.
Enumerations
MOBILE_LINE_ITEM_CONTAINS_WEB_TECH_CRITERIA
Mobile line item cannot target web-only targeting criteria.
WEB_LINE_ITEM_CONTAINS_MOBILE_TECH_CRITERIA
Web line item cannot target mobile-only targeting criteria.
MOBILE_CARRIER_TARGETING_FEATURE_NOT_ENABLED
The mobile carrier targeting feature is not enabled.
DEVICE_CAPABILITY_TARGETING_FEATURE_NOT_ENABLED
The device capability targeting feature is not enabled.
DEVICE_CATEGORY_TARGETING_FEATURE_NOT_ENABLED
The device category targeting feature is not enabled.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
TypeError An error for a field which is an invalid type.
UniqueError An error for a field which must satisfy a uniqueness constraint
UserDomainTargetingError Lists all errors related to user domain targeting for a line item.
Enumerations
INVALID_DOMAIN_NAMES
Invalid domain names. Domain names must be at most 67 characters long. And must contain only alphanumeric characters and hyphens.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
VideoPositionTargetingError Lists all errors related to VideoPositionTargeting.
Enumerations
CANNOT_MIX_BUMPER_AND_NON_BUMPER_TARGETING
Video position targeting cannot contain both bumper and non-bumper targeting values.
INVALID_BUMPER_TARGETING
The bumper video position targeting is invalid.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

Send feedback about...

Ad Manager API
Ad Manager API
Need help? Visit our support page.