NAME
Google::Ads::AdWords::v201802::ManagedCustomerService::ManagedCustomerServiceInterfacePort - SOAP Interface for the ManagedCustomerService Web Service
SYNOPSIS
use Google::Ads::AdWords::v201802::ManagedCustomerService::ManagedCustomerServiceInterfacePort;
my $interface = Google::Ads::AdWords::v201802::ManagedCustomerService::ManagedCustomerServiceInterfacePort->new();
my $response;
$response = $interface->get();
$response = $interface->getPendingInvitations();
$response = $interface->mutate();
$response = $interface->mutateLabel();
$response = $interface->mutateLink();
$response = $interface->mutateManager();DESCRIPTION
SOAP Interface for the ManagedCustomerService web service located at https://adwords.google.com/api/adwords/mcm/v201802/ManagedCustomerService.
SERVICE ManagedCustomerService
Port ManagedCustomerServiceInterfacePort
METHODS
General methods
new
Constructor.
All arguments are forwarded to SOAP::WSDL::Client.
SOAP Service methods
Method synopsis is displayed with hash refs as parameters.
The commented class names in the method's parameters denote that objects of the corresponding class can be passed instead of the marked hash ref.
You may pass any combination of objects, hash and list refs to these methods, as long as you meet the structure.
List items (i.e. multiple occurences) are not displayed in the synopsis. You may generally pass a list ref of hash refs (or objects) instead of a hash ref - this may result in invalid XML if used improperly, though. Note that SOAP::WSDL always expects list references at maximum depth position.
XML attributes are not displayed in this synopsis and cannot be set using hash refs. See the respective class' documentation for additional information.
get
Returns the list of customers that meet the selector criteria. @param selector The selector specifying the {@link ManagedCustomer}s to return. @return List of customers identified by the selector. @throws ApiException When there is at least one error with the request.
Returns a Google::Ads::AdWords::v201802::ManagedCustomerService::getResponse object.
$response = $interface->get( {
serviceSelector => $a_reference_to, # see Google::Ads::AdWords::v201802::Selector
},,
);getPendingInvitations
Returns the pending invitations for the customer IDs in the selector. @param selector the manager customer ids (inviters) or the client customer ids (invitees) @throws ApiException when there is at least one error with the request
Returns a Google::Ads::AdWords::v201802::ManagedCustomerService::getPendingInvitationsResponse object.
$response = $interface->getPendingInvitations( {
selector => $a_reference_to, # see Google::Ads::AdWords::v201802::PendingInvitationSelector
},,
);mutate
Modifies or creates new {@link ManagedCustomer}s. <p class="note"><b>Note:</b> See {@link ManagedCustomerOperation} for available operators.</p> @param operations List of unique operations. @return The list of updated managed customers, returned in the same order as the <code>operations</code> array.
Returns a Google::Ads::AdWords::v201802::ManagedCustomerService::mutateResponse object.
$response = $interface->mutate( {
operations => $a_reference_to, # see Google::Ads::AdWords::v201802::ManagedCustomerOperation
},,
);mutateLabel
Adds {@linkplain AccountLabel}s to, and removes {@linkplain AccountLabel}s from, {@linkplain ManagedCustomer}s. <p>To add an {@linkplain AccountLabel} to a {@linkplain ManagedCustomer}, use {@link Operator#ADD}. To remove an {@linkplain AccountLabel} from a {@linkplain ManagedCustomer}, use {@link Operator#REMOVE}.</p> <p>The label must already exist (see {@link AccountLabelService#mutate} for how to create them) and be owned by the authenticated user.</p> <p>The {@linkplain ManagedCustomer} must already exist and be managed by the customer making the request (either directly or indirectly).</p> <p>An AccountLabel may be applied to at most 1000 customers.</p> <p>This method does not support partial failures, and will fail if any operation is invalid.</p>
Returns a Google::Ads::AdWords::v201802::ManagedCustomerService::mutateLabelResponse object.
$response = $interface->mutateLabel( {
operations => $a_reference_to, # see Google::Ads::AdWords::v201802::ManagedCustomerLabelOperation
},,
);mutateLink
Modifies the ManagedCustomer forest. These actions are possible (categorized by Operator + Link Status): <ul> <li>ADD + PENDING: manager extends invitations</li> <li>SET + CANCELLED: manager rescinds invitations</li> <li>SET + INACTIVE: manager/client terminates links</li> <li>SET + ACTIVE: client accepts invitations</li> <li>SET + REFUSED: client declines invitations</li> </ul> In addition to these, active links can also be marked hidden / unhidden. <ul> <li> An ACTIVE link can be marked hidden with SET + ACTIVE along with setting the isHidden bit to true. </li> <li> An ACTIVE link can be marked unhidden with SET + ACTIVE along with setting the isHidden bit to false. </li> </ul> @param operations the list of operations @return results for the given operations @throws ApiException with a {@link ManagedCustomerServiceError}
Returns a Google::Ads::AdWords::v201802::ManagedCustomerService::mutateLinkResponse object.
$response = $interface->mutateLink( {
operations => $a_reference_to, # see Google::Ads::AdWords::v201802::LinkOperation
},,
);mutateManager
Moves client customers to new managers (moving links). Only the following action is possible: <ul> <li>SET + ACTIVE: manager moves client customers to new managers within the same manager account hierarchy</li> </ul> @param operations List of unique operations. @return results for the given operations @throws ApiException with a {@link ManagedCustomerServiceError}
Returns a Google::Ads::AdWords::v201802::ManagedCustomerService::mutateManagerResponse object.
$response = $interface->mutateManager( {
operations => $a_reference_to, # see Google::Ads::AdWords::v201802::MoveOperation
},,
);AUTHOR
Generated by SOAP::WSDL on Mon Feb 26 21:11:19 2018