Web Service: CmsMetadataService

Port type CmsMetadataServiceInterfaceSource code

1. getCmsMetadataKeysByStatement
   Source code
   Description:
   Returns a page of {@link CmsMetadataKey}s matching the specified {@link Statement}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CmsMetadataKey#cmsMetadataKeyId}
   {@code cmsKey}	{@link CmsMetadataKey#keyName}
   {@code status}	{@link CmsMetadataKey#status}

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

   Returns a page of {@link CmsMetadataKey}s matching the specified {@link Statement}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CmsMetadataKey#cmsMetadataKeyId}
   {@code cmsKey}	{@link CmsMetadataKey#keyName}
   {@code status}	{@link CmsMetadataKey#status}

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

   • rval - optional; type CmsMetadataKeyPage
     Captures a page of CMS metadata key objects.
     • totalResultSetSize - optional; type int
     • startIndex - optional; type int
     • results - optional, unbounded; type CmsMetadataKey
       Key associated with a piece of content from a publisher's CMS.
       • id - optional; type long
         The ID of this CMS metadata key. This field is read-only and provided by Google.
       • name - optional; type string
         The key of a key-value pair.
       • status - optional; type CmsMetadataKeyStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
         The status of this CMS metadata key. This attribute is read-only.
   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. getCmsMetadataValuesByStatement
   Source code
   Description:
   Returns a page of {@link CmsMetadataValue}s matching the specified {@link Statement}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CmsMetadataValue#cmsMetadataValueId}
   {@code cmsValue}	{@link CmsMetadataValue#valueName}
   {@code cmsKey}	{@link CmsMetadataValue#key#name}
   {@code cmsKeyId}	{@link CmsMetadataValue#key#id}
   {@code status}	{@link CmsMetadataValue#status}

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

   Returns a page of {@link CmsMetadataValue}s matching the specified {@link Statement}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CmsMetadataValue#cmsMetadataValueId}
   {@code cmsValue}	{@link CmsMetadataValue#valueName}
   {@code cmsKey}	{@link CmsMetadataValue#key#name}
   {@code cmsKeyId}	{@link CmsMetadataValue#key#id}
   {@code status}	{@link CmsMetadataValue#status}

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

   • rval - optional; type CmsMetadataValuePage
     Captures a page of CMS metadata value objects.
     • totalResultSetSize - optional; type int
     • startIndex - optional; type int
     • results - optional, unbounded; type CmsMetadataValue
       Key value pair associated with a piece of content from a publisher's CMS.
       • cmsMetadataValueId - optional; type long
         The ID of this CMS metadata value, to be used in targeting. This field is read-only and provided by Google.
       • valueName - optional; type string
         The value of this key-value pair.
       • key - optional; type CmsMetadataKey
         Key associated with a piece of content from a publisher's CMS.
         • id - optional; type long
           The ID of this CMS metadata key. This field is read-only and provided by Google.
         • name - optional; type string
           The key of a key-value pair.
         • status - optional; type CmsMetadataKeyStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
           The status of this CMS metadata key. This attribute is read-only.
       • status - optional; type CmsMetadataValueStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED', 'UNKNOWN' }
         The status of this CMS metadata value. This attribute is read-only.
   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. performCmsMetadataKeyAction
   Source code
   Description:
   Performs actions on {@link CmsMetadataKey} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performCmsMetadataKeyActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performCmsMetadataKeyAction

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

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

   • 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. performCmsMetadataValueAction
   Source code
   Description:
   Performs actions on {@link CmsMetadataValue} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performCmsMetadataValueActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performCmsMetadataValueAction

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

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

   • 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.