com.google.api.ads.dfp.jaxws.v201711

Interface ContentMetadataKeyHierarchyServiceInterface

public interface ContentMetadataKeyHierarchyServiceInterface

Provides methods for creating, updating, and retrieving ContentMetadataKeyHierarchy objects. 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<ContentMetadataKeyHierarchy>	createContentMetadataKeyHierarchies(List<ContentMetadataKeyHierarchy> contentMetadataKeyHierarchies) Creates new ContentMetadataKeyHierarchy objects.
ContentMetadataKeyHierarchyPage	getContentMetadataKeyHierarchiesByStatement(Statement filterStatement) Gets a ContentMetadataKeyHierarchyPage of ContentMetadataKeyHierarchy objects that satisfy the given Statement.query.
UpdateResult	performContentMetadataKeyHierarchyAction(ContentMetadataKeyHierarchyAction contentMetadataKeyHierarchyAction, Statement filterStatement) Performs actions on ContentMetadataKeyHierarchy objects that match the given Statement.query.
List<ContentMetadataKeyHierarchy>	updateContentMetadataKeyHierarchies(List<ContentMetadataKeyHierarchy> contentMetadataKeyHierarchies) Updates the specified ContentMetadataKeyHierarchy objects.

Method Detail

createContentMetadataKeyHierarchies

@RequestWrapper(localName="createContentMetadataKeyHierarchies",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.ContentMetadataKeyHierarchyServiceInterfacecreateContentMetadataKeyHierarchies")
 @ResponseWrapper(localName="createContentMetadataKeyHierarchiesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.ContentMetadataKeyHierarchyServiceInterfacecreateContentMetadataKeyHierarchiesResponse")
List<ContentMetadataKeyHierarchy> createContentMetadataKeyHierarchies(List<ContentMetadataKeyHierarchy> contentMetadataKeyHierarchies)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException_Exception

Creates new ContentMetadataKeyHierarchy objects.

The following fields are required:

• ContentMetadataKeyHierarchy.id
• ContentMetadataKeyHierarchy.name
• ContentMetadataKeyHierarchy.hierarchyLevels

Parameters:

contentMetadataKeyHierarchies - the hierarchies to create

contentMetadataKeyHierarchies -

Returns:

the created hierarchies with their IDs filled in

Throws:

ApiException_Exception

getContentMetadataKeyHierarchiesByStatement

@RequestWrapper(localName="getContentMetadataKeyHierarchiesByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.ContentMetadataKeyHierarchyServiceInterfacegetContentMetadataKeyHierarchiesByStatement")
 @ResponseWrapper(localName="getContentMetadataKeyHierarchiesByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.ContentMetadataKeyHierarchyServiceInterfacegetContentMetadataKeyHierarchiesByStatementResponse")
ContentMetadataKeyHierarchyPage getContentMetadataKeyHierarchiesByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       throws ApiException_Exception

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

PQL Property	Object Property
id	ContentMetadataKeyHierarchy.id
name	ContentMetadataKeyHierarchy.name
status	ContentMetadataKeyHierarchy.status

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of content metadata key hierarchies

filterStatement -

Returns:

the content metadata key hierarchies that match the given filter

Throws:

ApiException - if the ID of the active network does not exist or there is a backend error

ApiException_Exception

performContentMetadataKeyHierarchyAction

@RequestWrapper(localName="performContentMetadataKeyHierarchyAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.ContentMetadataKeyHierarchyServiceInterfaceperformContentMetadataKeyHierarchyAction")
 @ResponseWrapper(localName="performContentMetadataKeyHierarchyActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.ContentMetadataKeyHierarchyServiceInterfaceperformContentMetadataKeyHierarchyActionResponse")
UpdateResult performContentMetadataKeyHierarchyAction(ContentMetadataKeyHierarchyAction contentMetadataKeyHierarchyAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     throws ApiException_Exception

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

Parameters:

contentMetadataKeyHierarchyAction - the action to perform

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

filterStatement -

contentMetadataKeyHierarchyAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateContentMetadataKeyHierarchies

@RequestWrapper(localName="updateContentMetadataKeyHierarchies",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.ContentMetadataKeyHierarchyServiceInterfaceupdateContentMetadataKeyHierarchies")
 @ResponseWrapper(localName="updateContentMetadataKeyHierarchiesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.ContentMetadataKeyHierarchyServiceInterfaceupdateContentMetadataKeyHierarchiesResponse")
List<ContentMetadataKeyHierarchy> updateContentMetadataKeyHierarchies(List<ContentMetadataKeyHierarchy> contentMetadataKeyHierarchies)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException_Exception

Updates the specified ContentMetadataKeyHierarchy objects.

Parameters:

contentMetadataKeyHierarchies - the hierarchies to update

contentMetadataKeyHierarchies -

Returns:

the updated hierarchies

Throws:

ApiException - if there is an error updating the one of the hierarchies

ApiException_Exception