# CreativeWrapperService (v202505) Provides methods for the creation and management of creative wrappers. [CreativeWrappers](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper) allow HTML snippets to be served along with creatives. Creative wrappers must be associated with a [LabelType.CREATIVE_WRAPPER](https://developers.google.com/ad-manager/api/reference/v202505/LabelService.LabelType#CREATIVE_WRAPPER) label and applied to ad units by [AdUnit.appliedLabels](https://developers.google.com/ad-manager/api/reference/v202505/InventoryService.AdUnit#appliedLabels). *** ** * ** *** Production WSDL : ` https://ads.google.com/apis/ads/publisher/v202505/CreativeWrapperService?wsdl ` Namespace : `https://www.google.com/apis/ads/publisher/v202505` Operations : - [createCreativeWrappers](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#createCreativeWrappers) - [getCreativeWrappersByStatement](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#getCreativeWrappersByStatement) - [performCreativeWrapperAction](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#performCreativeWrapperAction) - [updateCreativeWrappers](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#updateCreativeWrappers) Errors : - [ApiVersionError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#ApiVersionError) - [AuthenticationError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#AuthenticationError) - [CollectionSizeError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#CollectionSizeError) - [CommonError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#CommonError) - [CreativeWrapperError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#CreativeWrapperError) - [FeatureError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#FeatureError) - [InternalApiError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#InternalApiError) - [LabelError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#LabelError) - [NotNullError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#NotNullError) - [NullError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#NullError) - [ParseError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#ParseError) - [PermissionError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#PermissionError) - [PublisherQueryLanguageContextError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#PublisherQueryLanguageContextError) - [PublisherQueryLanguageSyntaxError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#PublisherQueryLanguageSyntaxError) - [QuotaError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#QuotaError) - [RequiredCollectionError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#RequiredCollectionError) - [RequiredError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#RequiredError) - [ServerError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#ServerError) - [StatementError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#StatementError) - [StringFormatError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#StringFormatError) - [StringLengthError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#StringLengthError) - [TypeError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#TypeError) - [UniqueError](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService#UniqueError) ## createCreativeWrappers Creates a new `CreativeWrapper` objects. The following fields are required: - [CreativeWrapper.labelId](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper#labelId) - [CreativeWrapper.ordering](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper#ordering) - [CreativeWrapper.header](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper#header) or [CreativeWrapper.footer](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper#footer) ### Parameters | Field | Type | Description | |---|---|---| | `creativeWrappers` | `` ` https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper[]` `` | | ### Response | Field | Type | Description | |---|---|---| | `rval` | `` ` https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper[]` `` | | ## getCreativeWrappersByStatement Gets a [CreativeWrapperPage](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapperPage) of [CreativeWrapper](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper) objects that satisfy the given [Statement.query](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.Statement#query). The following fields are supported for filtering: | PQL Property | Object Property | |---|---| | `id` | [CreativeWrapper.id](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper#id) | | `labelId` | [CreativeWrapper.labelId](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper#labelId) | | `status` | [CreativeWrapper.status](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper#status) | | `ordering` | [CreativeWrapper.ordering](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper#ordering) |
### Parameters | Field | Type | Description | |---|---|---| | `filterStatement` | `` ` https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.Statement ` `` | | ### Response | Field | Type | Description | |---|---|---| | `rval` | `` ` https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapperPage ` `` | | ## performCreativeWrapperAction Performs actions on [CreativeWrapper](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper) objects that match the given [Statement.query](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.Statement#query). ### Parameters | Field | Type | Description | |---|---|---| | `creativeWrapperAction` | `` 1. ` https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapperAction ` 1. ` https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.ActivateCreativeWrappers ` 2. ` https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.DeactivateCreativeWrappers ` `` | | | `filterStatement` | `` ` https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.Statement ` `` | | ### Response | Field | Type | Description | |---|---|---| | `rval` | `` ` https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.UpdateResult ` `` | | ## updateCreativeWrappers Updates the specified `CreativeWrapper` objects. ### Parameters | Field | Type | Description | |---|---|---| | `creativeWrappers` | `` ` https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper[]` `` | | ### Response | Field | Type | Description | |---|---|---| | `rval` | `` ` https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper[]` `` | | ## Errors | Error | Reasons | |---|---| | [`ApiVersionError`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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` `NETWORK_API_ACCESS_DISABLED` : The network does not have API access enabled. `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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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. `UNSUPPORTED_OPERATION` : Indicates that the requested operation is not supported. `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. | | [`CreativeWrapperError`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapperError) | Errors specific to creative wrappers. *** ** * ** *** **Enumerations** `LABEL_ALREADY_ASSOCIATED_WITH_CREATIVE_WRAPPER` : The label is already associated with a [CreativeWrapper](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper). `INVALID_LABEL_TYPE` : The label type of a creative wrapper must be [LabelType.CREATIVE_WRAPPER](https://developers.google.com/ad-manager/api/reference/v202505/LabelService.LabelType#CREATIVE_WRAPPER). `UNRECOGNIZED_MACRO` : A macro used inside the snippet is not recognized. `NEITHER_HEADER_NOR_FOOTER_SPECIFIED` : When creating a new creative wrapper, either header or footer should exist. `NEITHER_HEADER_NOR_FOOTER_NOR_VIDEO_TRACKING_URLS_SPECIFIED` : Creative wrapper must have either header and/or footer, or video tracking URLs. `CANNOT_USE_CREATIVE_WRAPPER_TYPE` : The network has not been enabled for creating labels of type [LabelType.CREATIVE_WRAPPER](https://developers.google.com/ad-manager/api/reference/v202505/LabelService.LabelType#CREATIVE_WRAPPER). `CANNOT_UPDATE_LABEL_ID` : Cannot update [CreativeWrapper.labelId](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper#labelId). `CANNOT_APPLY_TO_AD_UNIT_WITH_VIDEO_SIZES` : Cannot apply [LabelType.CREATIVE_WRAPPER](https://developers.google.com/ad-manager/api/reference/v202505/LabelService.LabelType#CREATIVE_WRAPPER) labels to an ad unit if it has no descendants with [AdUnit.adUnitSizes](https://developers.google.com/ad-manager/api/reference/v202505/InventoryService.AdUnit#adUnitSizes) of `AdUnitSize#environmentType` as [EnvironmentType.BROWSER](https://developers.google.com/ad-manager/api/reference/v202505/ForecastService.EnvironmentType#BROWSER). `CANNOT_APPLY_TO_AD_UNIT_WITHOUT_VIDEO_SIZES` : Cannot apply [LabelType.CREATIVE_WRAPPER](https://developers.google.com/ad-manager/api/reference/v202505/LabelService.LabelType#CREATIVE_WRAPPER) labels with a [CreativeWrapper.VIDEO_TRACKING_URL](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.CreativeWrapper#VIDEO_TRACKING_URL) type to an ad unit if it has no descendants with [AdUnit.adUnitSizes](https://developers.google.com/ad-manager/api/reference/v202505/InventoryService.AdUnit#adUnitSizes) of `AdUnitSize#environmentType` as [EnvironmentType.VIDEO_PLAYER](https://developers.google.com/ad-manager/api/reference/v202505/ForecastService.EnvironmentType#VIDEO_PLAYER). `CANNOT_APPLY_TO_AD_UNIT_WITHOUT_LABEL_ASSOCIATION` : Cannot apply [LabelType.CREATIVE_WRAPPER](https://developers.google.com/ad-manager/api/reference/v202505/LabelService.LabelType#CREATIVE_WRAPPER) labels to an ad unit if the label is not associated with a creative wrapper. `CANNOT_APPLY_TO_MOBILE_AD_UNIT` : Cannot apply [LabelType.CREATIVE_WRAPPER](https://developers.google.com/ad-manager/api/reference/v202505/LabelService.LabelType#CREATIVE_WRAPPER) labels to an ad unit if [AdUnit.targetPlatform](https://developers.google.com/ad-manager/api/reference/v202505/InventoryService.AdUnit#targetPlatform) is of type `TargetPlatform#MOBILE` `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. | | [`FeatureError`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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. | | [`InternalApiError`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.InternalApiError) | Indicates that a server-side error has occured. `InternalApiError`s 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. | | [`LabelError`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.LabelError) | Errors specific to labels. *** ** * ** *** **Enumerations** `INVALID_PREFIX` : A user created label cannot begin with the Google internal system label prefix. `NAME_INVALID_CHARS` : [Label.name](https://developers.google.com/ad-manager/api/reference/v202505/LabelService.Label#name) contains unsupported or reserved characters. `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. | | [`NotNullError`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.NullError) | Errors associated with violation of a NOT NULL check. *** ** * ** *** **Enumerations** `NULL_CONTENT` : Specified list/container must not contain any null elements | | [`ParseError`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.PublisherQueryLanguageContextError) | An error that occurs while executing a PQL query contained in a [Statement](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.PublisherQueryLanguageSyntaxError) | An error that occurs while parsing a PQL query contained in a [Statement](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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](https://developers.google.com/ad-manager/api/reference/v202505/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. `SEGMENT_POPULATION_LIMIT` : This network has exceeded the allowed number of identifiers uploaded within a 24 hour period. The recommended approach to handle this error is to wait 30 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. | | [`RequiredCollectionError`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.RequiredError) | Errors due to missing required field. *** ** * ** *** **Enumerations** `REQUIRED` : Missing required field. | | [`ServerError`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.StatementError) | An error that occurs while parsing [Statement](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.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. | | [`TypeError`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.TypeError) | An error for a field which is an invalid type. | | [`UniqueError`](https://developers.google.com/ad-manager/api/reference/v202505/CreativeWrapperService.UniqueError) | An error for a field which must satisfy a uniqueness constraint |