com.google.api.ads.dfp.jaxws.v201805

Interface TeamServiceInterface

public interface TeamServiceInterface

Provides methods for creating, updating, and retrieving Team objects.

Teams are used to group users in order to define access to entities such as companies, inventory and orders.

This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
List<Team>	createTeams(List<Team> teams) Creates new Team objects.
TeamPage	getTeamsByStatement(Statement filterStatement) Gets a TeamPage of Team objects that satisfy the given Statement.query.
UpdateResult	performTeamAction(TeamAction teamAction, Statement filterStatement) Performs actions on Team objects that match the given Statement.query.
List<Team>	updateTeams(List<Team> teams) Updates the specified Team objects.

Method Detail

createTeams

@RequestWrapper(localName="createTeams",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.TeamServiceInterfacecreateTeams")
 @ResponseWrapper(localName="createTeamsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.TeamServiceInterfacecreateTeamsResponse")
List<Team> createTeams(List<Team> teams)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Creates new Team objects. The following fields are required:

• Team.name

Parameters:

teams - the teams to create

teams -

Returns:

the created teams with their IDs filled in

Throws:

ApiException_Exception

getTeamsByStatement

@RequestWrapper(localName="getTeamsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.TeamServiceInterfacegetTeamsByStatement")
 @ResponseWrapper(localName="getTeamsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.TeamServiceInterfacegetTeamsByStatementResponse")
TeamPage getTeamsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

Gets a TeamPage of Team objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	Team.id
name	Team.name
description	Team.description

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of teams.

filterStatement -

Returns:

the teams that match the given filter

Throws:

ApiException_Exception

performTeamAction

@RequestWrapper(localName="performTeamAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.TeamServiceInterfaceperformTeamAction")
 @ResponseWrapper(localName="performTeamActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.TeamServiceInterfaceperformTeamActionResponse")
UpdateResult performTeamAction(TeamAction teamAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Performs actions on Team objects that match the given Statement.query.

Parameters:

teamAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of teams

filterStatement -

teamAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateTeams

@RequestWrapper(localName="updateTeams",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.TeamServiceInterfaceupdateTeams")
 @ResponseWrapper(localName="updateTeamsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.TeamServiceInterfaceupdateTeamsResponse")
List<Team> updateTeams(List<Team> teams)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Updates the specified Team objects.

Parameters:

teams - the teams to update

teams -

Returns:

the updated teams

Throws:

ApiException_Exception