PackageService (v201808)

Provides methods for creating, updating and retrieving Package objects.

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/PackageService?wsdl
Namespace
https://www.google.com/apis/ads/publisher/v201808
Operations
Errors

createPackages

Creates new Package objects. For each package, the following fields are required:

Parameters

Field Type Description
packages Package[] the packages to create

Response

Field Type Description
rval Package[] the created packages with their IDs filled in

getPackagesByStatement

Gets a PackagePage of Package objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property Object Property
id Package.id
name Package.name
proposalId Package.proposalId
productPackageId Package.productPackageId
isArchived Package.isArchived
lastModifiedDateTime Package.lastModifiedDateTime

Parameters

Field Type Description
filterStatement Statement a Publisher Query Language statement used to filter a set of packages

Response

Field Type Description
rval PackagePage the packages that match the given filter

performPackageAction

Performs actions on Package objects that match the given Statement.

Parameters

Field Type Description
packageAction
  1. PackageAction
    1. CreateProposalLineItemsFrom...
the action to perform
filterStatement Statement a Publisher Query Language statement used to filter a set of packages

Response

Field Type Description
rval UpdateResult the result of the action performed

updatePackages

Updates the specified Package objects.

Parameters

Field Type Description
packages Package[] the packages to update

Response

Field Type Description
rval Package[] the updated 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.
AvailableBillingError Lists all errors associated with the availability of billing settings based on proposal network settings.
Enumerations
BILLING_SOURCE_IS_NOT_AVAILABLE
The billing source provided is not available in proposal network settings.
BILLING_SCHEDULE_IS_NOT_AVAILABLE
The billing schedule provided is not available in proposal network settings.
BILLING_CAP_IS_NOT_AVAILABLE
The billing cap provided is not available in proposal network settings.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
BillingError Lists all errors associated with the billing settings of a proposal or proposal line item.
Enumerations
UNSUPPORTED_BILLING_SCHEDULE
Found unsupported billing schedule.
UNSUPPORTED_BILLING_CAP
Found unsupported billing cap.
MISSING_BILLING_SOURCE
Billing source is missing when either billing scheule or billing cap is provided.
MISSING_BILLING_SCHEDULE
Billing schedule is missing when the provided billing source is CONSTRACTED.
MISSING_BILLING_CAP
Billing cap is missing when the provided billing source is not CONSTRACTED.
INVALID_BILLING_SOURCE_FOR_OFFLINE
The billing source is invalid for offline proposal line item.
UPDATE_BILLING_NOT_ALLOWED
Billing settings cannot be updated once the proposal has been approved.
MISSING_BILLING_BASE
Billing base is missing when the provided billing source is CONTRACTED.
INVALID_BILLING_BASE
The billing base is invalid for the provided billing source.
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.
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.
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.
LabelEntityAssociationError Errors specific to creating label entity associations.
Enumerations
DUPLICATE_ASSOCIATION
The label has already been attached to the entity.
INVALID_ASSOCIATION
A label is being applied to an entity that does not support that entity type.
DUPLICATE_ASSOCIATION_WITH_NEGATION
The same label is being applied and negated to the same entity.
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.
PackageActionError Lists all errors for executing actions on Package objects.
Enumerations
PROPOSAL_LINE_ITEMS_HAVE_BEEN_CREATED
The operation is not applicable because the proposal line items under these packages have already been created.
PROPOSAL_NOT_EDITABLE
The operation is not applicable because the containing proposal is not editable.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
PackageError Lists all errors associated with Package objects.
Enumerations
INVAILD_PRODUCT_PACKAGE
Package cannot be created from an inactive or archived product package.
INACTIVE_RATE_CARD
The rate card is inactive.
PRODUCT_PACKAGE_NOT_IN_RATE_CARD
There is no association between the product package and the rate card.
HAS_NO_UNARCHIVED_PRODUCT_PACKAGE_ITEM
There are no unarchived product package items in this product package.
NOT_SAME_RATE_CARD
The package's rate card is not the same as other packages or proposal line items in the proposal.
NOT_SAME_RATE_CARD_PRICING_MODEL
The RateCard pricing model for this Package is not the same as the pricing models for the other proposalLineItems or packages in the Proposal.
NOT_SAME_RATE_CARD_WORKFLOW
The RateCard workflow for this Package is not the same as the workflows for the other proposalLineItems or packages in the Proposal.
PACKAGES_NOT_ALLOWED_IN_PROGRAMMATIC_PROPOSALS
Package cannot be created in a programmatic proposal.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
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.
PrecisionError List all errors associated with number precisions.
Enumerations
WRONG_PRECISION
The lowest N digits of the number must be zero.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ProductError Lists all error reasons associated with products.
Enumerations
TEMPLATE_NOT_FOUND
The specified template is not found.
MALFORMED_PRODUCT_ID
The product ID is not correctly formed.
BAD_PRODUCT_ID_FEATURE
The product ID does not match the expanded features configured in its product template.
BAD_PRODUCT_TEMPLATE_ID
The product template ID specified in the parameters does not match the product template ID implied in the product ID.
CANNOT_UPDATE_ARCHIVED_PRODUCT
Cannot update an archived product.
QUERY_TOO_LARGE
The query is too large to be processed.
PRODUCT_TEMPLATE_ID_IS_NOT_ZERO
When not using sales management, products should not have product templates.
INVALID_RATE
When not using sales management, products cannot have zero-value rates.
INVALID_CURRENCY
When not using sales management, the currency code for products must be the same as the network default currency code.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ProposalError Lists all errors associated with proposals.
Enumerations
AD_SERVER_UNKNOWN_ERROR
Unknown error from ad-server
AD_SERVER_API_ERROR
Ad-server reports an api error for the operation.
UPDATE_ADVERTISER_NOT_ALLOWED
Advertiser cannot be updated once the proposal has been reserved.
UPDATE_PROPOSAL_NOT_ALLOWED
Proposal cannot be updated when its status is not DRAFT or it is archived.
CONTACT_UNSUPPORTED_FOR_ADVERTISER
Contacts are not supported for advertisers in a programmatic Proposal.
INVALID_CONTACT
Contact associated with a proposal does not belong to the specific company.
DUPLICATED_CONTACT
Contact associated with a proposal's advertiser or agency is duplicated.
UNACCEPTABLE_COMPANY_CREDIT_STATUS
A proposal cannot be created or updated because the company it is associated with has Company.creditStatus that is not ACTIVE or ON_HOLD.
COMPANY_CREDIT_STATUS_NOT_ACTIVE
Advertiser or agency associated with the proposal has Company.creditStatus that is not ACTIVE.
PRIMARY_AGENCY_REQUIRED
Cannot have other agencies without a primary agency.
PRIMARY_AGENCY_NOT_UNIQUE
Cannot have more than one primary agency.
UNSUPPORTED_COMPANY_ASSOCIATION_TYPE_FOR_PROGRAMMATIC_PROPOSAL
The Company association type is not supported for programmatic proposals.
DUPLICATED_COMPANY_ASSOCIATION
Advertiser or agency associated with a proposal is duplicated.
DUPLICATED_SALESPERSON
Found duplicated primary or secondary sales person.
DUPLICATED_SALES_PLANNER
Found duplicated sales planner.
DUPLICATED_TRAFFICKER
Found duplicated primary or secondary trafficker.
HAS_NO_UNARCHIVED_PROPOSAL_LINEITEMS
The proposal has no unarchived proposal line items.
DUPLICATE_TERMS_AND_CONDITIONS
One or more of the terms and conditions being added already exists on the proposal.
UNSUPPORTED_PROPOSAL_CURRENCY_CODE
The currency code of the proposal is not supported by the current network. All supported currencies can be found in the union of Network.currencyCode and Network.secondaryCurrencyCodes.
UNSUPPORTED_BUYER_CURRENCY_CODE
The currency code of the proposal is not supported by the selected buyer.
INVALID_FIELDS_SET_FOR_NON_PROGRAMMATIC_PROPOSAL
Proposal.marketplaceInfo fields should not be set for a non-programmatic Proposal.
INVALID_POC
The POC value of the proposal is invalid.
UPDATE_CURRENCY_NOT_ALLOWED
Currency cannot be updated once the proposal has been reserved.
UPDATE_TIME_ZONE_NOT_ALLOWED
Time zone cannot be updated once the proposal has been sold.
NON_PROGRAMMATIC_PROPOSAL_NOT_ALLOWED
Sales management features must be enabled to use non-programmatic Proposal.
NEW_TRADITIONAL_ONLY_PROPOSAL_NOT_ALLOWED
New traditional direct proposals are no longer allowed in your network. Contact your DFP administrator for details about your network's transition to DFP Programmatic.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ProposalLineItemError Lists all errors associated with proposal line items.
Enumerations
NOT_SAME_RATE_CARD
The proposal line item's rate card is not the same as other proposal line items in the proposal.
LINE_ITEM_TYPE_NOT_ALLOWED
The proposal line item's type is not yet supported by Sales Manager.
END_DATE_TIME_NOT_AFTER_START_TIME
The proposal line item's end date time is not after its start date time.
END_DATE_TIME_TOO_LATE
The proposal line item's end date time is after 1/1/2037.
START_DATE_TIME_IS_IN_PAST
The proposal line item's start date time is in past.
END_DATE_TIME_IS_IN_PAST
The proposal line item's end date time is in past.
FRONTLOADED_NOT_ALLOWED
Frontloaded delivery rate type is not allowed.
ALL_ROADBLOCK_NOT_ALLOWED
Roadblocking to display all creatives is not allowed.
CREATIVE_SET_ROADBLOCK_NOT_ALLOWED
Roadblocking to display all master and companion creative set is not allowed.
ALREADY_STARTED
Some changes may not be allowed because the related line item has already started.
CONFLICT_WITH_PRODUCT
The setting is conflict with product's restriction.
VIOLATE_BUILT_IN_TARGETING_COMPATIBILITY_RESTRICTION
The proposal line item's setting violates the product's built-in targeting compatibility restriction.
VIOLATE_BUILT_IN_TARGETING_LOCKED_RESTRICTION
The proposal line item's setting violates the product's built-in targeting locked restriction.
MOBILE_TECH_CRITERIA_NOT_SUPPORTED
Cannot target mobile-only targeting criteria.
UNSUPPORTED_TARGETING_TYPE
The targeting criteria type is unsupported.
WRONG_COST
The contracted cost does not match with what calculated from final rate and units bought.
AGENCY_COMMISSION_MISMATCH
The net rate or net cost must be equal to the gross rate or gross cost multiplied by one minus agency commission.
CALCULATED_COST_TOO_HIGH
The cost calculated from cost per unit and units is too high.
INVALID_PRIORITY_FOR_LINE_ITEM_TYPE
The line item priority is invalid if it's different than the default.
UPDATE_PROPOSAL_LINE_ITEM_NOT_ALLOWED
Propsoal line item cannot update when it is archived.
CANNOT_UPDATE_TO_OR_FROM_CREATIVE_SET_ROADBLOCK
A proposal line item cannot be updated from having RoadblockingType.CREATIVE_SET to having a different RoadblockingType, or vice versa.
SEQUENTIAL_CREATIVE_ROTATION_NOT_ALLOWED
Serving creatives exactly in sequential order is not allowed.
UPDATE_RESERVATION_NOT_ALLOWED
Proposal line item cannot update its reservation detail once start delivering.
INVALID_COMPANION_DELIVERY_OPTION_FOR_ROADBLOCKING_TYPE
The companion delivery option is not valid for the roadblocking type.
INVALID_COMPANION_DELIVERY_OPTION_FOR_ENVIRONMENT_TYPE
The companion delivery option is not valid for your environment type.
INCONSISTENT_ROADBLOCK_TYPE
Roadblocking type is inconsistent with creative placeholders. If the roadblocking type is creative set, creative placeholders should contain companions, and vice versa.
INVALID_CONTRACTED_QUANTITY_BUFFER
ContractedQuantityBuffer is only applicable to standard line item with RateType.CPC/RateType.CPM/RateType.VCPM type.
INVALID_VALUES_FOR_CLICK_TRACKING_LINE_ITEM_TYPE
One or more values on the proposal line item are not valid for a LineItemType.CLICK_TRACKING line item type.
UPDATE_COST_ADJUSTMENT_NOT_ALLOWED
Proposal line item cannot update its cost adjustment after first approval.
UNSUPPORTED_RATE_CARD_CURRENCY_CODE
The currency code of the proposal line item's rate card is not supported by the current network. All supported currencies can be found in the union of Network.currencyCode and Network.secondaryCurrencyCodes.
END_DATE_TIME_IS_BEFORE_LAST_PAUSED_TIME
The corresponding line item is paused, but the proposal line item's end date time is before the last paused time.
VIDEO_INVALID_ROADBLOCKING
Video line items cannot have roadblocking options.
UPDATE_TIME_ZONE_NOT_ALLOWED
Time zone cannot be updated once the proposal line item has been sold.
INVALID_TIME_ZONE_FOR_RATE_TYPE
Time zone must be network time zone if the proposal line item is RateType.VCPM.
INVALID_TIME_ZONE_FOR_DEALS
Only the Network.timeZone is allowed for programmatic proposals.
INVALID_ENVIRONMENT_TYPE
The ProposalLineItem.environmentType is invalid.
SIZE_REQUIRED
At least one size must be specified.
COMPANION_NOT_ALLOWED
A placeholder contains companions but the roadblocking type is not RoadblockingType.CREATIVE_SET or the product type is offline.
MISSING_COMPANION
A placeholder does not contain companions but the roadblocking type is RoadblockingType.CREATIVE_SET.
DUPLICATED_MASTER_SIZE
A placeholder's master size is the same as another placeholder's master size.
INVALID_EXPECTED_CREATIVE_COUNT
Only creative placeholders with standard sizes can set an expected creative count.
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.
INVALID_CLICK_TRACKING_LINE_ITEM_TYPE
One or more values are not valid for a LineItemType.CLICK_TRACKING line item type.
INVALID_TARGETING_FOR_CLICK_TRACKING
The targeting is not valid for a LineItemType.CLICK_TRACKING line item type.
NOT_SAME_RATE_CARD_PRICING_MODEL
The RateCard pricing model for this ProposalLineItem is not the same as the pricing models for the other proposalLineItems or packages in the Proposal.
NOT_SAME_RATE_CARD_WORKFLOW
The RateCard workflow for this ProposalLineItem is not the same as the workflows for the other proposalLineItems or packages in the Proposal.
INVALID_CONTRACTED_UNITS_BOUGHT
The contractedUnitsBought of the proposal line item is invalid.
PLACEHOLDER_CANNOT_CONTAIN_LABELS
Only creative placeholders with standard sizes can contain labels.
INVALID_LABEL_TYPE_IN_PLACEHOLDER
One or more labels on a creative placeholder is invalid.
PLACEHOLDER_CANNOT_CONTAIN_NEGATED_LABELS
A placeholder cannot contain a negated label.
MARKETPLACE_RATE_CARD_NOT_ALLOWED
Marketplace RateCard cannot be used with a non-programmatic ProposalLineItem.
CANNOT_CREATE_FROM_PRODUCT
Cannot create ProposalLineItem from a Product if not using sales management.
CONTRACTED_UNITS_LESS_THAN_DELIVERED
Contracted impressions of programmatic proposal line item must be greater than already delivered impressions.
DISPLAY_ENVIRONMENT_MUST_HAVE_EXCLUDED_MOBILE_APPS_TARGETING
If AdExchangeEnvironment is DISPLAY, the proposal line item must have mobile apps as excluded device capability targeting.
MOBILE_ENVIRONMENT_MUST_HAVE_INCLUDED_MOBILE_APPS_TARGETING
If AdExchangeEnvironment is MOBILE, the proposal line item must have mobile apps as included device capability targeting.
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.
ReservationDetailsError Lists all errors associated with LineItem's reservation details.
Enumerations
UNLIMITED_UNITS_BOUGHT_NOT_ALLOWED
There is no limit on the number of ads delivered for a line item when you set LineItem.duration to be LineItemSummary.Duration.NONE. This can only be set for line items of type LineItemType.PRICE_PRIORITY.
UNLIMITED_END_DATE_TIME_NOT_ALLOWED
LineItem.unlimitedEndDateTime can be set to true for only line items of type LineItemType.SPONSORSHIP, LineItemType.NETWORK, LineItemType.PRICE_PRIORITY and LineItemType.HOUSE.
PERCENTAGE_UNITS_BOUGHT_TOO_HIGH
When LineItem.lineItemType is LineItemType.SPONSORSHIP, then LineItem.unitsBought represents the percentage of available impressions reserved. That value cannot exceed 100.
DURATION_NOT_ALLOWED
The line item type does not support the specified duration. See LineItemSummary.Duration for allowed values.
UNIT_TYPE_NOT_ALLOWED
The LineItem.unitType is not allowed for the given LineItem.lineItemType. See UnitType for allowed values.
COST_TYPE_NOT_ALLOWED
The LineItem.costType is not allowed for the LineItem.lineItemType. See CostType for allowed values.
COST_TYPE_UNIT_TYPE_MISMATCH_NOT_ALLOWED
When LineItem.costType is CostType.CPM, LineItem.unitType must be UnitType.IMPRESSIONS and when LineItem.costType is CostType.CPC, LineItem.unitType must be UnitType.CLICKS.
LINE_ITEM_TYPE_NOT_ALLOWED
Inventory cannot be reserved for line items which are not of type LineItemType.SPONSORSHIP or LineItemType.STANDARD.
NETWORK_REMNANT_ORDER_CANNOT_UPDATE_LINEITEM_TYPE
Network remnant line items cannot be changed to other line item types once delivery begins. This restriction does not apply to any new line items created in Ad Manager.
BACKFILL_WEBPROPERTY_CODE_NOT_ALLOWED
A dynamic allocation web property can only be set on a line item of type AdSense or Ad Exchange.
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.
TeamError Errors related to a Team.
Enumerations
ENTITY_NOT_ON_USERS_TEAMS
User cannot use this entity because it is not on any of the user's teams.
AD_UNITS_NOT_ON_ORDER_TEAMS
The targeted or excluded ad unit must be on the order's teams.
PLACEMENTS_NOT_ON_ORDER_TEAMS
The targeted placement must be on the order's teams.
MISSING_USERS_TEAM
Entity cannot be created because it is not on any of the user's teams.
ALL_TEAM_ASSOCIATION_NOT_ALLOWED
A team that gives access to all entities of a given type cannot be associated with an entity of that type.
INVALID_TEAM_ASSIGNMENT
The assignment of team to entities is invalid.
ALL_TEAM_ACCESS_OVERRIDE_NOT_ALLOWED
The all entities team access type cannot be overridden.
CANNOT_UPDATE_INACTIVE_TEAM
Cannot modify or create a team with an inactive status.
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.
TimeZoneError Errors related to timezones.
Enumerations
INVALID_TIMEZONE_ID
Indicates that the timezone ID provided is not supported.
TIMEZONE_ID_IN_WRONG_FORMAT
Indicates that the timezone ID provided is in the wrong format. The timezone ID must be in tz database format (e.g. "America/Los_Angeles").
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
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.

Send feedback about...

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