Note: Version v201902 will be sunset soon. All users of those versions must migrate to a newer one.

CreativeSetService (v201905)

Provides methods for adding, updating and retrieving CreativeSet objects.


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

createCreativeSet

Creates a new CreativeSet.

Parameters

Field Type Description
creativeSet CreativeSet the creative set to create

Response

Field Type Description
rval CreativeSet the creative set with its ID filled in

getCreativeSetsByStatement

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

PQL Property Object Property
id CreativeSet.id
name CreativeSet.name
masterCreativeId CreativeSet.masterCreativeId
lastModifiedDateTime CreativeSet.lastModifiedDateTime

Parameters

Field Type Description
statement Statement a Publisher Query Language statement used to filter a set of creative sets

Response

Field Type Description
rval CreativeSetPage the creative sets that match the given filter

updateCreativeSet

Updates the specified CreativeSet.

Parameters

Field Type Description
creativeSet CreativeSet the creative set to update

Response

Field Type Description
rval CreativeSet the updated creative set

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.
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.
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.
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.
EntityLimitReachedError An error that occurs when creating an entity if the limit on the number of allowed entities for a network has already been reached.
Enumerations
CUSTOM_TARGETING_VALUES_LIMIT_REACHED
The number of custom targeting values exceeds the max number allowed in the network.
AD_EXCLUSION_RULES_LIMIT_REACHED
The number of ad exclusion rules exceeds the max number allowed in the network.
FIRST_PARTY_AUDIENCE_SEGMENTS_LIMIT_REACHED
The number of first party audience segments exceeds the max number allowed in the network.
PLACEMENTS_LIMIT_REACHED
The number of active placements exceeds the max number allowed in the network.
LINE_ITEMS_LIMIT_REACHED
The number of line items excceeds the max number allowed in the network.
ACTIVE_LINE_ITEMS_LIMIT_REACHED
The number of active line items exceeds the max number allowed in the network.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
FeatureError Errors related to feature management. If you attempt using a feature that is not available to the current network you'll receive a FeatureError with the missing feature as the trigger.
Enumerations
MISSING_FEATURE
A feature is being used that is not enabled on the current network.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
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