ManagedCustomerService (v201809)

Customer Manager Service.

Production WSDL


                  https://adwords.google.com/api/adwords/mcm/v201809/ManagedCustomerService?wsdl

Namespace

https://adwords.google.com/api/adwords/mcm/v201809

Operations

get
getPendingInvitations
mutate
mutateLabel
mutateLink
mutateManager

Errors

AuthenticationError
AuthorizationError
ClientTermsError
DatabaseError
DateError
DistinctError
IdError
InternalApiError
ManagedCustomerServiceError
NotEmptyError
NullError
OperationAccessDenied
OperatorError
QuotaCheckError
RangeError
RateExceededError
ReadOnlyError
RejectedError
RequestError
RequiredError
SelectorError
SizeLimitError
StringFormatError
StringLengthError

get

Returns the list of customers that meet the selector criteria.

Parameters

Field	Type	Description
`serviceSelector`	`cm:Selector`

Response

Field	Type	Description
`rval`	`ManagedCustomerPage`	List of customers identified by the selector.

getPendingInvitations

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

Parameters

Field	Type	Description
`selector`	`PendingInvitationSelector`	the manager customer ids (inviters) or the client customer ids (invitees)

Response

Field	Type	Description
`rval`	`PendingInvitation[]`

mutate

Modifies or creates new ManagedCustomers.

Note: See ManagedCustomerOperation for available operators.

Parameters

Field	Type	Description
`operations`	`ManagedCustomerOperation[]`	List of unique operations.

Response

Field	Type	Description
`rval`	`ManagedCustomerReturnValue`	The list of updated managed customers, returned in the same order as the `operations` array.

mutateLabel

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.

Parameters

Field	Type	Description
`operations`	`ManagedCustomerLabelOperation[]`

Response

Field	Type	Description
`rval`	`ManagedCustomerLabelReturnV...`

mutateLink

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

Field	Type	Description
`operations`	`LinkOperation[]`	the list of operations

Response

Field	Type	Description
`rval`	`MutateLinkResults`	results for the given operations

mutateManager

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

Field	Type	Description
`operations`	`MoveOperation[]`	List of unique operations.

Response

Field	Type	Description
`rval`	`MutateManagerResults`	results for the given operations

Errors

