com.google.api.ads.admanager.axis.v202208

Interface SiteServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

SiteServiceSoapBindingStub

public interface SiteServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
Site[]	createSites(Site[] sites) Creates new Site objects.
SitePage	getSitesByStatement(Statement filterStatement) Gets a SitePage of Site objects that satisfy the given Statement.query.
UpdateResult	performSiteAction(SiteAction siteAction, Statement filterStatement) Performs actions on Site objects that match the given Statement.query.
Site[]	updateSites(Site[] sites) Updates the specified Site objects.

Method Detail

createSites

Site[] createSites(Site[] sites)
            throws RemoteException,
                   ApiException

Creates new Site objects.

Parameters:

sites - the sites to create

Returns:

the created sites with their IDs filled in

Throws:

RemoteException

ApiException

getSitesByStatement

SitePage getSitesByStatement(Statement filterStatement)
                      throws RemoteException,
                             ApiException

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

PQL Property	Object Property
id	Site.id
url	Site.url
childNetworkCode	Site.childNetworkCode
approvalStatus	Site.approvalStatus
active	Site.active
lastModifiedApprovalStatusDateTime

Restriction: The lastModifiedApprovalStatusDateTime PQL property can only be used in a top-level expression scoping the filterStatement to Sites whose approvalStatus was modified on or after a specified date and time. (e.x. "WHERE lastModifiedApprovalStatusDateTime >= '2022-01-01T00:00:00'").

Parameters:

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

Returns:

the sites that match the given filter

Throws:

RemoteException

ApiException

performSiteAction

UpdateResult performSiteAction(SiteAction siteAction,
                               Statement filterStatement)
                        throws RemoteException,
                               ApiException

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

Parameters:

siteAction - the action to perform

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateSites

Site[] updateSites(Site[] sites)
            throws RemoteException,
                   ApiException

Updates the specified Site objects.

The Site.childNetworkCode can be updated in order to 1) change the child network, 2) move a site from O&O to represented, or 3) move a site from represented to O&O.

Parameters:

sites - the sites to update

Returns:

the updated sites

Throws:

RemoteException

ApiException