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

Use this service to manage ad groups. An ad group organizes a set of ads and criteria together, and also provides the default bid for its criteria. One or more ad groups belong to a campaign. More...

Inheritance diagram for Google.Api.Ads.AdWords.v201809.AdGroupService:
Google.Api.Ads.AdWords.v201809.IAdGroupService Google.Api.Ads.AdWords.v201809.AdGroupServiceInterface

Public Member Functions

 AdGroupService ()
 Creates a new instance of the AdGroupService class. More...
 
 AdGroupService (string endpointConfigurationName)
 Creates a new instance of the AdGroupService class. More...
 
 AdGroupService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the AdGroupService class. More...
 
 AdGroupService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the AdGroupService class. More...
 
 AdGroupService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the AdGroupService class. More...
 
virtual
Google.Api.Ads.AdWords.v201809.AdGroupPage 
get (Google.Api.Ads.AdWords.v201809.Selector serviceSelector)
 Returns a list of all the ad groups specified by the selector from the target customer's account. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.AdGroupPage
getAsync (Google.Api.Ads.AdWords.v201809.Selector serviceSelector)
 
virtual
Google.Api.Ads.AdWords.v201809.AdGroupReturnValue 
mutate (Google.Api.Ads.AdWords.v201809.AdGroupOperation[] operations)
 Adds, updates, or removes ad groups. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.AdGroupReturnValue
mutateAsync (Google.Api.Ads.AdWords.v201809.AdGroupOperation[] operations)
 
virtual
Google.Api.Ads.AdWords.v201809.AdGroupLabelReturnValue 
mutateLabel (Google.Api.Ads.AdWords.v201809.AdGroupLabelOperation[] operations)
 Adds labels to the ad group or removes labels from the ad group. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.AdGroupLabelReturnValue
mutateLabelAsync (Google.Api.Ads.AdWords.v201809.AdGroupLabelOperation[] operations)
 
virtual
Google.Api.Ads.AdWords.v201809.AdGroupPage 
query (string query1)
 Returns the list of ad groups that match the query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.AdGroupPage
queryAsync (string query)
 

Detailed Description

Use this service to manage ad groups. An ad group organizes a set of ads and criteria together, and also provides the default bid for its criteria. One or more ad groups belong to a campaign.

Constructor & Destructor Documentation

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

Creates a new instance of the AdGroupService class.

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

Creates a new instance of the AdGroupService class.

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

Creates a new instance of the AdGroupService class.

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

Creates a new instance of the AdGroupService class.

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

Creates a new instance of the AdGroupService class.

Member Function Documentation

virtual Google.Api.Ads.AdWords.v201809.AdGroupPage Google.Api.Ads.AdWords.v201809.AdGroupService.get ( Google.Api.Ads.AdWords.v201809.Selector  serviceSelector)
inlinevirtual

Returns a list of all the ad groups specified by the selector from the target customer's account.

Parameters
serviceSelectorThe selector specifying the AdGroups to return.
Returns
List of adgroups identified by the selector.
Exceptions
AdWordsApiExceptionwhen there is at least one error with the request.

Implements Google.Api.Ads.AdWords.v201809.AdGroupServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.AdGroupPage> Google.Api.Ads.AdWords.v201809.AdGroupService.getAsync ( Google.Api.Ads.AdWords.v201809.Selector  serviceSelector)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.AdGroupReturnValue Google.Api.Ads.AdWords.v201809.AdGroupService.mutate ( Google.Api.Ads.AdWords.v201809.AdGroupOperation[]  operations)
inlinevirtual

Adds, updates, or removes ad groups.

Note: AdGroupOperation does not support the operator. To remove an ad group, set its status to REMOVED.

Parameters
operationsList of unique operations. The same ad group cannot be specified in more than one operation.
Returns
The updated adgroups.

Implements Google.Api.Ads.AdWords.v201809.IAdGroupService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.AdGroupReturnValue> Google.Api.Ads.AdWords.v201809.AdGroupService.mutateAsync ( Google.Api.Ads.AdWords.v201809.AdGroupOperation[]  operations)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.AdGroupLabelReturnValue Google.Api.Ads.AdWords.v201809.AdGroupService.mutateLabel ( Google.Api.Ads.AdWords.v201809.AdGroupLabelOperation[]  operations)
inlinevirtual

Adds labels to the ad group or removes labels from the ad group.

ADD – Apply an existing label to an existing ad group. The adGroupId must reference an existing ad group. The labelId must reference an existing label.

REMOVE – Removes the link between the specified ad group and a label.

Parameters
operationsthe operations to apply.
Returns
a list of AdGroupLabels 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 AdGroupLabel contains the AdGroupId and the LabelId. In the case of a remove operation, the returned AdGroupLabel will only have AdGroupId.
Exceptions
AdWordsApiExceptionwhen there are one or more errors with the request.

Implements Google.Api.Ads.AdWords.v201809.IAdGroupService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.AdGroupLabelReturnValue> Google.Api.Ads.AdWords.v201809.AdGroupService.mutateLabelAsync ( Google.Api.Ads.AdWords.v201809.AdGroupLabelOperation[]  operations)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.AdGroupPage Google.Api.Ads.AdWords.v201809.AdGroupService.query ( string  query1)
inlinevirtual

Returns the list of ad groups that match the query.

Parameters
query1The SQL-like AWQL query string
Returns
A list of adgroups

AdWordsApiException

Implements Google.Api.Ads.AdWords.v201809.AdGroupServiceInterface.

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

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