Web Service: TeamService

Port type TeamServiceInterfaceSource code

1. createTeams
   Source code
   Description:
   Creates new {@link Team} objects.

   The following fields are required:

   • {@link Team#name}
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createTeamsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createTeams

   Creates new {@link Team} objects.

   The following fields are required:

   • {@link Team#name}

   • teams - optional, unbounded; type Team
     A {@code Team} defines a grouping of users and what entities they have access to. Users are added to teams with {@link UserTeamAssociation} objects.
     • id - optional; type long
       The unique ID of the {@code Team}. This value is readonly and is assigned by Google. Teams that are created by Google will have negative IDs.
     • name - optional; type string
       The name of the {@code Team}. This value is required to create a team and has a maximum length of 106 characters.
     • description - optional; type string
       The description of the {@code Team}. This value is optional and has a maximum length of 255 characters.
     • status - optional; type TeamStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       The status of the {@link Team}. This value can be {@link TeamStatus#ACTIVE} (default) or {@link TeamStatus#INACTIVE} and determines the visibility of the team in the UI.
     • hasAllCompanies - optional; type boolean
       Whether or not users on this team have access to all companies. If this value is true, then an error will be thrown if an attempt is made to associate this team with a Company.
     • hasAllInventory - optional; type boolean
       Whether or not users on this team have access to all inventory. If this value is true, then an error will be thrown if an attempt is made to associate this team with an AdUnit.
     • teamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The default access to orders, for users on this team.
   Output:
   createTeamsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createTeamsResponse

   • rval - optional, unbounded; type Team
     A {@code Team} defines a grouping of users and what entities they have access to. Users are added to teams with {@link UserTeamAssociation} objects.
     • id - optional; type long
       The unique ID of the {@code Team}. This value is readonly and is assigned by Google. Teams that are created by Google will have negative IDs.
     • name - optional; type string
       The name of the {@code Team}. This value is required to create a team and has a maximum length of 106 characters.
     • description - optional; type string
       The description of the {@code Team}. This value is optional and has a maximum length of 255 characters.
     • status - optional; type TeamStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       The status of the {@link Team}. This value can be {@link TeamStatus#ACTIVE} (default) or {@link TeamStatus#INACTIVE} and determines the visibility of the team in the UI.
     • hasAllCompanies - optional; type boolean
       Whether or not users on this team have access to all companies. If this value is true, then an error will be thrown if an attempt is made to associate this team with a Company.
     • hasAllInventory - optional; type boolean
       Whether or not users on this team have access to all inventory. If this value is true, then an error will be thrown if an attempt is made to associate this team with an AdUnit.
     • teamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The default access to orders, for users on this team.
   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. getTeamsByStatement
   Source code
   Description:
   Gets a {@code TeamPage} of {@code Team} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link Team#id}
   {@code name}	{@link Team#name}
   {@code description}	{@link Team#description}

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

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

   PQL Property	Object Property
   {@code id}	{@link Team#id}
   {@code name}	{@link Team#name}
   {@code description}	{@link Team#description}

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

   • rval - optional; type TeamPage
     Captures a page of {@link Team} 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 Team
       A {@code Team} defines a grouping of users and what entities they have access to. Users are added to teams with {@link UserTeamAssociation} objects.
       • id - optional; type long
         The unique ID of the {@code Team}. This value is readonly and is assigned by Google. Teams that are created by Google will have negative IDs.
       • name - optional; type string
         The name of the {@code Team}. This value is required to create a team and has a maximum length of 106 characters.
       • description - optional; type string
         The description of the {@code Team}. This value is optional and has a maximum length of 255 characters.
       • status - optional; type TeamStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
         The status of the {@link Team}. This value can be {@link TeamStatus#ACTIVE} (default) or {@link TeamStatus#INACTIVE} and determines the visibility of the team in the UI.
       • hasAllCompanies - optional; type boolean
         Whether or not users on this team have access to all companies. If this value is true, then an error will be thrown if an attempt is made to associate this team with a Company.
       • hasAllInventory - optional; type boolean
         Whether or not users on this team have access to all inventory. If this value is true, then an error will be thrown if an attempt is made to associate this team with an AdUnit.
       • teamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
         The default access to orders, for users on this team.
       The collection of teams 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. performTeamAction
   Source code
   Description:
   Performs actions on {@link Team} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performTeamActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performTeamAction

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

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

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

   Updates the specified {@link Team} objects.

   • teams - optional, unbounded; type Team
     A {@code Team} defines a grouping of users and what entities they have access to. Users are added to teams with {@link UserTeamAssociation} objects.
     • id - optional; type long
       The unique ID of the {@code Team}. This value is readonly and is assigned by Google. Teams that are created by Google will have negative IDs.
     • name - optional; type string
       The name of the {@code Team}. This value is required to create a team and has a maximum length of 106 characters.
     • description - optional; type string
       The description of the {@code Team}. This value is optional and has a maximum length of 255 characters.
     • status - optional; type TeamStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       The status of the {@link Team}. This value can be {@link TeamStatus#ACTIVE} (default) or {@link TeamStatus#INACTIVE} and determines the visibility of the team in the UI.
     • hasAllCompanies - optional; type boolean
       Whether or not users on this team have access to all companies. If this value is true, then an error will be thrown if an attempt is made to associate this team with a Company.
     • hasAllInventory - optional; type boolean
       Whether or not users on this team have access to all inventory. If this value is true, then an error will be thrown if an attempt is made to associate this team with an AdUnit.
     • teamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The default access to orders, for users on this team.
   Output:
   updateTeamsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateTeamsResponse

   • rval - optional, unbounded; type Team
     A {@code Team} defines a grouping of users and what entities they have access to. Users are added to teams with {@link UserTeamAssociation} objects.
     • id - optional; type long
       The unique ID of the {@code Team}. This value is readonly and is assigned by Google. Teams that are created by Google will have negative IDs.
     • name - optional; type string
       The name of the {@code Team}. This value is required to create a team and has a maximum length of 106 characters.
     • description - optional; type string
       The description of the {@code Team}. This value is optional and has a maximum length of 255 characters.
     • status - optional; type TeamStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       The status of the {@link Team}. This value can be {@link TeamStatus#ACTIVE} (default) or {@link TeamStatus#INACTIVE} and determines the visibility of the team in the UI.
     • hasAllCompanies - optional; type boolean
       Whether or not users on this team have access to all companies. If this value is true, then an error will be thrown if an attempt is made to associate this team with a Company.
     • hasAllInventory - optional; type boolean
       Whether or not users on this team have access to all inventory. If this value is true, then an error will be thrown if an attempt is made to associate this team with an AdUnit.
     • teamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The default access to orders, for users on this team.
   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.