LineItemCreativeAssociationService (v201808)

Provides operations for creating, updating and retrieving LineItemCreativeAssociation objects.

A line item creative association (LICA) associates a Creative with a LineItem. When a line item is selected to serve, the LICAs specify which creatives can appear for the ad units that are targeted by the line item. In order to be associated with a line item, the creative must have a size that exists within the attribute LineItem.creativeSizes.

Each LICA has a start and end date and time that defines when the creative should be displayed.

To read more about associating creatives with line items, see this DFP Help Center article.


Production WSDL
https://ads.google.com/apis/ads/publisher/v201808/LineItemCreativeAssociationService?wsdl
Namespace
https://www.google.com/apis/ads/publisher/v201808
Operations
Errors

createLineItemCreativeAssociations

Creates new LineItemCreativeAssociation objects

Parameters

Field Type Description
lineItemCreativeAssociations LineItemCreativeAssociation[] the line item creative associations to create

Response

Field Type Description
rval LineItemCreativeAssociation[] the created line item creative associations with their IDs filled in

getLineItemCreativeAssociationsByStatement

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

PQL Property Object Property
creativeId LineItemCreativeAssociation.creativeId
manualCreativeRotationWeight LineItemCreativeAssociation.manualCreativeRotationWeight
destinationUrl LineItemCreativeAssociation.destinationUrl
lineItemId LineItemCreativeAssociation.lineItemId
status LineItemCreativeAssociation.status
lastModifiedDateTime LineItemCreativeAssociation.lastModifiedDateTime

Parameters

Field Type Description
filterStatement Statement a Publisher Query Language statement used to filter a set of line item creative associations

Response

Field Type Description
rval LineItemCreativeAssociation... the line item creative associations that match the given filter

getPreviewUrl

Returns an insite preview URL that references the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id.

Parameters

Field Type Description
lineItemId xsd:long the ID of the line item, which must already exist
creativeId xsd:long the ID of the creative, which must already exist
siteUrl xsd:string the URL of the site that the creative should be previewed in

Response

Field Type Description
rval xsd:string a URL that references the specified site URL with the specified creative served to it

getPreviewUrlsForNativeStyles

Returns a list of URLs that reference the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id. Each URL corresponds to one available native style for previewing the specified creative.

Parameters

Field Type Description
lineItemId xsd:long the ID of the line item, which must already exist
creativeId xsd:long the ID of the creative, which must already exist and must be a native creative
siteUrl xsd:string the URL of the site that the creative should be previewed in

Response

Field Type Description
rval CreativeNativeStylePreview[] the URLs that references the specified site URL and can be used to preview the specified creative with the available native styles

performLineItemCreativeAssociationAction

Performs actions on LineItemCreativeAssociation objects that match the given Statement.query.

Parameters

Field Type Description
lineItemCreativeAssociationAction
  1. LineItemCreativeAssociation...
    1. ActivateLineItemCreativeAss...
    2. DeactivateLineItemCreativeA...
    3. DeleteLineItemCreativeAssoc...
the action to perform
filterStatement Statement a Publisher Query Language statement used to filter a set of line item creative associations

Response

Field Type Description
rval UpdateResult the result of the action performed

updateLineItemCreativeAssociations

Updates the specified LineItemCreativeAssociation objects

Parameters

Field Type Description
lineItemCreativeAssociations LineItemCreativeAssociation[] the line item creative associations to update

Response

Field Type Description
rval LineItemCreativeAssociation[] the updated line item creative associations

Errors

