Provides methods for the creation and management of creative wrappers. CreativeWrappers allow HTML snippets to be served along with creatives.
Creative wrappers must be associated with a LabelType.CREATIVE_WRAPPER label and applied to ad units by AdUnit.appliedLabels .
- Production WSDL
-
https://ads.google.com/apis/ads/publisher/v202405/CreativeWrapperService?wsdl
- Namespace
-
https://www.google.com/apis/ads/publisher/v202405
- Operations
- Errors
-
- ApiVersionError
- AuthenticationError
- CollectionSizeError
- CommonError
- CreativeWrapperError
- FeatureError
- InternalApiError
- LabelError
- NotNullError
- NullError
- ParseError
- PermissionError
- PublisherQueryLanguageContextError
- PublisherQueryLanguageSyntaxError
- QuotaError
- RequiredCollectionError
- RequiredError
- ServerError
- StatementError
- StringFormatError
- StringLengthError
- TypeError
- UniqueError
createCreativeWrappers
Creates a new CreativeWrapper
objects.
The following fields are required:
Parameters
Field | Type | Description |
---|---|---|
creativeWrappers
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
getCreativeWrappersByStatement
Gets a CreativeWrapperPage of CreativeWrapper objects that satisfy the given Statement.query . The following fields are supported for filtering:
PQL Property | Object Property |
---|---|
id
|
CreativeWrapper.id |
labelId
|
CreativeWrapper.labelId |
status
|
CreativeWrapper.status |
ordering
|
CreativeWrapper.ordering |
Parameters
Field | Type | Description |
---|---|---|
filterStatement
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
performCreativeWrapperAction
Performs actions on CreativeWrapper objects that match the given Statement.query .
Parameters
creativeWrapperAction
filterStatement
Response
Field | Type | Description |
---|---|---|
rval
|
|
updateCreativeWrappers
Updates the specified CreativeWrapper
objects.
Parameters
Field | Type | Description |
---|---|---|
creativeWrappers
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
Errors
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.
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
andoAuthToken
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 optionalnetworkCode
. -
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.
Enumerations
-
TOO_LARGE
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
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.
Enumerations
-
LABEL_ALREADY_ASSOCIATED_WITH_CREATIVE_WRAPPER
- The label is already associated with a CreativeWrapper .
-
INVALID_LABEL_TYPE
- The label type of a creative wrapper must be 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 .
-
CANNOT_UPDATE_LABEL_ID
- Cannot update CreativeWrapper.labelId .
-
CANNOT_APPLY_TO_AD_UNIT_WITH_VIDEO_SIZES
- Cannot apply LabelType.CREATIVE_WRAPPER
labels to an ad unit
if it has no descendants with AdUnit.adUnitSizes
of
AdUnitSize#environmentType
as EnvironmentType.BROWSER . -
CANNOT_APPLY_TO_AD_UNIT_WITHOUT_VIDEO_SIZES
- Cannot apply LabelType.CREATIVE_WRAPPER
labels with a CreativeWrapper.VIDEO_TRACKING_URL
type to an ad unit if it has no descendants with AdUnit.adUnitSizes
of
AdUnitSize#environmentType
as EnvironmentType.VIDEO_PLAYER . -
CANNOT_APPLY_TO_AD_UNIT_WITHOUT_LABEL_ASSOCIATION
- Cannot apply 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
labels to an ad unit
if AdUnit.targetPlatform
is of type
TargetPlatform#MOBILE
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
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
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.
Enumerations
-
INVALID_PREFIX
- A user created label cannot begin with the Google internal system label prefix.
-
NAME_INVALID_CHARS
- Label.name contains unsupported or reserved characters.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
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.
Enumerations
-
NULL_CONTENT
- Specified list/container must not contain any null elements
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.
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.
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.
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.
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.
-
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.
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.
Enumerations
-
REQUIRED
- Missing required field.
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.
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.
Enumerations
-
UNKNOWN
-
ILLEGAL_CHARS
- The input string value contains disallowed characters.
-
INVALID_FORMAT
- The input string value is invalid for the associated field.
Enumerations
-
TOO_LONG
-
TOO_SHORT
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.