Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.v201809.AdGroupAdService Class Reference

Use this service to manage ads. Available ad types are subclasses of the base Ad type and are shown in the AdGroupAd.ad documentation. Here are some of the commonly used ad types: More...

Inheritance diagram for Google.Api.Ads.AdWords.v201809.AdGroupAdService:
Google.Api.Ads.AdWords.v201809.IAdGroupAdService Google.Api.Ads.AdWords.v201809.AdGroupAdServiceInterface

Public Member Functions

 AdGroupAdService ()
 Creates a new instance of the AdGroupAdService class. More...
 
 AdGroupAdService (string endpointConfigurationName)
 Creates a new instance of the AdGroupAdService class. More...
 
 AdGroupAdService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the AdGroupAdService class. More...
 
 AdGroupAdService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the AdGroupAdService class. More...
 
 AdGroupAdService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the AdGroupAdService class. More...
 
virtual
Google.Api.Ads.AdWords.v201809.AdGroupAdPage 
get (Google.Api.Ads.AdWords.v201809.Selector serviceSelector)
 Returns a list of AdGroupAds. AdGroupAds that had been removed are not returned by default. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.AdGroupAdPage
getAsync (Google.Api.Ads.AdWords.v201809.Selector serviceSelector)
 
virtual
Google.Api.Ads.AdWords.v201809.AdGroupAdReturnValue 
mutate (Google.Api.Ads.AdWords.v201809.AdGroupAdOperation[] operations)
 Applies the list of mutate operations (ie. add, set, remove): More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.AdGroupAdReturnValue
mutateAsync (Google.Api.Ads.AdWords.v201809.AdGroupAdOperation[] operations)
 
virtual
Google.Api.Ads.AdWords.v201809.AdGroupAdLabelReturnValue 
mutateLabel (Google.Api.Ads.AdWords.v201809.AdGroupAdLabelOperation[] operations)
 Adds labels to the AdGroupAd or removes labels from the AdGroupAd. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.AdGroupAdLabelReturnValue
mutateLabelAsync (Google.Api.Ads.AdWords.v201809.AdGroupAdLabelOperation[] operations)
 
virtual
Google.Api.Ads.AdWords.v201809.AdGroupAdPage 
query (string query1)
 Returns a list of AdGroupAds based on the query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.AdGroupAdPage
queryAsync (string query)
 

Detailed Description

Use this service to manage ads. Available ad types are subclasses of the base Ad type and are shown in the AdGroupAd.ad documentation. Here are some of the commonly used ad types:

Expanded Text Ad
The primary ad type used on the search network. An expanded text ad contains two headlines, a single description line, a final url, and optional path fields.
Image Ad
A standard image ad.
Template Ad (AdWords Display Ad Builder)
A flexible ad type that supports various Template Ad formats.

Constructor & Destructor Documentation

Google.Api.Ads.AdWords.v201809.AdGroupAdService.AdGroupAdService ( )
inline

Creates a new instance of the AdGroupAdService class.

Google.Api.Ads.AdWords.v201809.AdGroupAdService.AdGroupAdService ( string  endpointConfigurationName)
inline

Creates a new instance of the AdGroupAdService class.

Google.Api.Ads.AdWords.v201809.AdGroupAdService.AdGroupAdService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the AdGroupAdService class.

Google.Api.Ads.AdWords.v201809.AdGroupAdService.AdGroupAdService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the AdGroupAdService class.

Google.Api.Ads.AdWords.v201809.AdGroupAdService.AdGroupAdService ( System.ServiceModel.Channels.Binding  binding,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the AdGroupAdService class.

Member Function Documentation

virtual Google.Api.Ads.AdWords.v201809.AdGroupAdPage Google.Api.Ads.AdWords.v201809.AdGroupAdService.get ( Google.Api.Ads.AdWords.v201809.Selector  serviceSelector)
inlinevirtual

Returns a list of AdGroupAds. AdGroupAds that had been removed are not returned by default.

Parameters
serviceSelectorThe selector specifying the AdGroupAds to return.
Returns
The page containing the AdGroupAds that meet the criteria specified by the selector.
Exceptions
AdWordsApiExceptionwhen there is at least one error with the request.

Implements Google.Api.Ads.AdWords.v201809.AdGroupAdServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.AdGroupAdPage> Google.Api.Ads.AdWords.v201809.AdGroupAdService.getAsync ( Google.Api.Ads.AdWords.v201809.Selector  serviceSelector)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.AdGroupAdReturnValue Google.Api.Ads.AdWords.v201809.AdGroupAdService.mutate ( Google.Api.Ads.AdWords.v201809.AdGroupAdOperation[]  operations)
inlinevirtual

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 remove the old one.

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

Parameters
operationsThe 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 removed from the AdGroup.

Implements Google.Api.Ads.AdWords.v201809.IAdGroupAdService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.AdGroupAdReturnValue> Google.Api.Ads.AdWords.v201809.AdGroupAdService.mutateAsync ( Google.Api.Ads.AdWords.v201809.AdGroupAdOperation[]  operations)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.AdGroupAdLabelReturnValue Google.Api.Ads.AdWords.v201809.AdGroupAdService.mutateLabel ( Google.Api.Ads.AdWords.v201809.AdGroupAdLabelOperation[]  operations)
inlinevirtual

Adds labels to the AdGroupAd or removes labels from the AdGroupAd.

Add - Apply an existing label to an existing ad group ad. The adGroupId and adId must reference an existing ad group ad. The labelId must reference an existing label.

Remove - Removes the link between the specified ad group ad and label.

Parameters
operationsThe operations to apply.
Returns
A list of AdGroupAdLabel where each entry in the list is the result of applying the operation in the input list with the same index. For an add operation, the returned AdGroupAdLabel contains the AdGroupId, AdId and the LabelId. In the case of a remove operation, the returned AdGroupAdLabel will only have AdGroupId and AdId.
Exceptions
AdWordsApiExceptionwhen there are one or more errors with the request.

Implements Google.Api.Ads.AdWords.v201809.IAdGroupAdService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.AdGroupAdLabelReturnValue> Google.Api.Ads.AdWords.v201809.AdGroupAdService.mutateLabelAsync ( Google.Api.Ads.AdWords.v201809.AdGroupAdLabelOperation[]  operations)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.AdGroupAdPage Google.Api.Ads.AdWords.v201809.AdGroupAdService.query ( string  query1)
inlinevirtual

Returns a list of AdGroupAds based on the query.

Parameters
query1The SQL-like AWQL query string.
Returns
A list of AdGroupAds.
Exceptions
AdWordsApiExceptionif problems occur while parsing the query or fetching AdGroupAds.

Implements Google.Api.Ads.AdWords.v201809.AdGroupAdServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.AdGroupAdPage> Google.Api.Ads.AdWords.v201809.AdGroupAdService.queryAsync ( string  query)
inlinevirtual

The documentation for this class was generated from the following file: