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

Customer Manager Service. More...

Inheritance diagram for Google.Api.Ads.AdWords.v201809.ManagedCustomerService:
Google.Api.Ads.AdWords.v201809.IManagedCustomerService Google.Api.Ads.AdWords.v201809.ManagedCustomerServiceInterface

Public Member Functions

 ManagedCustomerService ()
 Creates a new instance of the ManagedCustomerService class. More...
 
 ManagedCustomerService (string endpointConfigurationName)
 Creates a new instance of the ManagedCustomerService class. More...
 
 ManagedCustomerService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the ManagedCustomerService class. More...
 
 ManagedCustomerService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the ManagedCustomerService class. More...
 
 ManagedCustomerService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the ManagedCustomerService class. More...
 
virtual
Google.Api.Ads.AdWords.v201809.ManagedCustomerPage 
get (Google.Api.Ads.AdWords.v201809.Selector serviceSelector)
 Returns the list of customers that meet the selector criteria. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.ManagedCustomerPage
getAsync (Google.Api.Ads.AdWords.v201809.Selector serviceSelector)
 
virtual
Google.Api.Ads.AdWords.v201809.PendingInvitation[] 
getPendingInvitations (Google.Api.Ads.AdWords.v201809.PendingInvitationSelector selector)
 Returns the pending invitations for the customer IDs in the selector. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.PendingInvitation[]> 
getPendingInvitationsAsync (Google.Api.Ads.AdWords.v201809.PendingInvitationSelector selector)
 
virtual
Google.Api.Ads.AdWords.v201809.ManagedCustomerReturnValue 
mutate (Google.Api.Ads.AdWords.v201809.ManagedCustomerOperation[] operations)
 Modifies or creates new ManagedCustomers. Note: See ManagedCustomerOperation for available operators. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.ManagedCustomerReturnValue
mutateAsync (Google.Api.Ads.AdWords.v201809.ManagedCustomerOperation[] operations)
 
virtual
Google.Api.Ads.AdWords.v201809.ManagedCustomerLabel[] 
mutateLabel (Google.Api.Ads.AdWords.v201809.ManagedCustomerLabelOperation[] operations)
 Adds AccountLabels to, and removes AccountLabels from, ManagedCustomers. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.ManagedCustomerLabel[]> 
mutateLabelAsync (Google.Api.Ads.AdWords.v201809.ManagedCustomerLabelOperation[] operations)
 
virtual
Google.Api.Ads.AdWords.v201809.ManagedCustomerLink[] 
mutateLink (Google.Api.Ads.AdWords.v201809.LinkOperation[] operations)
 Modifies the ManagedCustomer forest. These actions are possible (categorized by Operator + Link Status): More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.ManagedCustomerLink[]> 
mutateLinkAsync (Google.Api.Ads.AdWords.v201809.LinkOperation[] operations)
 
virtual
Google.Api.Ads.AdWords.v201809.ManagedCustomerLink[] 
mutateManager (Google.Api.Ads.AdWords.v201809.MoveOperation[] operations)
 Moves client customers to new managers (moving links). Only the following action is possible: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.ManagedCustomerLink[]> 
mutateManagerAsync (Google.Api.Ads.AdWords.v201809.MoveOperation[] operations)
 

Detailed Description

Customer Manager Service.

Constructor & Destructor Documentation

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

Creates a new instance of the ManagedCustomerService class.

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

Creates a new instance of the ManagedCustomerService class.

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

Creates a new instance of the ManagedCustomerService class.

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

Creates a new instance of the ManagedCustomerService class.

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

Creates a new instance of the ManagedCustomerService class.

Member Function Documentation

virtual Google.Api.Ads.AdWords.v201809.ManagedCustomerPage Google.Api.Ads.AdWords.v201809.ManagedCustomerService.get ( Google.Api.Ads.AdWords.v201809.Selector  serviceSelector)
inlinevirtual

Returns the list of customers that meet the selector criteria.

Parameters
serviceSelectorThe selector specifying the ManagedCustomers to return.
Returns
List of customers identified by the selector.
Exceptions
AdWordsApiExceptionWhen there is at least one error with the request.

Implements Google.Api.Ads.AdWords.v201809.ManagedCustomerServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.ManagedCustomerPage> Google.Api.Ads.AdWords.v201809.ManagedCustomerService.getAsync ( Google.Api.Ads.AdWords.v201809.Selector  serviceSelector)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.PendingInvitation [] Google.Api.Ads.AdWords.v201809.ManagedCustomerService.getPendingInvitations ( Google.Api.Ads.AdWords.v201809.PendingInvitationSelector  selector)
inlinevirtual

