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

CreativeService (v201902)

Provides methods for adding, updating and retrieving Creative objects.

For a creative to run, it must be associated with a LineItem managed by the LineItemCreativeAssociationService.

Read more about creatives on the DFP Help Center.


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

createCreatives

Creates new Creative objects.

Parameters

Field Type Description
creatives
  1. Creative[]
    1. BaseDynamicAllocationCreative
      1. AdMobBackfillCreative
      2. HasHtmlSnippetDynamicAlloca...
        1. AdExchangeCreative
        2. AdSenseCreative
    2. BaseRichMediaStudioCreative
      1. RichMediaStudioCreative
    3. ClickTrackingCreative
    4. HasDestinationUrlCreative
      1. AspectRatioImageCreative
      2. BaseFlashCreative
        1. FlashCreative
        2. FlashOverlayCreative
      3. BaseFlashRedirectCreative
        1. FlashRedirectCreative
        2. FlashRedirectOverlayCreative
      4. BaseImageCreative
        1. ImageCreative
        2. ImageOverlayCreative
      5. BaseImageRedirectCreative
        1. ImageRedirectCreative
        2. ImageRedirectOverlayCreative
      6. BaseVideoCreative
        1. SetTopBoxCreative
        2. VideoCreative
        3. VideoRedirectCreative
      7. CustomCreative
    5. Html5Creative
    6. InternalRedirectCreative
    7. LegacyDfpCreative
    8. ProgrammaticCreative
    9. TemplateCreative
    10. ThirdPartyCreative
    11. UnsupportedCreative
    12. VastRedirectCreative
the creatives to create

Response

Field Type Description
rval
  1. Creative[]
    1. BaseDynamicAllocationCreative
      1. AdMobBackfillCreative
      2. HasHtmlSnippetDynamicAlloca...
        1. AdExchangeCreative
        2. AdSenseCreative
    2. BaseRichMediaStudioCreative
      1. RichMediaStudioCreative
    3. ClickTrackingCreative
    4. HasDestinationUrlCreative
      1. AspectRatioImageCreative
      2. BaseFlashCreative
        1. FlashCreative
        2. FlashOverlayCreative
      3. BaseFlashRedirectCreative
        1. FlashRedirectCreative
        2. FlashRedirectOverlayCreative
      4. BaseImageCreative
        1. ImageCreative
        2. ImageOverlayCreative
      5. BaseImageRedirectCreative
        1. ImageRedirectCreative
        2. ImageRedirectOverlayCreative
      6. BaseVideoCreative
        1. SetTopBoxCreative
        2. VideoCreative
        3. VideoRedirectCreative
      7. CustomCreative
    5. Html5Creative
    6. InternalRedirectCreative
    7. LegacyDfpCreative
    8. ProgrammaticCreative
    9. TemplateCreative
    10. ThirdPartyCreative
    11. UnsupportedCreative
    12. VastRedirectCreative
the created creatives with their IDs filled in

getCreativesByStatement

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

PQL Property Object Property
id Creative.id
name Creative.name
advertiserId Creative.advertiserId
width Creative.size
height Creative.size
lastModifiedDateTime Creative.lastModifiedDateTime

Parameters

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

Response

Field Type Description
rval CreativePage the creatives that match the given filter

updateCreatives

Updates the specified Creative objects.

Parameters

Field Type Description
creatives
  1. Creative[]
    1. BaseDynamicAllocationCreative
      1. AdMobBackfillCreative
      2. HasHtmlSnippetDynamicAlloca...
        1. AdExchangeCreative
        2. AdSenseCreative
    2. BaseRichMediaStudioCreative
      1. RichMediaStudioCreative
    3. ClickTrackingCreative
    4. HasDestinationUrlCreative
      1. AspectRatioImageCreative
      2. BaseFlashCreative
        1. FlashCreative
        2. FlashOverlayCreative
      3. BaseFlashRedirectCreative
        1. FlashRedirectCreative
        2. FlashRedirectOverlayCreative
      4. BaseImageCreative
        1. ImageCreative
        2. ImageOverlayCreative
      5. BaseImageRedirectCreative
        1. ImageRedirectCreative
        2. ImageRedirectOverlayCreative
      6. BaseVideoCreative
        1. SetTopBoxCreative
        2. VideoCreative
        3. VideoRedirectCreative
      7. CustomCreative
    5. Html5Creative
    6. InternalRedirectCreative
    7. LegacyDfpCreative
    8. ProgrammaticCreative
    9. TemplateCreative
    10. ThirdPartyCreative
    11. UnsupportedCreative
    12. VastRedirectCreative
the creatives to update

Response

Field Type Description
rval
  1. Creative[]
    1. BaseDynamicAllocationCreative
      1. AdMobBackfillCreative
      2. HasHtmlSnippetDynamicAlloca...
        1. AdExchangeCreative
        2. AdSenseCreative
    2. BaseRichMediaStudioCreative
      1. RichMediaStudioCreative
    3. ClickTrackingCreative
    4. HasDestinationUrlCreative
      1. AspectRatioImageCreative
      2. BaseFlashCreative
        1. FlashCreative
        2. FlashOverlayCreative
      3. BaseFlashRedirectCreative
        1. FlashRedirectCreative
        2. FlashRedirectOverlayCreative
      4. BaseImageCreative
        1. ImageCreative
        2. ImageOverlayCreative
      5. BaseImageRedirectCreative
        1. ImageRedirectCreative
        2. ImageRedirectOverlayCreative
      6. BaseVideoCreative
        1. SetTopBoxCreative
        2. VideoCreative
        3. VideoRedirectCreative
      7. CustomCreative
    5. Html5Creative
    6. InternalRedirectCreative
    7. LegacyDfpCreative
    8. ProgrammaticCreative
    9. TemplateCreative
    10. ThirdPartyCreative
    11. UnsupportedCreative
    12. VastRedirectCreative
the updated creatives

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