com.google.api.ads.dfp.jaxws.v201708

Interface UserTeamAssociationServiceInterface

public interface UserTeamAssociationServiceInterface

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

UserTeamAssociation objects are used to add users to teams in order to define access to entities such as companies, inventory and orders and to override the team's access type to orders for a user.

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<UserTeamAssociation>	createUserTeamAssociations(List<UserTeamAssociation> userTeamAssociations) Creates new UserTeamAssociation objects.
UserTeamAssociationPage	getUserTeamAssociationsByStatement(Statement filterStatement) Gets a UserTeamAssociationPage of UserTeamAssociation objects that satisfy the given Statement.query.
UpdateResult	performUserTeamAssociationAction(UserTeamAssociationAction userTeamAssociationAction, Statement statement) Performs actions on UserTeamAssociation objects that match the given Statement.query.
List<UserTeamAssociation>	updateUserTeamAssociations(List<UserTeamAssociation> userTeamAssociations) Updates the specified UserTeamAssociation objects.

Method Detail

createUserTeamAssociations

@RequestWrapper(localName="createUserTeamAssociations",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.UserTeamAssociationServiceInterfacecreateUserTeamAssociations")
 @ResponseWrapper(localName="createUserTeamAssociationsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.UserTeamAssociationServiceInterfacecreateUserTeamAssociationsResponse")
List<UserTeamAssociation> createUserTeamAssociations(List<UserTeamAssociation> userTeamAssociations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Creates new UserTeamAssociation objects.

Parameters:

userTeamAssociations - the user team associations to create

userTeamAssociations -

Returns:

the created user team associations with their IDs filled in

Throws:

ApiException_Exception

getUserTeamAssociationsByStatement

@RequestWrapper(localName="getUserTeamAssociationsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.UserTeamAssociationServiceInterfacegetUserTeamAssociationsByStatement")
 @ResponseWrapper(localName="getUserTeamAssociationsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.UserTeamAssociationServiceInterfacegetUserTeamAssociationsByStatementResponse")
UserTeamAssociationPage getUserTeamAssociationsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

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

PQL Property	Object Property
userId	UserTeamAssociation.userId
teamId	UserRecordTeamAssociation.teamId

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of user team associations

filterStatement -

Returns:

the user team associations that match the given filter

Throws:

ApiException_Exception

performUserTeamAssociationAction

@RequestWrapper(localName="performUserTeamAssociationAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.UserTeamAssociationServiceInterfaceperformUserTeamAssociationAction")
 @ResponseWrapper(localName="performUserTeamAssociationActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.UserTeamAssociationServiceInterfaceperformUserTeamAssociationActionResponse")
UpdateResult performUserTeamAssociationAction(UserTeamAssociationAction userTeamAssociationAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Statement statement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             throws ApiException_Exception

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

Parameters:

userTeamAssociationAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of user team associations

userTeamAssociationAction -

statement -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateUserTeamAssociations

@RequestWrapper(localName="updateUserTeamAssociations",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.UserTeamAssociationServiceInterfaceupdateUserTeamAssociations")
 @ResponseWrapper(localName="updateUserTeamAssociationsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.UserTeamAssociationServiceInterfaceupdateUserTeamAssociationsResponse")
List<UserTeamAssociation> updateUserTeamAssociations(List<UserTeamAssociation> userTeamAssociations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Updates the specified UserTeamAssociation objects.

Parameters:

userTeamAssociations - the user team associations to update

userTeamAssociations -

Returns:

the updated user team associations

Throws:

ApiException_Exception