com.google.api.ads.dfp.axis.v201206

Interface UserTeamAssociationServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

UserTeamAssociationServiceSoapBindingStub

public interface UserTeamAssociationServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
UserTeamAssociation	createUserTeamAssociation(UserTeamAssociation userTeamAssociation) Creates a new UserTeamAssociation.
UserTeamAssociation[]	createUserTeamAssociations(UserTeamAssociation[] userTeamAssociations) Creates new UserTeamAssociation objects.
UserTeamAssociation	getUserTeamAssociation(Long teamId, Long userId) Returns the UserTeamAssociation uniquely identified by the given user and team IDs.
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.
UserTeamAssociation	updateUserTeamAssociation(UserTeamAssociation userTeamAssociation) Updates the specified UserTeamAssociation.
UserTeamAssociation[]	updateUserTeamAssociations(UserTeamAssociation[] userTeamAssociations) Updates the specified UserTeamAssociation objects.

Method Detail

createUserTeamAssociation

UserTeamAssociation createUserTeamAssociation(UserTeamAssociation userTeamAssociation)
                                              throws RemoteException,
                                                     ApiException

Creates a new UserTeamAssociation. The following fields are required:

• UserRecordTeamAssociation.teamId
• UserTeamAssociation.userId

Parameters:

userTeamAssociation - the user team association to create

Returns:

the user team association with its ID filled in

Throws:

RemoteException

ApiException

createUserTeamAssociations

UserTeamAssociation[] createUserTeamAssociations(UserTeamAssociation[] userTeamAssociations)
                                                 throws RemoteException,
                                                        ApiException

Creates new UserTeamAssociation objects.

Parameters:

userTeamAssociations - the user team associations to create

Returns:

the created user team associations with their IDs filled in

Throws:

RemoteException

ApiException

getUserTeamAssociation

UserTeamAssociation getUserTeamAssociation(Long teamId,
                                         Long userId)
                                           throws RemoteException,
                                                  ApiException

Returns the UserTeamAssociation uniquely identified by the given user and team IDs.

Parameters:

teamId - the ID of the team, which must already exist

userId - the ID of the user, which must already exist

Returns:

the UserTeamAssociation uniquely identified by the user and team IDs

Throws:

RemoteException

ApiException

getUserTeamAssociationsByStatement

UserTeamAssociationPage getUserTeamAssociationsByStatement(Statement filterStatement)
                                                           throws RemoteException,
                                                                  ApiException

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

Returns:

the user team associations that match the given filter

Throws:

RemoteException

ApiException

performUserTeamAssociationAction

UpdateResult performUserTeamAssociationAction(UserTeamAssociationAction userTeamAssociationAction,
                                            Statement statement)
                                              throws RemoteException,
                                                     ApiException

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateUserTeamAssociation

UserTeamAssociation updateUserTeamAssociation(UserTeamAssociation userTeamAssociation)
                                              throws RemoteException,
                                                     ApiException

Updates the specified UserTeamAssociation.

Parameters:

userTeamAssociation - the user team association to update

Returns:

the updated user team association

Throws:

RemoteException

ApiException

updateUserTeamAssociations

UserTeamAssociation[] updateUserTeamAssociations(UserTeamAssociation[] userTeamAssociations)
                                                 throws RemoteException,
                                                        ApiException

Updates the specified UserTeamAssociation objects.

Parameters:

userTeamAssociations - the user team associations to update

Returns:

the updated user team associations

Throws:

RemoteException

ApiException