com.google.api.ads.admanager.jaxws.v202311.ActivityGroupServiceInterface Maven / Gradle / Ivy
Show all versions of dfp-appengine Show documentation
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.api.ads.admanager.jaxws.v202311;
import java.util.List;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;
/**
*
* As of February 22, 2024 this service will become read only as part of Spotlight deprecation, learn more..
*
* Provides methods for creating, updating and retrieving {@link ActivityGroup} objects.
*
*
An activity group contains {@link Activity} objects. Activities have a many-to-one
* relationship with activity groups, meaning each activity can belong to only one activity group,
* but activity groups can have multiple activities. An activity group can be used to manage the
* activities it contains.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.3.0.2
* Generated source version: 2.1
*
*/
@WebService(name = "ActivityGroupServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@XmlSeeAlso({
ObjectFactory.class
})
public interface ActivityGroupServiceInterface {
/**
*
* Creates a new {@link ActivityGroup} objects.
*
*
* @param activityGroups
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@RequestWrapper(localName = "createActivityGroups", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.ActivityGroupServiceInterfacecreateActivityGroups")
@ResponseWrapper(localName = "createActivityGroupsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.ActivityGroupServiceInterfacecreateActivityGroupsResponse")
public List createActivityGroups(
@WebParam(name = "activityGroups", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
List activityGroups)
throws ApiException_Exception
;
/**
*
* Gets an {@link ActivityGroupPage} of {@link ActivityGroup} objects that satisfy the given
* {@link Statement#query}. The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code id}
* {@link ActivityGroup#id}
*
*
* {@code name}
* {@link ActivityGroup#name}
*
*
* {@code impressionsLookback}
* {@link ActivityGroup#impressionsLookback}
*
*
* {@code clicksLookback}
* {@link ActivityGroup#clicksLookback}
*
*
* {@code status}
* {@link ActivityGroup#status}
*
*
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202311.ActivityGroupPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@RequestWrapper(localName = "getActivityGroupsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.ActivityGroupServiceInterfacegetActivityGroupsByStatement")
@ResponseWrapper(localName = "getActivityGroupsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.ActivityGroupServiceInterfacegetActivityGroupsByStatementResponse")
public ActivityGroupPage getActivityGroupsByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link ActivityGroup} objects.
*
*
* @param activityGroups
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
@RequestWrapper(localName = "updateActivityGroups", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.ActivityGroupServiceInterfaceupdateActivityGroups")
@ResponseWrapper(localName = "updateActivityGroupsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311", className = "com.google.api.ads.admanager.jaxws.v202311.ActivityGroupServiceInterfaceupdateActivityGroupsResponse")
public List updateActivityGroups(
@WebParam(name = "activityGroups", targetNamespace = "https://www.google.com/apis/ads/publisher/v202311")
List activityGroups)
throws ApiException_Exception
;
}