Returns the pending invitations for the customer IDs in the selector.

Parameters
selectorthe manager customer ids (inviters) or the client customer ids (invitees)
Exceptions
AdWordsApiExceptionwhen there is at least one error with the request

Implements Google.Api.Ads.AdWords.v201809.IManagedCustomerService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.PendingInvitation[]> Google.Api.Ads.AdWords.v201809.ManagedCustomerService.getPendingInvitationsAsync ( Google.Api.Ads.AdWords.v201809.PendingInvitationSelector  selector)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.ManagedCustomerReturnValue Google.Api.Ads.AdWords.v201809.ManagedCustomerService.mutate ( Google.Api.Ads.AdWords.v201809.ManagedCustomerOperation[]  operations)
inlinevirtual

Modifies or creates new ManagedCustomers. Note: See ManagedCustomerOperation for available operators.

Parameters
operationsList of unique operations.
Returns
The list of updated managed customers, returned in the same order as the operations array.

Implements Google.Api.Ads.AdWords.v201809.IManagedCustomerService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.ManagedCustomerReturnValue> Google.Api.Ads.AdWords.v201809.ManagedCustomerService.mutateAsync ( Google.Api.Ads.AdWords.v201809.ManagedCustomerOperation[]  operations)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.ManagedCustomerLabel [] Google.Api.Ads.AdWords.v201809.ManagedCustomerService.mutateLabel ( Google.Api.Ads.AdWords.v201809.ManagedCustomerLabelOperation[]  operations)
inlinevirtual

Adds AccountLabels to, and removes AccountLabels from, ManagedCustomers.

To add an AccountLabel to a ManagedCustomer, use Operator::ADD. To remove an AccountLabel from a ManagedCustomer, use Operator::REMOVE.

The label must already exist (see AccountLabelService::mutate for how to create them) and be owned by the authenticated user.

The ManagedCustomer must already exist and be managed by the customer making the request (either directly or indirectly).

An AccountLabel may be applied to at most 1000 customers.

This method does not support partial failures, and will fail if any operation is invalid.

Implements Google.Api.Ads.AdWords.v201809.IManagedCustomerService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.ManagedCustomerLabel[]> Google.Api.Ads.AdWords.v201809.ManagedCustomerService.mutateLabelAsync ( Google.Api.Ads.AdWords.v201809.ManagedCustomerLabelOperation[]  operations)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.ManagedCustomerLink [] Google.Api.Ads.AdWords.v201809.ManagedCustomerService.mutateLink ( Google.Api.Ads.AdWords.v201809.LinkOperation[]  operations)
inlinevirtual

Modifies the ManagedCustomer forest. These actions are possible (categorized by Operator + Link Status):

  • ADD + PENDING: manager extends invitations
  • SET + CANCELLED: manager rescinds invitations
  • SET
    • INACTIVE: manager/client terminates links
  • SET + ACTIVE: client accepts invitations
  • SET + REFUSED: client declines invitations

In addition to these, active links can also be marked hidden / unhidden.

  • An ACTIVE link can be marked hidden with SET + ACTIVE along with setting the isHidden bit to true.
  • An ACTIVE link can be marked unhidden with SET + ACTIVE along with setting the isHidden bit to false.
Parameters
operationsthe list of operations
Returns
results for the given operations
Exceptions
AdWordsApiExceptionwith a ManagedCustomerServiceError

Implements Google.Api.Ads.AdWords.v201809.IManagedCustomerService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.ManagedCustomerLink[]> Google.Api.Ads.AdWords.v201809.ManagedCustomerService.mutateLinkAsync ( Google.Api.Ads.AdWords.v201809.LinkOperation[]  operations)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.ManagedCustomerLink [] Google.Api.Ads.AdWords.v201809.ManagedCustomerService.mutateManager ( Google.Api.Ads.AdWords.v201809.MoveOperation[]  operations)
inlinevirtual

Moves client customers to new managers (moving links). Only the following action is possible:

  • SET + ACTIVE: manager moves client customers to new managers within the same manager account hierarchy
Parameters
operationsList of unique operations.
Returns
results for the given operations
Exceptions
AdWordsApiExceptionwith a ManagedCustomerServiceError

Implements Google.Api.Ads.AdWords.v201809.IManagedCustomerService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.ManagedCustomerLink[]> Google.Api.Ads.AdWords.v201809.ManagedCustomerService.mutateManagerAsync ( Google.Api.Ads.AdWords.v201809.MoveOperation[]  operations)
inlinevirtual

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