com.google.api.ads.dfp.axis.v201203

Interface CompanyServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

CompanyServiceSoapBindingStub

public interface CompanyServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
Company[]	createCompanies(Company[] companies) Creates new Company objects.
Company	createCompany(Company company) Creates a new Company.
CompanyPage	getCompaniesByStatement(Statement filterStatement) Gets a CompanyPage of Company objects that satisfy the given Statement.query.
Company	getCompany(Long companyId) Returns the Company uniquely identified by the given ID.
Company[]	updateCompanies(Company[] companies) Updates the specified Company objects.
Company	updateCompany(Company company) Updates the specified Company.

Method Detail

createCompanies

Company[] createCompanies(Company[] companies)
                          throws RemoteException,
                                 ApiException

Creates new Company objects.

Parameters:

companies - the companies to create

Returns:

the created companies with their IDs filled in

Throws:

RemoteException

ApiException

createCompany

Company createCompany(Company company)
                      throws RemoteException,
                             ApiException

Creates a new Company. The following fields are required:

• Company.name
• Company.type

Parameters:

company - the company to create

Returns:

the new company with its ID filled in

Throws:

RemoteException

ApiException

getCompaniesByStatement

CompanyPage getCompaniesByStatement(Statement filterStatement)
                                    throws RemoteException,
                                           ApiException

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

PQL Property	Object Property
id	Company.id
name	Company.name
type	Company.type
lastModifiedDateTime	Company.lastModifiedDateTime

Parameters:

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

Returns:

the companies that match the given filter

Throws:

RemoteException

ApiException

getCompany

Company getCompany(Long companyId)
                   throws RemoteException,
                          ApiException

Returns the Company uniquely identified by the given ID.

Parameters:

companyId - ID of the company, which must already exist

Returns:

the Company uniquely identified by the given ID

Throws:

RemoteException

ApiException

updateCompanies

Company[] updateCompanies(Company[] companies)
                          throws RemoteException,
                                 ApiException

Updates the specified Company objects.

Parameters:

companies - the companies to update

Returns:

the updated companies

Throws:

RemoteException

ApiException

updateCompany

Company updateCompany(Company company)
                      throws RemoteException,
                             ApiException

Updates the specified Company.

Parameters:

company - the company to update

Returns:

the updated company

Throws:

RemoteException

ApiException