com.google.api.ads.adwords.v201109.cm
Interface AdGroupAdServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

AdGroupAdServiceSoapBindingStub

public interface AdGroupAdServiceInterface
extends Remote

Method Summary

AdGroupAdPage	get(Selector serviceSelector) Returns a list of AdGroupAds.
AdGroupAdReturnValue	mutate(AdGroupAdOperation[] operations) Applies the list of mutate operations (ie.

Method Detail

get

AdGroupAdPage get(Selector serviceSelector)
                  throws RemoteException,
                         ApiException

Returns a list of AdGroupAds.

Parameters:

serviceSelector - the selector specifying the AdGroupAds to return.

Returns:

the page containing the AdGroupAds that meet the criteria specified by the selector.

Throws:

ApiException - when there is at least one error with the request.

RemoteException

mutate

AdGroupAdReturnValue mutate(AdGroupAdOperation[] operations)
                            throws RemoteException,
                                   ApiException

Applies the list of mutate operations (ie. add, set, remove):

Add - Creates a new ad group ad. The adGroupId must reference an existing ad group. The child Ad must be sufficiently specified by constructing a concrete ad type (such as TextAd) and setting its fields accordingly.

Set - Updates an ad group ad. Except for status, ad group ad fields are not mutable. Status updates are straightforward - the status of the ad group ad is updated as specified. If any other field has changed, it will be ignored. If you want to change any of the fields other than status, you must make a new ad and then delete the old one.

Remove - Removes the link between the specified AdGroup and Ad.

Parameters:

operations - the operations to apply

Returns:

a list of AdGroupAds where each entry in the list is the result of applying the operation in the input list with the same index. For an add/set operation, the return AdGroupAd will be what is saved to the db. In the case, of the remove operation, the return AdGroupAd will simply be an AdGroupAd containing an Ad with the id set to the Ad being deleted from the AdGroup.

Throws:

RemoteException

ApiException