Web Service: CreativeService

Port type CreativeServiceInterfaceSource code

1. createCreatives
   Source code
   Description:
   Creates new {@link Creative} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createCreativesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createCreatives

   Creates new {@link Creative} objects.

   • creatives - optional, unbounded; type Creative
     A {@code Creative} represents the media for the ad being served.

     Read more about creatives on the Ad Manager Help Center.

     • advertiserId - optional; type long
       The ID of the advertiser that owns the creative. This attribute is required.
     • id - optional; type long
       Uniquely identifies the {@code Creative}. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.
     • name - optional; type string
       The name of the creative. This attribute is required and has a maximum length of 255 characters.
     • size - optional; type Size
       The {@link Size} of the creative. This attribute is required for creation and then is read-only.
       Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

       For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

       • width - optional; type int
         The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • height - optional; type int
         The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • isAspectRatio - optional; type boolean
         Whether this size represents an aspect ratio.
     • previewUrl - optional; type string
       The URL of the creative for previewing the media. This attribute is read-only and is assigned by Google when a creative is created.
     • policyLabels - optional, unbounded; type CreativePolicyViolation - type string with restriction - enum { 'MALWARE_IN_CREATIVE', 'MALWARE_IN_LANDING_PAGE', 'LEGALLY_BLOCKED_REDIRECT_URL', 'MISREPRESENTATION_OF_PRODUCT', 'SELF_CLICKING_CREATIVE', 'GAMING_GOOGLE_NETWORK', 'DYNAMIC_DNS', 'CIRCUMVENTING_SYSTEMS', 'PHISHING', 'DOWNLOAD_PROMPT_IN_CREATIVE', 'UNAUTHORIZED_COOKIE_DETECTED', 'TEMPORARY_PAUSE_FOR_VENDOR_INVESTIGATION', 'ABUSIVE_EXPERIENCE', 'TRICK_TO_CLICK', 'USE_OF_NON_ALLOWLISTED_OMID_VERIFICATION_SCRIPT', 'MISUSE_OF_OMID_API', 'UNACCEPTABLE_HTML_AD', 'UNKNOWN' }
       Set of policy labels detected for this creative. This attribute is read-only.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied to this creative.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this creative was last modified.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • customFieldValues - optional, unbounded; type BaseCustomFieldValue
       The value of a {@link CustomField} for a particular entity.
       • customFieldId - optional; type long
         Id of the {@code CustomField} to which this value belongs. This attribute is required.
       The values of the custom fields associated with this creative.
     • thirdPartyDataDeclaration - optional; type ThirdPartyDataDeclaration
       The third party companies associated with this creative.

       This is distinct from any associated companies that Google may detect programmatically.

       Represents a set of declarations about what (if any) third party companies are associated with a given creative.

       This can be set at the network level, as a default for all creatives, or overridden for a particular creative.

       • declarationType - optional; type DeclarationType - type string with restriction - enum { 'NONE', 'DECLARED', 'UNKNOWN' }
       • thirdPartyCompanyIds - optional, unbounded; type long
     • adBadgingEnabled - optional; type boolean
       Whether the creative has ad badging enabled.

       Defaults to false for {@code CreativeType.VAST_REDIRECT}, {@code CreativeType.THIRD_PARTY}, {@code CreativeType.AUDIO_VAST_REDIRECT}, {@code CreativeType.PROGRAMMATIC}, {@code CreativeType.DFP_MOBILE_CREATIVE}, {@code CreativeType.FLASH_OVERLAY}, {@code CreativeType.GRAPHICAL_INTERSTITIAL}, {@code CreativeType.LEGACY_DFP_CREATIVE}, {@code CreativeType.MOBILE_AD_NETWORK_BACKFILL}, {@code CreativeType.MOBILE_VIDEO_INTERSTITIAL}, {@code CreativeType.SDK_MEDIATION} and {@code CreativeType.STANDARD_FLASH} creative types.

       . Defaults to true for all other creative types.

   Output:
   createCreativesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createCreativesResponse

   • rval - optional, unbounded; type Creative
     A {@code Creative} represents the media for the ad being served.

     Read more about creatives on the Ad Manager Help Center.

     • advertiserId - optional; type long
       The ID of the advertiser that owns the creative. This attribute is required.
     • id - optional; type long
       Uniquely identifies the {@code Creative}. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.
     • name - optional; type string
       The name of the creative. This attribute is required and has a maximum length of 255 characters.
     • size - optional; type Size
       The {@link Size} of the creative. This attribute is required for creation and then is read-only.
       Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

       For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

       • width - optional; type int
         The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • height - optional; type int
         The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • isAspectRatio - optional; type boolean
         Whether this size represents an aspect ratio.
     • previewUrl - optional; type string
       The URL of the creative for previewing the media. This attribute is read-only and is assigned by Google when a creative is created.
     • policyLabels - optional, unbounded; type CreativePolicyViolation - type string with restriction - enum { 'MALWARE_IN_CREATIVE', 'MALWARE_IN_LANDING_PAGE', 'LEGALLY_BLOCKED_REDIRECT_URL', 'MISREPRESENTATION_OF_PRODUCT', 'SELF_CLICKING_CREATIVE', 'GAMING_GOOGLE_NETWORK', 'DYNAMIC_DNS', 'CIRCUMVENTING_SYSTEMS', 'PHISHING', 'DOWNLOAD_PROMPT_IN_CREATIVE', 'UNAUTHORIZED_COOKIE_DETECTED', 'TEMPORARY_PAUSE_FOR_VENDOR_INVESTIGATION', 'ABUSIVE_EXPERIENCE', 'TRICK_TO_CLICK', 'USE_OF_NON_ALLOWLISTED_OMID_VERIFICATION_SCRIPT', 'MISUSE_OF_OMID_API', 'UNACCEPTABLE_HTML_AD', 'UNKNOWN' }
       Set of policy labels detected for this creative. This attribute is read-only.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied to this creative.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this creative was last modified.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • customFieldValues - optional, unbounded; type BaseCustomFieldValue
       The value of a {@link CustomField} for a particular entity.
       • customFieldId - optional; type long
         Id of the {@code CustomField} to which this value belongs. This attribute is required.
       The values of the custom fields associated with this creative.
     • thirdPartyDataDeclaration - optional; type ThirdPartyDataDeclaration
       The third party companies associated with this creative.

       This is distinct from any associated companies that Google may detect programmatically.

       Represents a set of declarations about what (if any) third party companies are associated with a given creative.

       This can be set at the network level, as a default for all creatives, or overridden for a particular creative.

       • declarationType - optional; type DeclarationType - type string with restriction - enum { 'NONE', 'DECLARED', 'UNKNOWN' }
       • thirdPartyCompanyIds - optional, unbounded; type long
     • adBadgingEnabled - optional; type boolean
       Whether the creative has ad badging enabled.

       Defaults to false for {@code CreativeType.VAST_REDIRECT}, {@code CreativeType.THIRD_PARTY}, {@code CreativeType.AUDIO_VAST_REDIRECT}, {@code CreativeType.PROGRAMMATIC}, {@code CreativeType.DFP_MOBILE_CREATIVE}, {@code CreativeType.FLASH_OVERLAY}, {@code CreativeType.GRAPHICAL_INTERSTITIAL}, {@code CreativeType.LEGACY_DFP_CREATIVE}, {@code CreativeType.MOBILE_AD_NETWORK_BACKFILL}, {@code CreativeType.MOBILE_VIDEO_INTERSTITIAL}, {@code CreativeType.SDK_MEDIATION} and {@code CreativeType.STANDARD_FLASH} creative types.

       . Defaults to true for all other creative types.

   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