Error	Reasons
`AuthenticationError`	Errors returned when Authentication failed. Enumerations `AUTHENTICATION_FAILED` Authentication of the request failed. `CLIENT_CUSTOMER_ID_IS_REQUIRED` Client Customer Id is required if CustomerIdMode is set to CLIENT_EXTERNAL_CUSTOMER_ID. Starting version V201409 ClientCustomerId will be required for all requests except for CustomerService.get `CLIENT_EMAIL_REQUIRED` Client Email is required if CustomerIdMode is set to CLIENT_EXTERNAL_EMAIL_FIELD. `CLIENT_CUSTOMER_ID_INVALID` Client customer Id is not a number. `CLIENT_EMAIL_INVALID` Client customer Id is not a number. `CLIENT_EMAIL_FAILED_TO_AUTHENTICATE` Client email is not a valid customer email. `CUSTOMER_NOT_FOUND` No customer found for the customer id provided in the header. `GOOGLE_ACCOUNT_DELETED` Client's Google Account is deleted. `GOOGLE_ACCOUNT_COOKIE_INVALID` Google account login token in the cookie is invalid. `FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT` problem occurred during Google account authentication. `GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH` The user in the google account login token does not match the UserId in the cookie. `LOGIN_COOKIE_REQUIRED` Login cookie is required for authentication. `NOT_ADS_USER` User in the cookie is not a valid Ads user. `OAUTH_TOKEN_INVALID` Oauth token in the header is not valid. `OAUTH_TOKEN_EXPIRED` Oauth token in the header has expired. `OAUTH_TOKEN_DISABLED` Oauth token in the header has been disabled. `OAUTH_TOKEN_REVOKED` Oauth token in the header has been revoked. `OAUTH_TOKEN_HEADER_INVALID` Oauth token HTTP header is malformed. `LOGIN_COOKIE_INVALID` Login cookie is not valid. `FAILED_TO_RETRIEVE_LOGIN_COOKIE` Failed to decrypt the login cookie. `USER_ID_INVALID` User Id in the header is not a valid id.
`AuthorizationError`	Errors encountered when trying to authorize a user. Enumerations `UNABLE_TO_AUTHORIZE` Could not complete authorization due to an internal problem. `NO_ADWORDS_ACCOUNT_FOR_CUSTOMER` Customer has no AdWords account. `USER_PERMISSION_DENIED` User doesn't have permission to access customer. `EFFECTIVE_USER_PERMISSION_DENIED` Effective user doesn't have permission to access this customer. `CUSTOMER_NOT_ACTIVE` Access denied since the customer is not active. `USER_HAS_READONLY_PERMISSION` User has read-only permission cannot mutate. `NO_CUSTOMER_FOUND` No customer found. `SERVICE_ACCESS_DENIED` Developer doesn't have permission to access service. `TWO_STEP_VERIFICATION_NOT_ENROLLED` The customer has a policy to enforce 2-Step Verification, but the user is not enrolled. `ADVANCED_PROTECTION_NOT_ENROLLED` The customer has a policy to enforce enrollment in the Advanced Protection Program, but the user is not enrolled.
`ClientTermsError`	Error due to user not accepting the AdWords terms of service. Enumerations `INCOMPLETE_SIGNUP_CURRENT_ADWORDS_TNC_NOT_AGREED` Customer has not agreed to the latest AdWords Terms & Conditions
`DatabaseError`	Errors that are thrown due to a database access problem. Enumerations `CONCURRENT_MODIFICATION` A concurrency problem occurred as two threads were attempting to modify same object. `PERMISSION_DENIED` The permission was denied to access an object. `ACCESS_PROHIBITED` The user's access to an object has been prohibited. `CAMPAIGN_PRODUCT_NOT_SUPPORTED` Requested campaign belongs to a product that is not supported by the api. `DUPLICATE_KEY` a duplicate key was detected upon insertion `DATABASE_ERROR` a database error has occurred `UNKNOWN` an unknown error has occurred
`DateError`	Errors associated with invalid dates and date ranges. Enumerations `INVALID_FIELD_VALUES_IN_DATE` Given field values do not correspond to a valid date. `INVALID_FIELD_VALUES_IN_DATE_TIME` Given field values do not correspond to a valid date time. `INVALID_STRING_DATE` The string date's format should be yyyymmdd. `INVALID_STRING_DATE_RANGE` The string date range's format should be yyyymmdd yyyymmdd. `INVALID_STRING_DATE_TIME` The string date time's format should be yyyymmdd hhmmss [tz]. `EARLIER_THAN_MINIMUM_DATE` Date is before allowed minimum. `LATER_THAN_MAXIMUM_DATE` Date is after allowed maximum. `DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE` Date range bounds are not in order. `DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL` Both dates in range are null.
`DistinctError`	Errors related to distinct ids or content. Enumerations `DUPLICATE_ELEMENT` `DUPLICATE_TYPE`
`IdError`	Errors associated with the ids. Enumerations `NOT_FOUND` Id not found
`InternalApiError`	Indicates that a server-side error has occured. `InternalApiError`s are generally not the result of an invalid request or message sent by the client. Enumerations `UNEXPECTED_INTERNAL_API_ERROR` API encountered an unexpected internal error. `TRANSIENT_ERROR` A temporary error occurred during the request. Please retry. `UNKNOWN` The cause of the error is not known or only defined in newer versions. `DOWNTIME` The API is currently unavailable for a planned downtime. `ERROR_GENERATING_RESPONSE` Mutate succeeded but server was unable to build response. Client should not retry mutate.
`ManagedCustomerServiceError`	Error for ManagedCustomerService Enumerations `UNKNOWN` Unknown. `NOT_AUTHORIZED` The user is not authorized to perform the action. `INVALID_SELECTOR` Invalid selector `INVALID_TIMEZONE` Can't process the passed in timezone. `INVALID_CURRENCY` Can't process the passed in currency code. `INVALID_DESCRIPTIVE_NAME` Can't process the passed in descriptive name. `ADD_CUSTOMER_FAILURE` Generic error during add customer process. `SAVE_CUSTOMERS_FAILURE` There was a problem saving the modified customers, and some of the customers may not have been saved successfully. `ALREADY_MANAGED_BY_THIS_MANAGER` Attempt to establish a link with a client that is already managed by the manager. `ALREADY_INVITED_BY_THIS_MANAGER` Attempt to invite a client that has already been invited by the manager. `ALREADY_MANAGED_IN_HIERARCHY` Already managed by some other manager in the hierarchy. `ALREADY_MANAGED_FOR_UI_ACCESS` Client is managed by another manager for UI access already. `MAX_LINK_DEPTH_EXCEEDED` Attempt to exceed the maximum hierarchy depth. `NO_PENDING_INVITATION` Attempt to accept an invitation that doesn't exist. `TOO_MANY_ACCOUNTS` Manager account has the maximum number of linked accounts. `TOO_MANY_ACCOUNTS_AT_MANAGER` Your manager's account has the maximum number of linked accounts. `TOO_MANY_UI_API_MANAGERS` The invitee has already linked with max allowed number of UI and API managers. `TEST_ACCOUNT_LINK_ERROR` Error involving test accounts (mixed types) or too many child accounts. `INVALID_LABEL_ID` Label id was not found, or is not owned by the requesting customer. `CANNOT_APPLY_INACTIVE_LABEL` Deleted labels cannot be applied to customers. `APPLIED_LABEL_TO_TOO_MANY_ACCOUNTS` A label cannot be applied to more than 1000 customers.
`NotEmptyError`	Errors corresponding with violation of a NOT EMPTY check. Enumerations `EMPTY_LIST`
`NullError`	Errors associated with violation of a NOT NULL check. Enumerations `NULL_CONTENT` Specified list/container must not contain any null elements
`OperationAccessDenied`	Operation not permitted due to the invoked service's access policy. Enumerations `ACTION_NOT_PERMITTED` Unauthorized invocation of a service's method (get, mutate, etc.) `ADD_OPERATION_NOT_PERMITTED` Unauthorized ADD operation in invoking a service's mutate method. `REMOVE_OPERATION_NOT_PERMITTED` Unauthorized REMOVE operation in invoking a service's mutate method. `SET_OPERATION_NOT_PERMITTED` Unauthorized SET operation in invoking a service's mutate method. `MUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT` A mutate action is not allowed on this campaign, from this client. `OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE` This operation is not permitted on this campaign type `ADD_AS_REMOVED_NOT_PERMITTED` An ADD operation may not set status to REMOVED. `OPERATION_NOT_PERMITTED_FOR_REMOVED_ENTITY` This operation is not allowed because the campaign or adgroup is removed. `OPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE` This operation is not permitted on this ad group type. `UNKNOWN` The reason the invoked method or operation is prohibited is not known (the client may be of an older version than the server).
`OperatorError`	Errors due to the use of unsupported operations. Enumerations `OPERATOR_NOT_SUPPORTED`
`QuotaCheckError`	Encapsulates the errors thrown during developer quota checks. Enumerations `INVALID_TOKEN_HEADER` Customer passed in an invalid token in the header. `ACCOUNT_DELINQUENT` Customer is marked delinquent. `ACCOUNT_INACCESSIBLE` Customer is a fraudulent. `ACCOUNT_INACTIVE` Inactive Account. `INCOMPLETE_SIGNUP` Signup not complete `DEVELOPER_TOKEN_NOT_APPROVED` Developer token is not approved for production access, and the customer is attempting to access a production account. `TERMS_AND_CONDITIONS_NOT_SIGNED` Terms and conditions are not signed. `MONTHLY_BUDGET_REACHED` Monthly budget quota reached. `QUOTA_EXCEEDED` Monthly budget quota exceeded.
`RangeError`	A list of all errors associated with the Range constraint. Enumerations `TOO_LOW` `TOO_HIGH`
`RateExceededError`	Signals that a call failed because a measured rate exceeded. Enumerations `RATE_EXCEEDED` Rate exceeded.
`ReadOnlyError`	Errors from attempting to write to read-only fields. Enumerations `READ_ONLY`
`RejectedError`	Indicates that a field was rejected due to compatibility issues. Enumerations `UNKNOWN_VALUE` Unknown value encountered
`RequestError`	Encapsulates the generic errors thrown when there's an error with user request. Enumerations `UNKNOWN` Error reason is unknown. `INVALID_INPUT` Invalid input. `UNSUPPORTED_VERSION` The api version in the request has been discontinued. Please update to the new AdWords API version.
`RequiredError`	Errors due to missing required field. Enumerations `REQUIRED` Missing required field.
`SelectorError`	Represents possible error codes for Selector. Enumerations `INVALID_FIELD_NAME` The field name is not valid. `MISSING_FIELDS` The list of fields is null or empty. `MISSING_PREDICATES` The list of predicates is null or empty. `OPERATOR_DOES_NOT_SUPPORT_MULTIPLE_VALUES` Predicate operator does not support multiple values. Multiple values are supported only for Predicate.Operator.IN and Predicate.Operator.NOT_IN. `INVALID_PREDICATE_ENUM_VALUE` The predicate enum value is not valid. `MISSING_PREDICATE_OPERATOR` The predicate operator is empty. `MISSING_PREDICATE_VALUES` The predicate values are empty. `INVALID_PREDICATE_FIELD_NAME` The predicate field name is not valid. `INVALID_PREDICATE_OPERATOR` The predicate operator is not valid. `INVALID_FIELD_SELECTION` Invalid selection of fields. `INVALID_PREDICATE_VALUE` The predicate value is not valid. `INVALID_SORT_FIELD_NAME` The sort field name is not valid or the field is not sortable. `SELECTOR_ERROR` Standard error. `FILTER_BY_DATE_RANGE_NOT_SUPPORTED` Filtering by date range is not supported. `START_INDEX_IS_TOO_HIGH` Selector paging start index is too high. `TOO_MANY_PREDICATE_VALUES` The values list in a predicate was too long. `UNKNOWN_ERROR`
`SizeLimitError`	Indicates that the number of entries in the request or response exceeds the system limit. Enumerations `REQUEST_SIZE_LIMIT_EXCEEDED` The number of entries in the request exceeds the system limit. `RESPONSE_SIZE_LIMIT_EXCEEDED` The number of entries in the response exceeds the system limit. `INTERNAL_STORAGE_ERROR` The account is too large to load. `UNKNOWN`
`StringFormatError`	A list of error code for reporting invalid content of input strings. Enumerations `UNKNOWN` `ILLEGAL_CHARS` The input string value contains disallowed characters. `INVALID_FORMAT` The input string value is invalid for the associated field.
`StringLengthError`	Errors associated with the length of the given string being out of bounds. Enumerations `TOO_SHORT` `TOO_LONG`