Web Service: CreativeTemplateService

Port type CreativeTemplateServiceInterfaceSource code

1. getCreativeTemplatesByStatement
   Source code
   Description:
   Gets a {@link CreativeTemplatePage} of {@link CreativeTemplate} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CreativeTemplate#id}
   {@code name}	{@link CreativeTemplate#name}
   {@code type}	{@link CreativeTemplate#type}
   {@code status}	{@link CreativeTemplate#status}

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

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

   PQL Property	Object Property
   {@code id}	{@link CreativeTemplate#id}
   {@code name}	{@link CreativeTemplate#name}
   {@code type}	{@link CreativeTemplate#type}
   {@code status}	{@link CreativeTemplate#status}

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

   • rval - optional; type CreativeTemplatePage
     Captures a page of {@link CreativeTemplate} 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 CreativeTemplate
       A template upon which a creative can be created.
       • id - optional; type long
         Uniquely identifies the {@code CreativeTemplate}. This attribute is read-only and is assigned by Google when a creative template is created.
       • name - optional; type string
         The name of the creative template. This attribute is required and has a maximum length of 255 characters.
       • description - optional; type string
         The description of the creative template. This attribute is optional.
       • variables - optional, unbounded; type CreativeTemplateVariable
         The list of creative template variables. This attribute is required.
         Represents a variable defined in a creative template.
         • label - optional; type string
           Label that is displayed to users when creating {@link TemplateCreative} from the {@link CreativeTemplate}. This attribute is required and has a maximum length of 127 characters.
         • uniqueName - optional; type string
           Unique name used to identify the variable. This attribute is read-only and is assigned by Google, by deriving from label, when a creative template variable is created.
         • description - optional; type string
           A descriptive help text that is displayed to users along with the label. This attribute is required and has a maximum length of 255 characters.
         • isRequired - optional; type boolean
           {@code true} if this variable is required to be filled in by users when creating {@link TemplateCreative} from the {@link CreativeTemplate}.
       • snippet - optional; type string
         The snippet of the creative template, with placeholders for the associated variables. This attribute is required.
       • status - optional; type CreativeTemplateStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'DELETED' }
         The status of the {@code CreativeTemplate}. This attribute is read-only and is assigned by Google.
       • type - optional; type CreativeTemplateType - type string with restriction - enum { 'SYSTEM_DEFINED', 'USER_DEFINED' }
         The type of the {@code CreativeTemplate}. Publisher can only create user-defined template
       • isInterstitial - optional; type boolean
         {@code true} if this creative template produces interstitial creatives.
       • isNativeEligible - optional; type boolean
         {@code true} if this creative template produces native-eligible creatives.
       • isSafeFrameCompatible - optional; type boolean
         Whether the {@link Creative} produced is compatible for SafeFrame rendering.

         This attribute is optional and defaults to {@code true}.

       The collection of creative templates 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.