Web Service: CreativeWrapperService

Port type CreativeWrapperServiceInterfaceSource code

1. createCreativeWrappers
   Source code
   Description:
   Creates a new {@code CreativeWrapper} objects.

   The following fields are required:

   • {@link CreativeWrapper#labelId}
   • {@link CreativeWrapper#ordering}
   • {@link CreativeWrapper#header} or {@link CreativeWrapper#footer}
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createCreativeWrappersRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createCreativeWrappers

   Creates a new {@code CreativeWrapper} objects.

   The following fields are required:

   • {@link CreativeWrapper#labelId}
   • {@link CreativeWrapper#ordering}
   • {@link CreativeWrapper#header} or {@link CreativeWrapper#footer}

   • creativeWrappers - optional, unbounded; type CreativeWrapper
     A {@code CreativeWrapper} allows the wrapping of HTML snippets to be served along with {@code Creative} objects.

     Creative wrappers must be associated with a {@link LabelType#CREATIVE_WRAPPER} label and applied to ad units by {@link AdUnit#appliedLabels}.

     • id - optional; type long
       The unique ID of the {@code CreativeWrapper}. This value is readonly and is assigned by Google.
     • labelId - optional; type long
       The ID of the {@link Label} which will be used to label ad units. The {@code labelId} on a creative wrapper cannot be changed once it is created.
     • creativeWrapperType - optional; type CreativeWrapperType - type string with restriction - enum { 'HTML', 'VIDEO_TRACKING_URL', 'UNKNOWN' }
       The creative wrapper type. If the creative wrapper type is {@link CreativeWrapperType#VIDEO_TRACKING_URL}, the {@code videoTrackingUrls} field must be set. If the creative wrapper type is {@link CreativeWrapperType#HTML}, either the {@code header} or {@code footer} field must be set. This field is required.
     • htmlHeader - optional; type string
       The header HTML snippet that this creative wrapper delivers.
     • htmlFooter - optional; type string
       The footer HTML snippet that this creative wrapper delivers.
     • ampHead - optional; type string
       The header AMP snippet that this creative wrapper delivers.
     • ampBody - optional; type string
       The footer AMP snippet that this creative wrapper delivers.
     • videoTrackingUrls - optional, unbounded; type ConversionEvent_TrackingUrlsMapEntry
       This represents an entry in a map with a key of type ConversionEvent and value of type TrackingUrls.
       • key - optional; type ConversionEvent - type string with restriction - enum { 'UNKNOWN', 'CREATIVE_VIEW', 'START', 'SKIP_SHOWN', 'FIRST_QUARTILE', 'MIDPOINT', 'THIRD_QUARTILE', 'ENGAGED_VIEW', 'COMPLETE', 'MUTE', 'UNMUTE', 'PAUSE', 'REWIND', 'RESUME', 'SKIPPED', 'FULLSCREEN', 'EXPAND', 'COLLAPSE', 'ACCEPT_INVITATION', 'CLOSE', 'CLICK_TRACKING', 'SURVEY', 'CUSTOM_CLICK', 'MEASURABLE_IMPRESSION', 'VIEWABLE_IMPRESSION', 'VIDEO_ABANDON', 'FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION' }
       • value - optional; type TrackingUrls
         A list of URLs that should be pinged for a conversion event.
         • urls - optional, unbounded; type string
           A list of all URLs that should be pinged.
       The video tracking URLs that this creative wrapper delivers. This field is required if the {@code creativeWrapperType} is {@link CreativeWrapperType#VIDEO_TRACKING_URL} and ignored otherwise.
     • thirdPartyDataDeclaration - optional; type ThirdPartyDataDeclaration
       The {@code ThirdPartyDataDeclaration} for this creative wrapper.

       It is copied to one of the underlying creatives. If the header creative is active then it is persisted there. Otherwise it is stored on the footer creative.

       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
     • ordering - optional; type CreativeWrapperOrdering - type string with restriction - enum { 'NO_PREFERENCE', 'INNER', 'OUTER' }
       If there are multiple wrappers for a creative, then {@code ordering} defines the order in which the HTML snippets are rendered.
     • status - optional; type CreativeWrapperStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE' }
       The status of the {@code CreativeWrapper}. This attribute is readonly.
   Output:
   createCreativeWrappersResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createCreativeWrappersResponse

   • rval - optional, unbounded; type CreativeWrapper
     A {@code CreativeWrapper} allows the wrapping of HTML snippets to be served along with {@code Creative} objects.

     Creative wrappers must be associated with a {@link LabelType#CREATIVE_WRAPPER} label and applied to ad units by {@link AdUnit#appliedLabels}.

     • id - optional; type long
       The unique ID of the {@code CreativeWrapper}. This value is readonly and is assigned by Google.
     • labelId - optional; type long
       The ID of the {@link Label} which will be used to label ad units. The {@code labelId} on a creative wrapper cannot be changed once it is created.
     • creativeWrapperType - optional; type CreativeWrapperType - type string with restriction - enum { 'HTML', 'VIDEO_TRACKING_URL', 'UNKNOWN' }
       The creative wrapper type. If the creative wrapper type is {@link CreativeWrapperType#VIDEO_TRACKING_URL}, the {@code videoTrackingUrls} field must be set. If the creative wrapper type is {@link CreativeWrapperType#HTML}, either the {@code header} or {@code footer} field must be set. This field is required.
     • htmlHeader - optional; type string
       The header HTML snippet that this creative wrapper delivers.
     • htmlFooter - optional; type string
       The footer HTML snippet that this creative wrapper delivers.
     • ampHead - optional; type string
       The header AMP snippet that this creative wrapper delivers.
     • ampBody - optional; type string
       The footer AMP snippet that this creative wrapper delivers.
     • videoTrackingUrls - optional, unbounded; type ConversionEvent_TrackingUrlsMapEntry
       This represents an entry in a map with a key of type ConversionEvent and value of type TrackingUrls.
       • key - optional; type ConversionEvent - type string with restriction - enum { 'UNKNOWN', 'CREATIVE_VIEW', 'START', 'SKIP_SHOWN', 'FIRST_QUARTILE', 'MIDPOINT', 'THIRD_QUARTILE', 'ENGAGED_VIEW', 'COMPLETE', 'MUTE', 'UNMUTE', 'PAUSE', 'REWIND', 'RESUME', 'SKIPPED', 'FULLSCREEN', 'EXPAND', 'COLLAPSE', 'ACCEPT_INVITATION', 'CLOSE', 'CLICK_TRACKING', 'SURVEY', 'CUSTOM_CLICK', 'MEASURABLE_IMPRESSION', 'VIEWABLE_IMPRESSION', 'VIDEO_ABANDON', 'FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION' }
       • value - optional; type TrackingUrls
         A list of URLs that should be pinged for a conversion event.
         • urls - optional, unbounded; type string
           A list of all URLs that should be pinged.
       The video tracking URLs that this creative wrapper delivers. This field is required if the {@code creativeWrapperType} is {@link CreativeWrapperType#VIDEO_TRACKING_URL} and ignored otherwise.
     • thirdPartyDataDeclaration - optional; type ThirdPartyDataDeclaration
       The {@code ThirdPartyDataDeclaration} for this creative wrapper.

       It is copied to one of the underlying creatives. If the header creative is active then it is persisted there. Otherwise it is stored on the footer creative.

       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
     • ordering - optional; type CreativeWrapperOrdering - type string with restriction - enum { 'NO_PREFERENCE', 'INNER', 'OUTER' }
       If there are multiple wrappers for a creative, then {@code ordering} defines the order in which the HTML snippets are rendered.
     • status - optional; type CreativeWrapperStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE' }
       The status of the {@code CreativeWrapper}. This attribute is readonly.
   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. getCreativeWrappersByStatement
   Source code
   Description:
   Gets a {@link CreativeWrapperPage} of {@link CreativeWrapper} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CreativeWrapper#id}
   {@code labelId}	{@link CreativeWrapper#labelId}
   {@code status}	{@link CreativeWrapper#status}
   {@code ordering}	{@link CreativeWrapper#ordering}

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

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

   PQL Property	Object Property
   {@code id}	{@link CreativeWrapper#id}
   {@code labelId}	{@link CreativeWrapper#labelId}
   {@code status}	{@link CreativeWrapper#status}
   {@code ordering}	{@link CreativeWrapper#ordering}

   • 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:
   getCreativeWrappersByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getCreativeWrappersByStatementResponse

   • rval - optional; type CreativeWrapperPage
     Captures a page of {@link CreativeWrapper} 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 CreativeWrapper
       A {@code CreativeWrapper} allows the wrapping of HTML snippets to be served along with {@code Creative} objects.

       Creative wrappers must be associated with a {@link LabelType#CREATIVE_WRAPPER} label and applied to ad units by {@link AdUnit#appliedLabels}.

       • id - optional; type long
         The unique ID of the {@code CreativeWrapper}. This value is readonly and is assigned by Google.
       • labelId - optional; type long
         The ID of the {@link Label} which will be used to label ad units. The {@code labelId} on a creative wrapper cannot be changed once it is created.
       • creativeWrapperType - optional; type CreativeWrapperType - type string with restriction - enum { 'HTML', 'VIDEO_TRACKING_URL', 'UNKNOWN' }
         The creative wrapper type. If the creative wrapper type is {@link CreativeWrapperType#VIDEO_TRACKING_URL}, the {@code videoTrackingUrls} field must be set. If the creative wrapper type is {@link CreativeWrapperType#HTML}, either the {@code header} or {@code footer} field must be set. This field is required.
       • htmlHeader - optional; type string
         The header HTML snippet that this creative wrapper delivers.
       • htmlFooter - optional; type string
         The footer HTML snippet that this creative wrapper delivers.
       • ampHead - optional; type string
         The header AMP snippet that this creative wrapper delivers.
       • ampBody - optional; type string
         The footer AMP snippet that this creative wrapper delivers.
       • videoTrackingUrls - optional, unbounded; type ConversionEvent_TrackingUrlsMapEntry
         This represents an entry in a map with a key of type ConversionEvent and value of type TrackingUrls.
         • key - optional; type ConversionEvent - type string with restriction - enum { 'UNKNOWN', 'CREATIVE_VIEW', 'START', 'SKIP_SHOWN', 'FIRST_QUARTILE', 'MIDPOINT', 'THIRD_QUARTILE', 'ENGAGED_VIEW', 'COMPLETE', 'MUTE', 'UNMUTE', 'PAUSE', 'REWIND', 'RESUME', 'SKIPPED', 'FULLSCREEN', 'EXPAND', 'COLLAPSE', 'ACCEPT_INVITATION', 'CLOSE', 'CLICK_TRACKING', 'SURVEY', 'CUSTOM_CLICK', 'MEASURABLE_IMPRESSION', 'VIEWABLE_IMPRESSION', 'VIDEO_ABANDON', 'FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION' }
         • value - optional; type TrackingUrls
           A list of URLs that should be pinged for a conversion event.
           • urls - optional, unbounded; type string
             A list of all URLs that should be pinged.
         The video tracking URLs that this creative wrapper delivers. This field is required if the {@code creativeWrapperType} is {@link CreativeWrapperType#VIDEO_TRACKING_URL} and ignored otherwise.
       • thirdPartyDataDeclaration - optional; type ThirdPartyDataDeclaration
         The {@code ThirdPartyDataDeclaration} for this creative wrapper.

         It is copied to one of the underlying creatives. If the header creative is active then it is persisted there. Otherwise it is stored on the footer creative.

         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
       • ordering - optional; type CreativeWrapperOrdering - type string with restriction - enum { 'NO_PREFERENCE', 'INNER', 'OUTER' }
         If there are multiple wrappers for a creative, then {@code ordering} defines the order in which the HTML snippets are rendered.
       • status - optional; type CreativeWrapperStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE' }
         The status of the {@code CreativeWrapper}. This attribute is readonly.
       The collection of creative wrappers 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. performCreativeWrapperAction
   Source code
   Description:
   Performs actions on {@link CreativeWrapper} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performCreativeWrapperActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performCreativeWrapperAction

   Performs actions on {@link CreativeWrapper} objects that match the given {@link Statement#query}.

   • creativeWrapperAction - optional; type CreativeWrapperAction
     Represents the actions that can be performed on {@link CreativeWrapper} 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:
   performCreativeWrapperActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type performCreativeWrapperActionResponse

   • 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. updateCreativeWrappers
   Source code
   Description:
   Updates the specified {@code CreativeWrapper} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateCreativeWrappersRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateCreativeWrappers

   Updates the specified {@code CreativeWrapper} objects.

   • creativeWrappers - optional, unbounded; type CreativeWrapper
     A {@code CreativeWrapper} allows the wrapping of HTML snippets to be served along with {@code Creative} objects.

     Creative wrappers must be associated with a {@link LabelType#CREATIVE_WRAPPER} label and applied to ad units by {@link AdUnit#appliedLabels}.

     • id - optional; type long
       The unique ID of the {@code CreativeWrapper}. This value is readonly and is assigned by Google.
     • labelId - optional; type long
       The ID of the {@link Label} which will be used to label ad units. The {@code labelId} on a creative wrapper cannot be changed once it is created.
     • creativeWrapperType - optional; type CreativeWrapperType - type string with restriction - enum { 'HTML', 'VIDEO_TRACKING_URL', 'UNKNOWN' }
       The creative wrapper type. If the creative wrapper type is {@link CreativeWrapperType#VIDEO_TRACKING_URL}, the {@code videoTrackingUrls} field must be set. If the creative wrapper type is {@link CreativeWrapperType#HTML}, either the {@code header} or {@code footer} field must be set. This field is required.
     • htmlHeader - optional; type string
       The header HTML snippet that this creative wrapper delivers.
     • htmlFooter - optional; type string
       The footer HTML snippet that this creative wrapper delivers.
     • ampHead - optional; type string
       The header AMP snippet that this creative wrapper delivers.
     • ampBody - optional; type string
       The footer AMP snippet that this creative wrapper delivers.
     • videoTrackingUrls - optional, unbounded; type ConversionEvent_TrackingUrlsMapEntry
       This represents an entry in a map with a key of type ConversionEvent and value of type TrackingUrls.
       • key - optional; type ConversionEvent - type string with restriction - enum { 'UNKNOWN', 'CREATIVE_VIEW', 'START', 'SKIP_SHOWN', 'FIRST_QUARTILE', 'MIDPOINT', 'THIRD_QUARTILE', 'ENGAGED_VIEW', 'COMPLETE', 'MUTE', 'UNMUTE', 'PAUSE', 'REWIND', 'RESUME', 'SKIPPED', 'FULLSCREEN', 'EXPAND', 'COLLAPSE', 'ACCEPT_INVITATION', 'CLOSE', 'CLICK_TRACKING', 'SURVEY', 'CUSTOM_CLICK', 'MEASURABLE_IMPRESSION', 'VIEWABLE_IMPRESSION', 'VIDEO_ABANDON', 'FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION' }
       • value - optional; type TrackingUrls
         A list of URLs that should be pinged for a conversion event.
         • urls - optional, unbounded; type string
           A list of all URLs that should be pinged.
       The video tracking URLs that this creative wrapper delivers. This field is required if the {@code creativeWrapperType} is {@link CreativeWrapperType#VIDEO_TRACKING_URL} and ignored otherwise.
     • thirdPartyDataDeclaration - optional; type ThirdPartyDataDeclaration
       The {@code ThirdPartyDataDeclaration} for this creative wrapper.

       It is copied to one of the underlying creatives. If the header creative is active then it is persisted there. Otherwise it is stored on the footer creative.

       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
     • ordering - optional; type CreativeWrapperOrdering - type string with restriction - enum { 'NO_PREFERENCE', 'INNER', 'OUTER' }
       If there are multiple wrappers for a creative, then {@code ordering} defines the order in which the HTML snippets are rendered.
     • status - optional; type CreativeWrapperStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE' }
       The status of the {@code CreativeWrapper}. This attribute is readonly.
   Output:
   updateCreativeWrappersResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateCreativeWrappersResponse

   • rval - optional, unbounded; type CreativeWrapper
     A {@code CreativeWrapper} allows the wrapping of HTML snippets to be served along with {@code Creative} objects.

     Creative wrappers must be associated with a {@link LabelType#CREATIVE_WRAPPER} label and applied to ad units by {@link AdUnit#appliedLabels}.

     • id - optional; type long
       The unique ID of the {@code CreativeWrapper}. This value is readonly and is assigned by Google.
     • labelId - optional; type long
       The ID of the {@link Label} which will be used to label ad units. The {@code labelId} on a creative wrapper cannot be changed once it is created.
     • creativeWrapperType - optional; type CreativeWrapperType - type string with restriction - enum { 'HTML', 'VIDEO_TRACKING_URL', 'UNKNOWN' }
       The creative wrapper type. If the creative wrapper type is {@link CreativeWrapperType#VIDEO_TRACKING_URL}, the {@code videoTrackingUrls} field must be set. If the creative wrapper type is {@link CreativeWrapperType#HTML}, either the {@code header} or {@code footer} field must be set. This field is required.
     • htmlHeader - optional; type string
       The header HTML snippet that this creative wrapper delivers.
     • htmlFooter - optional; type string
       The footer HTML snippet that this creative wrapper delivers.
     • ampHead - optional; type string
       The header AMP snippet that this creative wrapper delivers.
     • ampBody - optional; type string
       The footer AMP snippet that this creative wrapper delivers.
     • videoTrackingUrls - optional, unbounded; type ConversionEvent_TrackingUrlsMapEntry
       This represents an entry in a map with a key of type ConversionEvent and value of type TrackingUrls.
       • key - optional; type ConversionEvent - type string with restriction - enum { 'UNKNOWN', 'CREATIVE_VIEW', 'START', 'SKIP_SHOWN', 'FIRST_QUARTILE', 'MIDPOINT', 'THIRD_QUARTILE', 'ENGAGED_VIEW', 'COMPLETE', 'MUTE', 'UNMUTE', 'PAUSE', 'REWIND', 'RESUME', 'SKIPPED', 'FULLSCREEN', 'EXPAND', 'COLLAPSE', 'ACCEPT_INVITATION', 'CLOSE', 'CLICK_TRACKING', 'SURVEY', 'CUSTOM_CLICK', 'MEASURABLE_IMPRESSION', 'VIEWABLE_IMPRESSION', 'VIDEO_ABANDON', 'FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION' }
       • value - optional; type TrackingUrls
         A list of URLs that should be pinged for a conversion event.
         • urls - optional, unbounded; type string
           A list of all URLs that should be pinged.
       The video tracking URLs that this creative wrapper delivers. This field is required if the {@code creativeWrapperType} is {@link CreativeWrapperType#VIDEO_TRACKING_URL} and ignored otherwise.
     • thirdPartyDataDeclaration - optional; type ThirdPartyDataDeclaration
       The {@code ThirdPartyDataDeclaration} for this creative wrapper.

       It is copied to one of the underlying creatives. If the header creative is active then it is persisted there. Otherwise it is stored on the footer creative.

       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
     • ordering - optional; type CreativeWrapperOrdering - type string with restriction - enum { 'NO_PREFERENCE', 'INNER', 'OUTER' }
       If there are multiple wrappers for a creative, then {@code ordering} defines the order in which the HTML snippets are rendered.
     • status - optional; type CreativeWrapperStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE' }
       The status of the {@code CreativeWrapper}. This attribute is readonly.
   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.