Web Service: LabelService

Port type LabelServiceInterfaceSource code

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

   Creates new {@link Label} objects.

   • labels - optional, unbounded; type Label
     A {@code Label} is additional information that can be added to an entity.
     • id - optional; type long
       Unique ID of the {@code Label}. This value is readonly and is assigned by Google.
     • name - optional; type string
       Name of the {@code Label}. This is value is required to create a label and has a maximum length of 127 characters.
     • description - optional; type string
       A description of the label. This value is optional and its maximum length is 255 characters.
     • isActive - optional; type boolean
       Specifies whether or not the label is active. This attribute is read-only.
     • adCategory - optional; type AdCategoryDto
       A canonical ad category.
       • id - optional; type long
         Canonical ID of the ad category.
       • displayName - optional; type string
         Localized name of the category.
       • parentId - optional; type long
         ID of the category's parent, or 0 if it has no parent.
       Indicates the Ad Category associated with the label.
     • types - optional, unbounded; type LabelType - type string with restriction - enum { 'COMPETITIVE_EXCLUSION', 'AD_UNIT_FREQUENCY_CAP', 'AD_EXCLUSION', 'CREATIVE_WRAPPER', 'CANONICAL_CATEGORY', 'UNKNOWN' }
       The types of the {@code Label}.
   Output:
   createLabelsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createLabelsResponse

   • rval - optional, unbounded; type Label
     A {@code Label} is additional information that can be added to an entity.
     • id - optional; type long
       Unique ID of the {@code Label}. This value is readonly and is assigned by Google.
     • name - optional; type string
       Name of the {@code Label}. This is value is required to create a label and has a maximum length of 127 characters.
     • description - optional; type string
       A description of the label. This value is optional and its maximum length is 255 characters.
     • isActive - optional; type boolean
       Specifies whether or not the label is active. This attribute is read-only.
     • adCategory - optional; type AdCategoryDto
       A canonical ad category.
       • id - optional; type long
         Canonical ID of the ad category.
       • displayName - optional; type string
         Localized name of the category.
       • parentId - optional; type long
         ID of the category's parent, or 0 if it has no parent.
       Indicates the Ad Category associated with the label.
     • types - optional, unbounded; type LabelType - type string with restriction - enum { 'COMPETITIVE_EXCLUSION', 'AD_UNIT_FREQUENCY_CAP', 'AD_EXCLUSION', 'CREATIVE_WRAPPER', 'CANONICAL_CATEGORY', 'UNKNOWN' }
       The types of the {@code Label}.
   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. getLabelsByStatement
   Source code
   Description:
   Gets a {@link LabelPage} of {@link Label} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link Label#id}
   {@code type}	{@link Label#type}
   {@code name}	{@link Label#name}
   {@code description}	{@link Label#description}
   {@code isActive}	{@link Label#isActive}

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

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

   PQL Property	Object Property
   {@code id}	{@link Label#id}
   {@code type}	{@link Label#type}
   {@code name}	{@link Label#name}
   {@code description}	{@link Label#description}
   {@code isActive}	{@link Label#isActive}

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

   • rval - optional; type LabelPage
     Captures a page of {@link Label} 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 Label
       A {@code Label} is additional information that can be added to an entity.
       • id - optional; type long
         Unique ID of the {@code Label}. This value is readonly and is assigned by Google.
       • name - optional; type string
         Name of the {@code Label}. This is value is required to create a label and has a maximum length of 127 characters.
       • description - optional; type string
         A description of the label. This value is optional and its maximum length is 255 characters.
       • isActive - optional; type boolean
         Specifies whether or not the label is active. This attribute is read-only.
       • adCategory - optional; type AdCategoryDto
         A canonical ad category.
         • id - optional; type long
           Canonical ID of the ad category.
         • displayName - optional; type string
           Localized name of the category.
         • parentId - optional; type long
           ID of the category's parent, or 0 if it has no parent.
         Indicates the Ad Category associated with the label.
       • types - optional, unbounded; type LabelType - type string with restriction - enum { 'COMPETITIVE_EXCLUSION', 'AD_UNIT_FREQUENCY_CAP', 'AD_EXCLUSION', 'CREATIVE_WRAPPER', 'CANONICAL_CATEGORY', 'UNKNOWN' }
         The types of the {@code Label}.
       The collection of labels 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. performLabelAction
   Source code
   Description:
   Performs actions on {@link Label} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performLabelActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performLabelAction

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

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

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

   Updates the specified {@link Label} objects.

   • labels - optional, unbounded; type Label
     A {@code Label} is additional information that can be added to an entity.
     • id - optional; type long
       Unique ID of the {@code Label}. This value is readonly and is assigned by Google.
     • name - optional; type string
       Name of the {@code Label}. This is value is required to create a label and has a maximum length of 127 characters.
     • description - optional; type string
       A description of the label. This value is optional and its maximum length is 255 characters.
     • isActive - optional; type boolean
       Specifies whether or not the label is active. This attribute is read-only.
     • adCategory - optional; type AdCategoryDto
       A canonical ad category.
       • id - optional; type long
         Canonical ID of the ad category.
       • displayName - optional; type string
         Localized name of the category.
       • parentId - optional; type long
         ID of the category's parent, or 0 if it has no parent.
       Indicates the Ad Category associated with the label.
     • types - optional, unbounded; type LabelType - type string with restriction - enum { 'COMPETITIVE_EXCLUSION', 'AD_UNIT_FREQUENCY_CAP', 'AD_EXCLUSION', 'CREATIVE_WRAPPER', 'CANONICAL_CATEGORY', 'UNKNOWN' }
       The types of the {@code Label}.
   Output:
   updateLabelsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateLabelsResponse

   • rval - optional, unbounded; type Label
     A {@code Label} is additional information that can be added to an entity.
     • id - optional; type long
       Unique ID of the {@code Label}. This value is readonly and is assigned by Google.
     • name - optional; type string
       Name of the {@code Label}. This is value is required to create a label and has a maximum length of 127 characters.
     • description - optional; type string
       A description of the label. This value is optional and its maximum length is 255 characters.
     • isActive - optional; type boolean
       Specifies whether or not the label is active. This attribute is read-only.
     • adCategory - optional; type AdCategoryDto
       A canonical ad category.
       • id - optional; type long
         Canonical ID of the ad category.
       • displayName - optional; type string
         Localized name of the category.
       • parentId - optional; type long
         ID of the category's parent, or 0 if it has no parent.
       Indicates the Ad Category associated with the label.
     • types - optional, unbounded; type LabelType - type string with restriction - enum { 'COMPETITIVE_EXCLUSION', 'AD_UNIT_FREQUENCY_CAP', 'AD_EXCLUSION', 'CREATIVE_WRAPPER', 'CANONICAL_CATEGORY', 'UNKNOWN' }
       The types of the {@code Label}.
   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.