Error Reasons
AdSenseAccountError Error for AdSense related API calls.
Enumerations
ASSOCIATE_ACCOUNT_API_ERROR
An error occurred while trying to associate an AdSense account with Ad Manager. Unable to create an association with AdSense or Ad Exchange account.
GET_AD_SLOT_API_ERROR
An error occured while trying to get an associated web property's ad slots. Unable to retrieve ad slot information from AdSense or Ad Exchange account.
GET_CHANNEL_API_ERROR
An error occurred while trying to get an associated web property's ad channels.
GET_BULK_ACCOUNT_STATUSES_API_ERROR
An error occured while trying to retrieve account statues from AdSense API. Unable to retrieve account status information. Please try again later.
RESEND_VERIFICATION_EMAIL_ERROR
An error occured while trying to resend the account association verification email. Error resending verification email. Please try again.
UNEXPECTED_API_RESPONSE_ERROR
An error occured while trying to retrieve a response from the AdSense API. There was a problem processing your request. Please try again later.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
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.
AssetError Lists all errors associated with assets.
Enumerations
NON_UNIQUE_NAME
An asset name must be unique across advertiser.
FILE_NAME_TOO_LONG
The file name is too long.
FILE_SIZE_TOO_LARGE
The file size is too large.
MISSING_REQUIRED_DYNAMIC_ALLOCATION_CLIENT
Required client code is not present in the code snippet.
MISSING_REQUIRED_DYNAMIC_ALLOCATION_HEIGHT
Required height is not present in the code snippet.
MISSING_REQUIRED_DYNAMIC_ALLOCATION_WIDTH
Required width is not present in the code snippet.
MISSING_REQUIRED_DYNAMIC_ALLOCATION_FORMAT
Required format is not present in the mobile code snippet.
INVALID_CODE_SNIPPET_PARAMETER_VALUE
The parameter value in the code snippet is invalid.
INVALID_ASSET_ID
Invalid asset Id.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
AudienceExtensionError Errors associated with audience extension enabled line items
Enumerations
FREQUENCY_CAPS_NOT_SUPPORTED
Frequency caps are not supported by audience extension line items
INVALID_TARGETING
Audience extension line items can only target geography
INVENTORY_UNIT_TARGETING_INVALID
Audience extension line items can only target audience extension inventory units
INVALID_CREATIVE_ROTATION
Audience extension line items do not support CreativeRotationType.SEQUENTIAL.
INVALID_EXTERNAL_ENTITY_ID
The given ID of the external entity is not valid
INVALID_LINE_ITEM_TYPE
Audience extension line items only support LineItemType.STANDARD.
INVALID_MAX_BID
Audience extension max bid is invalid when it is greater then the max budget.
AUDIENCE_EXTENSION_BULK_UPDATE_NOT_ALLOWED
Bulk update for audience extension line items is not allowed.
UNEXPECTED_AUDIENCE_EXTENSION_ERROR
An unexpected error occurred.
MAX_DAILY_BUDGET_AMOUNT_EXCEEDED
The value entered for the maximum daily budget on an audience extension line item exceeds the maximum allowed.
EXTERNAL_CAMPAIGN_ALREADY_EXISTS
Creating a campaign for a line item that already has an associated campaign is not allowed.
AUDIENCE_EXTENSION_WITHOUT_FEATURE
Audience extension was specified on a line item but the feature was not enabled.
AUDIENCE_EXTENSION_WITHOUT_LINKED_ACCOUNT
Audience extension was specified on a line item but no audience extension account has been linked.
CANNOT_OVERRIDE_CREATIVE_SIZE_WITH_AUDIENCE_EXTENSION
Assocation creative size overrides are not allowed with audience extension.
CANNOT_OVERRIDE_FIELD_WITH_AUDIENCE_EXTENSION
Some association overrides are not allowed with audience extension.
ONLY_ONE_CREATIVE_PLACEHOLDER_ALLOWED
Only one creative placeholder is allowed for an audience extension line item.
MULTIPLE_AUDIENCE_EXTENSION_LINE_ITEMS_ON_ORDER
Only one audience extension line item can be associated with a given order.
CANNOT_COPY_AUDIENCE_EXTENSION_LINE_ITEMS_AND_CREATIVES_TOGETHER
Audience extension line items must be copied separately from their associated creatives.
FEATURE_DEPRECATED
Audience extension is no longer supported and cannot be used.
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.
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.
CreativeAssetMacroError Lists all errors associated with creative asset macros.
Enumerations
INVALID_MACRO_NAME
Invalid macro name specified. Macro names must start with an alpha character and consist only of alpha-numeric characters and underscores and be between 1 and 64 characters.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CreativeError Lists all errors associated with creatives.
Enumerations
FLASH_AND_FALLBACK_URL_ARE_SAME
FlashRedirectCreative.flashUrl and FlashRedirectCreative.fallbackUrl are the same. The fallback URL is used when the flash URL does not work and must be different from it.
INVALID_INTERNAL_REDIRECT_URL
The internal redirect URL was invalid. The URL must have the following syntax http://ad.doubleclick.net/ad/sitename/;sz=size.
DESTINATION_URL_REQUIRED
HasDestinationUrlCreative.destinationUrl is required.
DESTINATION_URL_NOT_EMPTY
HasDestinationUrlCreative.destinationUrl must be empty when its type is DestinationUrlType.NONE.
DESTINATION_URL_TYPE_NOT_SUPPORTED
The provided DestinationUrlType is not supported for the creative type it is being used on.
CANNOT_CREATE_OR_UPDATE_LEGACY_DFP_CREATIVE
Cannot create or update legacy DART For Publishers creative.
CANNOT_CREATE_OR_UPDATE_LEGACY_DFP_MOBILE_CREATIVE
Cannot create or update legacy mobile creative.
MISSING_FEATURE
The user is missing a necessary feature.
INVALID_COMPANY_TYPE
Company type should be one of Advertisers, House Advertisers and Ad Networks.
INVALID_ADSENSE_CREATIVE_SIZE
Invalid size for AdSense dynamic allocation creative. Only valid AFC sizes are allowed.
INVALID_AD_EXCHANGE_CREATIVE_SIZE
Invalid size for Ad Exchange dynamic allocation creative. Only valid Ad Exchange sizes are allowed.
DUPLICATE_ASSET_IN_CREATIVE
Assets associated with the same creative must be unique.
CREATIVE_ASSET_CANNOT_HAVE_ID_AND_BYTE_ARRAY
A creative asset cannot contain an asset ID and a byte array.
CANNOT_CREATE_OR_UPDATE_UNSUPPORTED_CREATIVE
Cannot create or update unsupported creative.
CANNOT_CREATE_PROGRAMMATIC_CREATIVES
Cannot create programmatic creatives.
INVALID_SIZE_FOR_THIRD_PARTY_IMPRESSION_TRACKER
A creative must have valid size to use the third-party impression tracker.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CreativePreviewError Errors associated with generation of creative preview URIs.
Enumerations
CANNOT_GENERATE_PREVIEW_URL
The creative cannot be previewed on this page.
CANNOT_GENERATE_PREVIEW_URL_FOR_NATIVE_CREATIVES
Preview URLs for native creatives must be retrieved with LineItemCreativeAssociationService.getPreviewUrlsForNativeStyles.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CreativeSetError Errors relating to creative sets & subclasses.
Enumerations
VIDEO_FEATURE_REQUIRED
The 'video' feature is required but not enabled.
CANNOT_CREATE_OR_UPDATE_VIDEO_CREATIVES
Video creatives (including overlays, VAST redirects, etc..) cannot be created or updated through the API.
ROADBLOCK_FEATURE_REQUIRED
The 'roadblock' feature is required but not enabled.
MASTER_CREATIVE_CANNOT_BE_COMPANION
A master creative cannot be a companion creative in the same creative set.
INVALID_ADVERTISER
Creatives in a creative set must be for the same advertiser.
UPDATE_MASTER_CREATIVE_NOT_ALLOWED
Updating a master creative in a creative set is not allowed.
MASTER_CREATIVE_CANNOT_BELONG_TO_MULTIPLE_VIDEO_CREATIVE_SETS
A master creative must belong to only one video creative set.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CreativeTemplateError A catch-all error that lists all generic errors associated with CreativeTemplate.
Enumerations
CANNOT_PARSE_CREATIVE_TEMPLATE
The XML of the creative template definition is malformed and cannot be parsed.
VARIABLE_DUPLICATE_UNIQUE_NAME
A creative template has multiple variables with the same uniqueName.
VARIABLE_INVALID_UNIQUE_NAME
The creative template contains a variable with invalid characters. Valid characters are letters, numbers, spaces, forward slashes, dashes, and underscores.
LIST_CHOICE_DUPLICATE_VALUE
Multiple choices for a CreativeTemplateListStringVariable have the same value.
LIST_CHOICE_NEEDS_DEFAULT
The choices for a CreativeTemplateListStringVariable do not contain the default value.
LIST_CHOICES_EMPTY
There are no choices specified for the list variable.
NO_TARGET_PLATFORMS
No target platform is assigned to a creative template.
MULTIPLE_TARGET_PLATFORMS
More than one target platform is assigned to a single creative template.
UNRECOGNIZED_PLACEHOLDER
The formatter contains a placeholder which is not defined as a variable.
PLACEHOLDERS_NOT_IN_FORMATTER
There are variables defined which are not being used in the formatter.
MISSING_INTERSTITIAL_MACRO
The creative template is interstitial, but the formatter doesn't contain an interstitial macro.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CreativeTemplateOperationError An error that can occur while performing an operation on a creative template.
Enumerations
NOT_ALLOWED
The current user is not allowed to modify this creative template.
NOT_APPLICABLE
The operation is not applicable to the current state. (e.g. Trying to activate an active creative template)
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CustomCreativeError Lists all errors associated with custom creatives.
Enumerations
DUPLICATE_MACRO_NAME_FOR_CREATIVE
Macros associated with a single custom creative must have unique names.
SNIPPET_REFERENCES_MISSING_MACRO
The file macro referenced in the snippet does not exist.
UNRECOGNIZED_MACRO
The macro referenced in the snippet is not valid.
CUSTOM_CREATIVE_NOT_ALLOWED
Custom creatives are not allowed in this context.
MISSING_INTERSTITIAL_MACRO
The custom creative is an interstitial, but the snippet is missing an interstitial macro.
DUPLICATE_ASSET_IN_MACROS
Macros associated with the same custom creative cannot share the same asset.
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.
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.
FileError A list of all errors to be used for problems related to files.
Enumerations
MISSING_CONTENTS
The provided byte array is empty.
SIZE_TOO_LARGE
The provided file is larger than the maximum size defined for the network.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
HtmlBundleProcessorError Lists all errors associated with html5 file processing.
Enumerations
CANNOT_EXTRACT_FILES_FROM_BUNDLE
Cannot extract files from HTML5 bundle.
CLICK_TAG_HARD_CODED
Bundle cannot have hard-coded click tag url(s).
CLICK_TAG_IN_GWD_UNUPPORTED
Bundles created using GWD (Google Web Designer) cannot have click tags. GWD-published bundles should use exit events instead of defining var clickTAG.
CLICK_TAG_NOT_IN_PRIMARY_HTML
Click tag detected outside of primary HTML file.
CLICK_TAG_INVALID
Click tag or exit function has invalid name or url.
FILE_SIZE_TOO_LARGE
HTML5 bundle or total size of extracted files cannot be more than 1000 KB.
FILES_TOO_MANY
HTML5 bundle cannot have more than 50 files.
FLASH_UNSUPPORTED
Flash files in HTML5 bundles are not supported. Any file with a .swf or .flv extension causes this error.
GWD_COMPONENTS_UNSUPPORTED
The HTML5 bundle contains unsupported GWD component(s).
GWD_ENABLER_METHODS_UNSUPPORTED
The HTML5 bundle contains Unsupported GWD Enabler method(s).
GWD_PROPERTIES_INVALID
GWD properties are invalid.
LINKED_FILES_NOT_FOUND
The HTML5 bundle contains broken relative file reference(s).
PRIMARY_HTML_MISSING
No primary HTML file detected.
PRIMARY_HTML_UNDETERMINED
Multiple HTML files are detected. One of them should be named as index.html
SVG_BLOCK_INVALID
An SVG block could not be parsed.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ImageError Lists all errors associated with images.
Enumerations
INVALID_IMAGE
The file's format is invalid.
INVALID_SIZE
Size.width and Size.height cannot be negative.
UNEXPECTED_SIZE
The actual image size does not match the expected image size.
OVERLAY_SIZE_TOO_LARGE
The size of the asset is larger than that of the overlay creative.
ANIMATED_NOT_ALLOWED
Animated images are not allowed.
ANIMATION_TOO_LONG
Animation length exceeded the allowed policy limit.
CMYK_JPEG_NOT_ALLOWED
Images in CMYK color formats are not allowed.
FLASH_NOT_ALLOWED
Flash files are not allowed.
FLASH_WITHOUT_CLICKTAG
If FlashCreative.clickTagRequired is true, then the flash file is required to have a click tag embedded in it.
ANIMATED_VISUAL_EFFECT
Animated visual effect is not allowed.
FLASH_ERROR
An error was encountered in the flash file.
LAYOUT_PROBLEM
Incorrect image layout.
FLASH_HAS_NETWORK_OBJECTS
Flash files with network objects are not allowed.
FLASH_HAS_NETWORK_METHODS
Flash files with network methods are not allowed.
FLASH_HAS_URL
Flash files with hard-coded click thru URLs are not allowed.
FLASH_HAS_MOUSE_TRACKING
Flash files with mouse tracking are not allowed.
FLASH_HAS_RANDOM_NUM
Flash files that generate or use random numbers are not allowed.
FLASH_SELF_TARGETS
Flash files with self targets are not allowed.
FLASH_BAD_GETURL_TARGET
Flash file contains a bad geturl target.
FLASH_VERSION_NOT_SUPPORTED
Flash or ActionScript version in the submitted file is not supported.
FILE_TOO_LARGE
The uploaded file is too large.
SYSTEM_ERROR
A system error occurred, please try again.
UNEXPECTED_PRIMARY_ASSET_DENSITY
The image density for a primary asset was not one of the expected image densities.
DUPLICATE_ASSET_DENSITY
Two or more assets have the same image density.
MISSING_DEFAULT_ASSET
The creative does not contain a primary asset. (For high-density creatives, the primary asset must be a standard image file with 1x density.)
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.
InvalidPhoneNumberError Lists all errors associated with phone numbers.
Enumerations
INVALID_FORMAT
The phone number is invalid.
TOO_SHORT
The phone number is too short.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
InvalidUrlError Lists all errors associated with URLs.
Enumerations
ILLEGAL_CHARACTERS
The URL contains invalid characters.
INVALID_FORMAT
The format of the URL is not allowed. This could occur for a number of reasons. For example, if an invalid scheme is specified (like "ftp://") or if a port is specified when not required, or if a query was specified when not required.
INSECURE_SCHEME
URL contains insecure scheme.
NO_SCHEME
The URL does not contain a scheme.
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.
LineItemCreativeAssociationError Lists all errors associated with line item-to-creative association dates.
Enumerations
CREATIVE_IN_WRONG_ADVERTISERS_LIBRARY
Cannot associate a creative to the wrong advertiser
INVALID_LINEITEM_CREATIVE_PAIRING
The creative type being associated is a invalid for the line item type.
STARTDATE_BEFORE_LINEITEM_STARTDATE
Association start date cannot be before line item start date
STARTDATE_NOT_BEFORE_LINEITEM_ENDDATE
Association start date cannot be same as or after line item end date
ENDDATE_AFTER_LINEITEM_ENDDATE
Association end date cannot be after line item end date
ENDDATE_NOT_AFTER_LINEITEM_STARTDATE
Association end date cannot be same as or before line item start date
ENDDATE_NOT_AFTER_STARTDATE
Association end date cannot be same as or before its start date
ENDDATE_IN_THE_PAST
Association end date cannot be in the past.
CANNOT_COPY_WITHIN_SAME_LINE_ITEM
Cannot copy an association to the same line item without creating new creative
UNSUPPORTED_CREAIVE_VAST_REDIRECT_TYPE
Programmatic only supports the "Video" redirect type.
UNSUPPORTED_YOUTUBE_HOSTED_CREATIVE
Programmatic does not support YouTube hosted creatives.
PROGRAMMATIC_CREATIVES_CAN_ONLY_BE_ASSIGNED_TO_ONE_LINE_ITEM
Programmatic creatives can only be assigned to one line item.
CANNOT_CREATE_PROGRAMMATIC_CREATIVES
Cannot create programmatic creatives.
CANNOT_UPDATE_PROGRAMMATIC_CREATIVES
Cannot update programmatic creatives.
CREATIVE_AND_LINE_ITEM_MUST_BOTH_BE_SET_TOP_BOX_ENABLED
Cannot associate a creative with a line item if only one of them is set-top box enabled.
CANNOT_DELETE_SET_TOP_BOX_ENABLED_ASSOCIATIONS
Cannot delete associations between set-top box enabled line items and set-top box enabled creatives.
SET_TOP_BOX_CREATIVE_ROTATION_WEIGHT_MUST_BE_INTEGER
Creative rotation weights must be integers.
INVALID_CREATIVE_ROTATION_TYPE_FOR_MANUAL_WEIGHT
Creative rotation weights are only valid when creative rotation type is set to CreativeRotationType.MANUAL.
CLICK_MACROS_REQUIRED
The code snippet of a creative must contain a click macro (%%CLICK_URL_ESC%% or %%CLICK_URL_UNESC%%).
VIEW_MACROS_NOT_ALLOWED
The code snippet of a creative must not contain a view macro (%%VIEW_URL_ESC%% or %%VIEW_URL_UNESC%%).
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
LineItemCreativeAssociationOperationError Lists all errors for executing operations on line item-to-creative associations
Enumerations
NOT_ALLOWED
The operation is not allowed due to permissions
NOT_APPLICABLE
The operation is not applicable to the current state
CANNOT_ACTIVATE_INVALID_CREATIVE
Cannot activate an invalid creative
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
LineItemError A catch-all error that lists all generic errors associated with LineItem.
Enumerations
ALREADY_STARTED
Some changes may not be allowed because a line item has already started.
UPDATE_RESERVATION_NOT_ALLOWED
Update reservation is not allowed because a line item has already started, users must pause the line item first.
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.
FRACTIONAL_PERCENTAGE_NOT_ALLOWED
Fractional percentage is not allowed.
DISCOUNT_NOT_ALLOWED
For certain LineItem configurations discounts are not allowed.
UPDATE_CANCELED_LINE_ITEM_NOT_ALLOWED
Updating a canceled line item is not allowed.
UPDATE_PENDING_APPROVAL_LINE_ITEM_NOT_ALLOWED
Updating a pending approval line item is not allowed.
UPDATE_ARCHIVED_LINE_ITEM_NOT_ALLOWED
Updating an archived line item is not allowed.
CREATE_OR_UPDATE_LEGACY_DFP_LINE_ITEM_TYPE_NOT_ALLOWED
Create or update legacy dfp line item type is not allowed.
COPY_LINE_ITEM_FROM_DIFFERENT_COMPANY_NOT_ALLOWED
Copying line item from different company (advertiser) to the same order is not allowed.
INVALID_SIZE_FOR_PLATFORM
The size is invalid for the specified platform.
INVALID_LINE_ITEM_TYPE_FOR_PLATFORM
The line item type is invalid for the specified platform.
INVALID_WEB_PROPERTY_FOR_PLATFORM
The web property cannot be served on the specified platform.
INVALID_WEB_PROPERTY_FOR_ENVIRONMENT
The web property cannot be served on the specified environment.
AFMA_BACKFILL_NOT_ALLOWED
AFMA backfill not supported.
UPDATE_ENVIRONMENT_TYPE_NOT_ALLOWED
Environment type cannot change once saved.
COMPANIONS_NOT_ALLOWED
The placeholders are invalid because they contain companions, but the line item does not support companions.
ROADBLOCKS_WITH_NONROADBLOCKS_NOT_ALLOWED
The placeholders are invalid because some of them are roadblocks, and some are not. Either all roadblock placeholders must contain companions, or no placeholders may contain companions. This does not apply to video creative sets.
CANNOT_UPDATE_TO_OR_FROM_CREATIVE_SET_ROADBLOCK
A line item cannot be updated from having RoadblockingType.CREATIVE_SET to having a different RoadblockingType, or vice versa.
UPDATE_FROM_BACKFILL_LINE_ITEM_TYPE_NOT_ALLOWED
Can not change from a backfill line item type once creatives have been assigned.
UPDATE_TO_BACKFILL_LINE_ITEM_TYPE_NOT_ALLOWED
Can not change to a backfill line item type once creatives have been assigned.
UPDATE_BACKFILL_WEB_PROPERTY_NOT_ALLOWED
Can not change to backfill web property once creatives have been assigned.
INVALID_COMPANION_DELIVERY_OPTION_FOR_ENVIRONMENT_TYPE
The companion delivery option is not valid for your environment type.
COMPANION_BACKFILL_REQUIRES_VIDEO
Companion backfill is enabled but environment type not video.
COMPANION_DELIVERY_OPTION_REQUIRE_PREMIUM
Companion delivery options require Ad Manager 360 networks.
DUPLICATE_MASTER_SIZES
The master size of placeholders have duplicates.
INVALID_PRIORITY_FOR_LINE_ITEM_TYPE
The line item priority is invalid if for dynamic allocation line items it is different than the default for free publishers. When allowed, Ad Manager 360 users can change the priority to any value.
INVALID_ENVIRONMENT_TYPE
The environment type is not valid.
INVALID_ENVIRONMENT_TYPE_FOR_PLATFORM
The environment type is not valid for the target platform.
INVALID_TYPE_FOR_AUTO_EXTENSION
Only LineItemType.STANDARD line items can be auto extended.
VIDEO_INVALID_ROADBLOCKING
Video line items cannot change the roadblocking type.
BACKFILL_TYPE_NOT_ALLOWED
The backfill feature is not enabled according to your features.
INVALID_BACKFILL_LINK_TYPE
The web property is invalid. A line item must have an appropriate web property selected.
DIFFERENT_BACKFILL_ACCOUNT
All line items in a programmatic order must have web property codes from the same account.
COMPANION_DELIVERY_OPTIONS_NOT_ALLOWED_WITH_BACKFILL
Companion delivery options are not allowed with dynamic allocation line items.
INVALID_WEB_PROPERTY_FOR_ADX_BACKFILL
Dynamic allocation using the AdExchange should always use an AFC web property.
INVALID_SIZE_FOR_ENVIRONMENT
Aspect ratio sizes cannot be used with video line items.
TARGET_PLATOFRM_NOT_ALLOWED
The specified target platform is not allowed.
INVALID_LINE_ITEM_CURRENCY
Currency on a line item must be one of the specified network currencies.
LINE_ITEM_CANNOT_HAVE_MULTIPLE_CURRENCIES
All money fields on a line item must specify the same currency.
CANNOT_CHANGE_CURRENCY
Once a line item has moved into a a delivering state the currency cannot be changed.
INVALID_LINE_ITEM_DATE_TIME
A DateTime associated with the line item is not valid.
INVALID_COST_PER_UNIT_FOR_CPA
CPA line items must specify a zero cost for the LineItem.costPerUnit.
UPDATE_CPA_COST_TYPE_NOT_ALLOWED
Once a LineItem is activated its LineItem.costPerUnit cannot be updated to/from CPA.
UPDATE_VCPM_COST_TYPE_NOT_ALLOWED
Once a LineItem is activated its LineItem.costPerUnit cannot be updated to/from Viewable CPM.
MASTER_COMPANION_LINE_ITEM_CANNOT_HAVE_VCPM_COST_TYPE
A LineItem with master/companion creative placeholders cannot have Viewable CPM as its LineItem.costPerUnit.
DUPLICATED_UNIT_TYPE
There cannot be goals with duplicated unit type among the secondary goals for a line items.
MULTIPLE_GOAL_TYPE_NOT_ALLOWED
The secondary goals of a line items must have the same goal type.
INVALID_UNIT_TYPE_COMBINATION_FOR_SECONDARY_GOALS
For a CPA line item, the possible combinations for secondary goals must be either click-through conversion only, click-through conversion with view-through conversion or total conversion only. For a Viewable CPM line item or a CPM based Sponsorship line item, its secondary goal has to be impression-based.
INVALID_CREATIVE_TARGETING_NAME
One or more of the targeting names specified by a creative placeholder or line item creative association were not found on the line item.
INVALID_CREATIVE_CUSTOM_TARGETING_MATCH_TYPE
Creative targeting expressions on the line item can only have custom criteria targeting with CustomTargetingValue.MatchType.EXACT.
INVALID_CREATIVE_ROTATION_TYPE_WITH_CREATIVE_TARGETING
Line item with creative targeting expressions cannot have creative rotation type set to CreativeRotationType.SEQUENTIAL.
CANNOT_OVERBOOK_WITH_CREATIVE_TARGETING
Line items cannot overbook inventory when applying creative-level targeting if the originating proposal line item did not overbook inventory. Remove creative-level targeting and try again.
PLACEHOLDERS_DO_NOT_MATCH_PROPOSAL
For a managed line item, inventory sizes must match sizes that are set on the originating proposal line item. In the case that a size is broken out by creative-level targeting, the sum of the creative counts for each size must equal the expected creative count that is set for that size on the originating proposal line item.
UNSUPPORTED_LINE_ITEM_TYPE_FOR_THIS_API_VERSION
The line item type is not supported for this API version.
NATIVE_CREATIVE_TEMPLATE_REQUIRED
Placeholders can only have native creative templates.
CANNOT_HAVE_CREATIVE_TEMPLATE
Non-native placeholders cannot have creative templates.
CANNOT_INCLUDE_NATIVE_CREATIVE_TEMPLATE
Cannot include native creative templates in the placeholders for Ad Exchange line items.
CANNOT_INCLUDE_NATIVE_PLACEHOLDER_WITHOUT_TEMPLATE_ID
Cannot include native placeholders without native creative templates for direct-sold line items.
NO_SIZE_WITH_DURATION
For forecasting only, error when line item has duration, but no creative sizes specified.
INVALID_VIEWABILITY_PROVIDER_COMPANY
Used when the company pointed to by the viewabilityProviderCompanyId is not of type VIEWABILITY_PROVIDER.
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
OrderError Lists all errors associated with orders.
Enumerations
UPDATE_CANCELED_ORDER_NOT_ALLOWED
Updating a canceled order is not allowed.
UPDATE_PENDING_APPROVAL_ORDER_NOT_ALLOWED
Updating an order that has its approval pending is not allowed.
UPDATE_ARCHIVED_ORDER_NOT_ALLOWED
Updating an archived order is not allowed.
CANNOT_MODIFY_PROPOSAL_ID
DSM can set the proposal ID only at the time of creation of order. Setting or changing proposal ID at the time of order update is not allowed.
PRIMARY_USER_REQUIRED
Cannot have secondary user without a primary user.
PRIMARY_USER_CANNOT_BE_SECONDARY
Primary user cannot be added as a secondary user too.
ORDER_TEAM_NOT_ASSOCIATED_WITH_ADVERTISER
A team associated with the order must also be associated with the advertiser.
USER_NOT_ON_ORDERS_TEAMS
The user assigned to the order, like salesperson or trafficker, must be on one of the order's teams.
AGENCY_NOT_ON_ORDERS_TEAMS
The agency assigned to the order must belong to one of the order's teams.
INVALID_FIELDS_SET_FOR_NON_PROGRAMMATIC_ORDER
Programmatic info fields should not be set for a non-programmatic order.
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.
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.
RequiredSizeError A list of all errors to be used for validating Size.
Enumerations
REQUIRED
Creative.size or LineItem.creativeSizes is missing.
NOT_ALLOWED
LineItemCreativeAssociation.sizes must be a subset of LineItem.creativeSizes.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
RichMediaStudioCreativeError Lists all errors associated with Studio creatives.
Enumerations
CREATION_NOT_ALLOWED
Only Studio can create a RichMediaStudioCreative.
UKNOWN_ERROR
Unknown error
INVALID_CODE_GENERATION_REQUEST
Invalid request indicating missing/invalid request parameters.
INVALID_CREATIVE_OBJECT
Invalid creative object.
STUDIO_CONNECTION_ERROR
Unable to connect to Rich Media Studio to save the creative. Please try again later.
PUSHDOWN_DURATION_NOT_ALLOWED
The push down duration is not allowed
INVALID_POSITION
The position is invalid
INVALID_Z_INDEX
The Z-index is invalid
INVALID_PUSHDOWN_DURATION
The push-down duration is invalid
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.
SetTopBoxCreativeError Errors associated with set-top box creatives.
Enumerations
EXTERNAL_ASSET_ID_IMMUTABLE
Set-top box creative external asset IDs are immutable after creation.
EXTERNAL_ASSET_ID_REQUIRED
Set-top box creatives require an external asset ID.
PROVIDER_ID_IMMUTABLE
Set-top box creative provider IDs are immutable after creation.
INVALID_THIRD_PARTY_TRACKING_URL_EVENT_TYPE
An invalid tracking URL event type was set on the set-top box creative.
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.
SwiffyConversionError Error for converting flash to swiffy asset.
Enumerations
SERVER_ERROR
Indicates the Swiffy service has an internal error that prevents the flash asset being converted.
INVALID_FLASH_FILE
Indicates the uploaded flash asset is not a valid flash file.
UNSUPPORTED_FLASH
Indicates the Swiffy service currently does not support converting this flash asset.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
TemplateInstantiatedCreativeError Lists all errors associated with template instantiated creatives.
Enumerations
INACTIVE_CREATIVE_TEMPLATE
A new creative cannot be created from an inactive creative template.
FILE_TYPE_NOT_ALLOWED
An uploaded file type is not allowed
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

Send feedback about...

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