Web Service: CreativeSetService

Port type CreativeSetServiceInterfaceSource code

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

   Creates a new {@link CreativeSet}.

   • creativeSet - optional; type CreativeSet
     A creative set is comprised of a master creative and its companion creatives.
     • id - optional; type long
       Uniquely identifies the {@code CreativeSet}. This attribute is read-only and is assigned by Google when a creative set is created.
     • name - optional; type string
       The name of the creative set. This attribute is required and has a maximum length of 255 characters.
     • masterCreativeId - optional; type long
       The ID of the master creative associated with this creative set. This attribute is required.
     • companionCreativeIds - optional, unbounded; type long
       The IDs of the companion creatives associated with this creative set. This attribute is required.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this creative set 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
   Output:
   createCreativeSetResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createCreativeSetResponse

   • rval - optional; type CreativeSet
     A creative set is comprised of a master creative and its companion creatives.
     • id - optional; type long
       Uniquely identifies the {@code CreativeSet}. This attribute is read-only and is assigned by Google when a creative set is created.
     • name - optional; type string
       The name of the creative set. This attribute is required and has a maximum length of 255 characters.
     • masterCreativeId - optional; type long
       The ID of the master creative associated with this creative set. This attribute is required.
     • companionCreativeIds - optional, unbounded; type long
       The IDs of the companion creatives associated with this creative set. This attribute is required.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this creative set 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
   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. getCreativeSetsByStatement
   Source code
   Description:
   Gets a {@link CreativeSetPage} of {@link CreativeSet} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CreativeSet#id}
   {@code name}	{@link CreativeSet#name}
   {@code masterCreativeId}	{@link CreativeSet#masterCreativeId}
   {@code lastModifiedDateTime}	{@link CreativeSet#lastModifiedDateTime}

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

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

   PQL Property	Object Property
   {@code id}	{@link CreativeSet#id}
   {@code name}	{@link CreativeSet#name}
   {@code masterCreativeId}	{@link CreativeSet#masterCreativeId}
   {@code lastModifiedDateTime}	{@link CreativeSet#lastModifiedDateTime}

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

   • rval - optional; type CreativeSetPage
     Captures a page of {@link CreativeSet} 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 CreativeSet
       A creative set is comprised of a master creative and its companion creatives.
       • id - optional; type long
         Uniquely identifies the {@code CreativeSet}. This attribute is read-only and is assigned by Google when a creative set is created.
       • name - optional; type string
         The name of the creative set. This attribute is required and has a maximum length of 255 characters.
       • masterCreativeId - optional; type long
         The ID of the master creative associated with this creative set. This attribute is required.
       • companionCreativeIds - optional, unbounded; type long
         The IDs of the companion creatives associated with this creative set. This attribute is required.
       • lastModifiedDateTime - optional; type DateTime
         The date and time this creative set 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
       The collection of creative sets 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. updateCreativeSet
   Source code
   Description:
   Updates the specified {@link CreativeSet}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateCreativeSetRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateCreativeSet

   Updates the specified {@link CreativeSet}.

   • creativeSet - optional; type CreativeSet
     A creative set is comprised of a master creative and its companion creatives.
     • id - optional; type long
       Uniquely identifies the {@code CreativeSet}. This attribute is read-only and is assigned by Google when a creative set is created.
     • name - optional; type string
       The name of the creative set. This attribute is required and has a maximum length of 255 characters.
     • masterCreativeId - optional; type long
       The ID of the master creative associated with this creative set. This attribute is required.
     • companionCreativeIds - optional, unbounded; type long
       The IDs of the companion creatives associated with this creative set. This attribute is required.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this creative set 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
   Output:
   updateCreativeSetResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateCreativeSetResponse

   • rval - optional; type CreativeSet
     A creative set is comprised of a master creative and its companion creatives.
     • id - optional; type long
       Uniquely identifies the {@code CreativeSet}. This attribute is read-only and is assigned by Google when a creative set is created.
     • name - optional; type string
       The name of the creative set. This attribute is required and has a maximum length of 255 characters.
     • masterCreativeId - optional; type long
       The ID of the master creative associated with this creative set. This attribute is required.
     • companionCreativeIds - optional, unbounded; type long
       The IDs of the companion creatives associated with this creative set. This attribute is required.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this creative set 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
   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.