NAME

Google::Ads::AdWords::v201705::BudgetOrderService::BudgetOrderServiceInterfacePort - SOAP Interface for the BudgetOrderService Web Service

SYNOPSIS

 use Google::Ads::AdWords::v201705::BudgetOrderService::BudgetOrderServiceInterfacePort;
 my $interface = Google::Ads::AdWords::v201705::BudgetOrderService::BudgetOrderServiceInterfacePort->new();

 my $response;
 $response = $interface->get();
 $response = $interface->getBillingAccounts();
 $response = $interface->mutate();

DESCRIPTION

SOAP Interface for the BudgetOrderService web service located at https://adwords.google.com/api/adwords/billing/v201705/BudgetOrderService.

SERVICE BudgetOrderService

Port BudgetOrderServiceInterfacePort

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

Gets a list of {@link BudgetOrder}s using the generic selector. @param serviceSelector specifies which BudgetOrder to return. @return A {@link BudgetOrderPage} of BudgetOrders of the client customer. All BudgetOrder fields are returned. Stats are not yet supported. @throws ApiException

Returns a Google::Ads::AdWords::v201705::BudgetOrderService::getResponse object.

 $response = $interface->get( {
    serviceSelector =>  $a_reference_to, # see Google::Ads::AdWords::v201705::Selector
  },,
 );

getBillingAccounts

Returns all the open/active BillingAccounts associated with the current manager. @return A list of {@link BillingAccount}s. @throws ApiException

Returns a Google::Ads::AdWords::v201705::BudgetOrderService::getBillingAccountsResponse object.

 $response = $interface->getBillingAccounts( {
  },,
 );

mutate

Adds, updates, or removes budget orders. Supported operations are: <p><code>AD/code: Adds a {@link BudgetOrder} to the billing account specified by the billing account ID.</p> <p><code>SE/code: Sets the start/end date and amount of the {@link BudgetOrder}.</p> <p><code>REMOVE</code>: Cancels the {@link BudgetOrder} (status change).</p> <p class="warning"><b>Warning:</b> The <code>BudgetOrderService</code> is limited to one operation per mutate request. Any attempt to make more than one operation will result in an <code>ApiException</code>.</p> <p class="note"><b>Note:</b> This action is available only on a whitelist basis.</p> @param operations A list of operations, <b>however currently we only support one operation per mutate call</b>. @return BudgetOrders affected by the mutate operation. @throws ApiException

Returns a Google::Ads::AdWords::v201705::BudgetOrderService::mutateResponse object.

 $response = $interface->mutate( {
    operations =>  $a_reference_to, # see Google::Ads::AdWords::v201705::BudgetOrderOperation
  },,
 );

AUTHOR

Generated by SOAP::WSDL on Wed May 31 08:54:29 2017

cpanm Google::Ads::AdWords::Client

perl -MCPAN -e shell
install Google::Ads::AdWords::Client