com.google.api.ads.dfp.axis.v201306

Interface ContactServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ContactServiceSoapBindingStub

public interface ContactServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
Contact	createContact(Contact contact) Creates a new Contact.
Contact[]	createContacts(Contact[] contacts) Creates new Contact objects.
Contact	getContact(Long contactId) Returns the Contact uniquely identified by the given ID.
ContactPage	getContactsByStatement(Statement statement) Gets a ContactPage of Contact objects that satisfy the given Statement.query.
Contact	updateContact(Contact contact) Updates the specified Contact.
Contact[]	updateContacts(Contact[] contacts) Updates the specified Contact objects.

Method Detail

createContact

Contact createContact(Contact contact)
                      throws RemoteException,
                             ApiException

Creates a new Contact. The following fields are required:

• Contact.companyId
• Contact.name

Parameters:

contact - the contact to create

Returns:

the contact with its ID filled in

Throws:

RemoteException

ApiException

createContacts

Contact[] createContacts(Contact[] contacts)
                         throws RemoteException,
                                ApiException

Creates new Contact objects.

Parameters:

contacts - the contacts to create

Returns:

the created contacts with their IDs filled in

Throws:

RemoteException

ApiException

getContact

Contact getContact(Long contactId)
                   throws RemoteException,
                          ApiException

Returns the Contact uniquely identified by the given ID.

Parameters:

contactId - the ID of the contact, which must already exist

Returns:

the Contact uniquely identified by the given ID

Throws:

RemoteException

ApiException

getContactsByStatement

ContactPage getContactsByStatement(Statement statement)
                                   throws RemoteException,
                                          ApiException

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

PQL Property	Object Property
name	Contact.name
email	Contact.email
id	Contact.id
comment	Contact.comment
companyId	Contact.companyId
title	Contact.title
cellPhone	Contact.cellPhone
workPhone	Contact.workPhone
faxPhone	Contact.faxPhone
status	Contact.status

Parameters:

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

Returns:

the contacts that match the given filter

Throws:

RemoteException

ApiException

updateContact

Contact updateContact(Contact contact)
                      throws RemoteException,
                             ApiException

Updates the specified Contact.

Parameters:

contact - the contact to update

Returns:

the updated contact

Throws:

RemoteException

ApiException

updateContacts

Contact[] updateContacts(Contact[] contacts)
                         throws RemoteException,
                                ApiException

Updates the specified Contact objects.

Parameters:

contacts - the contacts to update

Returns:

the updated contacts

Throws:

RemoteException

ApiException