2. getCreativesByStatement
   Source code
   Description:
   Gets a {@link CreativePage} of {@link Creative} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link Creative#id}
   {@code name}	{@link Creative#name}
   {@code advertiserId}	{@link Creative#advertiserId}
   {@code width}	{@link Creative#size}
   {@code height}	{@link Creative#size}
   {@code lastModifiedDateTime}	{@link Creative#lastModifiedDateTime}

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getCreativesByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getCreativesByStatement

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

   PQL Property	Object Property
   {@code id}	{@link Creative#id}
   {@code name}	{@link Creative#name}
   {@code advertiserId}	{@link Creative#advertiserId}
   {@code width}	{@link Creative#size}
   {@code height}	{@link Creative#size}
   {@code lastModifiedDateTime}	{@link Creative#lastModifiedDateTime}

   • filterStatement - optional; type Statement
     Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

     An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

     Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

     An example of such a query might be {@code "WHERE id = :idValue"}.

     Statements also support use of the LIKE keyword. This provides wildcard string matching.

     An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

     The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
     • query - optional; type string
       Holds the query in PQL syntax. The syntax is:
       [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
       

       
            := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
       

     • values - optional, unbounded; type String_ValueMapEntry
       Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

       In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

       This represents an entry in a map with a key of type String and value of type Value.
       • key - optional; type string
       • value - optional; type Value
         {@code Value} represents a value.
   Output:
   getCreativesByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getCreativesByStatementResponse

   • rval - optional; type CreativePage
     Captures a page of {@link Creative} objects.
     • totalResultSetSize - optional; type int
       The size of the total result set to which this page belongs.
     • startIndex - optional; type int
       The absolute index in the total result set on which this page begins.
     • results - optional, unbounded; type Creative
       A {@code Creative} represents the media for the ad being served.

       Read more about creatives on the Ad Manager Help Center.

       • advertiserId - optional; type long
         The ID of the advertiser that owns the creative. This attribute is required.
       • id - optional; type long
         Uniquely identifies the {@code Creative}. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.
       • name - optional; type string
         The name of the creative. This attribute is required and has a maximum length of 255 characters.
       • size - optional; type Size
         The {@link Size} of the creative. This attribute is required for creation and then is read-only.
         Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

         For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

         • width - optional; type int
           The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • height - optional; type int
           The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • isAspectRatio - optional; type boolean
           Whether this size represents an aspect ratio.
       • previewUrl - optional; type string
         The URL of the creative for previewing the media. This attribute is read-only and is assigned by Google when a creative is created.
       • policyLabels - optional, unbounded; type CreativePolicyViolation - type string with restriction - enum { 'MALWARE_IN_CREATIVE', 'MALWARE_IN_LANDING_PAGE', 'LEGALLY_BLOCKED_REDIRECT_URL', 'MISREPRESENTATION_OF_PRODUCT', 'SELF_CLICKING_CREATIVE', 'GAMING_GOOGLE_NETWORK', 'DYNAMIC_DNS', 'CIRCUMVENTING_SYSTEMS', 'PHISHING', 'DOWNLOAD_PROMPT_IN_CREATIVE', 'UNAUTHORIZED_COOKIE_DETECTED', 'TEMPORARY_PAUSE_FOR_VENDOR_INVESTIGATION', 'ABUSIVE_EXPERIENCE', 'TRICK_TO_CLICK', 'USE_OF_NON_ALLOWLISTED_OMID_VERIFICATION_SCRIPT', 'MISUSE_OF_OMID_API', 'UNACCEPTABLE_HTML_AD', 'UNKNOWN' }
         Set of policy labels detected for this creative. This attribute is read-only.
       • appliedLabels - optional, unbounded; type AppliedLabel
         Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
         • labelId - optional; type long
           The ID of a created {@link Label}.
         • isNegated - optional; type boolean
           {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
         The set of labels applied to this creative.
       • lastModifiedDateTime - optional; type DateTime
         The date and time this creative was last modified.
         Represents a date combined with the time of day.
         • date - optional; type Date
           Represents a date.
           • year - optional; type int
             Year (e.g., 2009)
           • month - optional; type int
             Month (1..12)
           • day - optional; type int
             Day (1..31)
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
       • customFieldValues - optional, unbounded; type BaseCustomFieldValue
         The value of a {@link CustomField} for a particular entity.
         • customFieldId - optional; type long
           Id of the {@code CustomField} to which this value belongs. This attribute is required.
         The values of the custom fields associated with this creative.
       • thirdPartyDataDeclaration - optional; type ThirdPartyDataDeclaration
         The third party companies associated with this creative.

         This is distinct from any associated companies that Google may detect programmatically.

         Represents a set of declarations about what (if any) third party companies are associated with a given creative.

         This can be set at the network level, as a default for all creatives, or overridden for a particular creative.

         • declarationType - optional; type DeclarationType - type string with restriction - enum { 'NONE', 'DECLARED', 'UNKNOWN' }
         • thirdPartyCompanyIds - optional, unbounded; type long
       • adBadgingEnabled - optional; type boolean
         Whether the creative has ad badging enabled.

         Defaults to false for {@code CreativeType.VAST_REDIRECT}, {@code CreativeType.THIRD_PARTY}, {@code CreativeType.AUDIO_VAST_REDIRECT}, {@code CreativeType.PROGRAMMATIC}, {@code CreativeType.DFP_MOBILE_CREATIVE}, {@code CreativeType.FLASH_OVERLAY}, {@code CreativeType.GRAPHICAL_INTERSTITIAL}, {@code CreativeType.LEGACY_DFP_CREATIVE}, {@code CreativeType.MOBILE_AD_NETWORK_BACKFILL}, {@code CreativeType.MOBILE_VIDEO_INTERSTITIAL}, {@code CreativeType.SDK_MEDIATION} and {@code CreativeType.STANDARD_FLASH} creative types.

         . Defaults to true for all other creative types.

       The collection of creatives contained within this page.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
3. performCreativeAction
   Source code
   Description:
   Performs action on {@link Creative} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performCreativeActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performCreativeAction

   Performs action on {@link Creative} objects that match the given {@link Statement#query}.

   • creativeAction - optional; type CreativeAction
     Represents the actions that can be performed on {@link Creative} objects.
     • filterStatement - optional; type Statement
       Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

       An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

       Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

       An example of such a query might be {@code "WHERE id = :idValue"}.

       Statements also support use of the LIKE keyword. This provides wildcard string matching.

       An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

       The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
       • query - optional; type string
         Holds the query in PQL syntax. The syntax is:
         [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
         

         
              := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
         

       • values - optional, unbounded; type String_ValueMapEntry
         Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

         In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

         This represents an entry in a map with a key of type String and value of type Value.
         • key - optional; type string
         • value - optional; type Value
           {@code Value} represents a value.
   Output:
   performCreativeActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type performCreativeActionResponse

   • rval - optional; type UpdateResult
     Represents the result of performing an action on objects.
     • numChanges - optional; type int
       The number of objects that were changed as a result of performing the action.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
4. updateCreatives
   Source code
   Description:
   Updates the specified {@link Creative} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateCreativesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateCreatives

   Updates the specified {@link Creative} objects.

   • creatives - optional, unbounded; type Creative
     A {@code Creative} represents the media for the ad being served.

     Read more about creatives on the Ad Manager Help Center.

     • advertiserId - optional; type long
       The ID of the advertiser that owns the creative. This attribute is required.
     • id - optional; type long
       Uniquely identifies the {@code Creative}. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.
     • name - optional; type string
       The name of the creative. This attribute is required and has a maximum length of 255 characters.
     • size - optional; type Size
       The {@link Size} of the creative. This attribute is required for creation and then is read-only.
       Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

       For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

       • width - optional; type int
         The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • height - optional; type int
         The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • isAspectRatio - optional; type boolean
         Whether this size represents an aspect ratio.
     • previewUrl - optional; type string
       The URL of the creative for previewing the media. This attribute is read-only and is assigned by Google when a creative is created.
     • policyLabels - optional, unbounded; type CreativePolicyViolation - type string with restriction - enum { 'MALWARE_IN_CREATIVE', 'MALWARE_IN_LANDING_PAGE', 'LEGALLY_BLOCKED_REDIRECT_URL', 'MISREPRESENTATION_OF_PRODUCT', 'SELF_CLICKING_CREATIVE', 'GAMING_GOOGLE_NETWORK', 'DYNAMIC_DNS', 'CIRCUMVENTING_SYSTEMS', 'PHISHING', 'DOWNLOAD_PROMPT_IN_CREATIVE', 'UNAUTHORIZED_COOKIE_DETECTED', 'TEMPORARY_PAUSE_FOR_VENDOR_INVESTIGATION', 'ABUSIVE_EXPERIENCE', 'TRICK_TO_CLICK', 'USE_OF_NON_ALLOWLISTED_OMID_VERIFICATION_SCRIPT', 'MISUSE_OF_OMID_API', 'UNACCEPTABLE_HTML_AD', 'UNKNOWN' }
       Set of policy labels detected for this creative. This attribute is read-only.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied to this creative.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this creative was last modified.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • customFieldValues - optional, unbounded; type BaseCustomFieldValue
       The value of a {@link CustomField} for a particular entity.
       • customFieldId - optional; type long
         Id of the {@code CustomField} to which this value belongs. This attribute is required.
       The values of the custom fields associated with this creative.
     • thirdPartyDataDeclaration - optional; type ThirdPartyDataDeclaration
       The third party companies associated with this creative.

       This is distinct from any associated companies that Google may detect programmatically.

       Represents a set of declarations about what (if any) third party companies are associated with a given creative.

       This can be set at the network level, as a default for all creatives, or overridden for a particular creative.

       • declarationType - optional; type DeclarationType - type string with restriction - enum { 'NONE', 'DECLARED', 'UNKNOWN' }
       • thirdPartyCompanyIds - optional, unbounded; type long
     • adBadgingEnabled - optional; type boolean
       Whether the creative has ad badging enabled.

       Defaults to false for {@code CreativeType.VAST_REDIRECT}, {@code CreativeType.THIRD_PARTY}, {@code CreativeType.AUDIO_VAST_REDIRECT}, {@code CreativeType.PROGRAMMATIC}, {@code CreativeType.DFP_MOBILE_CREATIVE}, {@code CreativeType.FLASH_OVERLAY}, {@code CreativeType.GRAPHICAL_INTERSTITIAL}, {@code CreativeType.LEGACY_DFP_CREATIVE}, {@code CreativeType.MOBILE_AD_NETWORK_BACKFILL}, {@code CreativeType.MOBILE_VIDEO_INTERSTITIAL}, {@code CreativeType.SDK_MEDIATION} and {@code CreativeType.STANDARD_FLASH} creative types.

       . Defaults to true for all other creative types.

   Output:
   updateCreativesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateCreativesResponse

   • rval - optional, unbounded; type Creative
     A {@code Creative} represents the media for the ad being served.

     Read more about creatives on the Ad Manager Help Center.

     • advertiserId - optional; type long
       The ID of the advertiser that owns the creative. This attribute is required.
     • id - optional; type long
       Uniquely identifies the {@code Creative}. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.
     • name - optional; type string
       The name of the creative. This attribute is required and has a maximum length of 255 characters.
     • size - optional; type Size
       The {@link Size} of the creative. This attribute is required for creation and then is read-only.
       Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

       For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

       • width - optional; type int
         The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • height - optional; type int
         The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • isAspectRatio - optional; type boolean
         Whether this size represents an aspect ratio.
     • previewUrl - optional; type string
       The URL of the creative for previewing the media. This attribute is read-only and is assigned by Google when a creative is created.
     • policyLabels - optional, unbounded; type CreativePolicyViolation - type string with restriction - enum { 'MALWARE_IN_CREATIVE', 'MALWARE_IN_LANDING_PAGE', 'LEGALLY_BLOCKED_REDIRECT_URL', 'MISREPRESENTATION_OF_PRODUCT', 'SELF_CLICKING_CREATIVE', 'GAMING_GOOGLE_NETWORK', 'DYNAMIC_DNS', 'CIRCUMVENTING_SYSTEMS', 'PHISHING', 'DOWNLOAD_PROMPT_IN_CREATIVE', 'UNAUTHORIZED_COOKIE_DETECTED', 'TEMPORARY_PAUSE_FOR_VENDOR_INVESTIGATION', 'ABUSIVE_EXPERIENCE', 'TRICK_TO_CLICK', 'USE_OF_NON_ALLOWLISTED_OMID_VERIFICATION_SCRIPT', 'MISUSE_OF_OMID_API', 'UNACCEPTABLE_HTML_AD', 'UNKNOWN' }
       Set of policy labels detected for this creative. This attribute is read-only.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied to this creative.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this creative was last modified.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • customFieldValues - optional, unbounded; type BaseCustomFieldValue
       The value of a {@link CustomField} for a particular entity.
       • customFieldId - optional; type long
         Id of the {@code CustomField} to which this value belongs. This attribute is required.
       The values of the custom fields associated with this creative.
     • thirdPartyDataDeclaration - optional; type ThirdPartyDataDeclaration
       The third party companies associated with this creative.

       This is distinct from any associated companies that Google may detect programmatically.

       Represents a set of declarations about what (if any) third party companies are associated with a given creative.

       This can be set at the network level, as a default for all creatives, or overridden for a particular creative.

       • declarationType - optional; type DeclarationType - type string with restriction - enum { 'NONE', 'DECLARED', 'UNKNOWN' }
       • thirdPartyCompanyIds - optional, unbounded; type long
     • adBadgingEnabled - optional; type boolean
       Whether the creative has ad badging enabled.

       Defaults to false for {@code CreativeType.VAST_REDIRECT}, {@code CreativeType.THIRD_PARTY}, {@code CreativeType.AUDIO_VAST_REDIRECT}, {@code CreativeType.PROGRAMMATIC}, {@code CreativeType.DFP_MOBILE_CREATIVE}, {@code CreativeType.FLASH_OVERLAY}, {@code CreativeType.GRAPHICAL_INTERSTITIAL}, {@code CreativeType.LEGACY_DFP_CREATIVE}, {@code CreativeType.MOBILE_AD_NETWORK_BACKFILL}, {@code CreativeType.MOBILE_VIDEO_INTERSTITIAL}, {@code CreativeType.SDK_MEDIATION} and {@code CreativeType.STANDARD_FLASH} creative types.

       . Defaults to true for all other creative types.

   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.