/ 
Google-Ads-AdWords-Client-5.8.2
River stage zero No dependents
/ Google::Ads::AdWords::v201809::ReportDefinitionService::ReportDefinitionServiceInterfacePort

NAME

Google::Ads::AdWords::v201809::ReportDefinitionService::ReportDefinitionServiceInterfacePort - SOAP Interface for the ReportDefinitionService Web Service

SYNOPSIS

use Google::Ads::AdWords::v201809::ReportDefinitionService::ReportDefinitionServiceInterfacePort;
my $interface = Google::Ads::AdWords::v201809::ReportDefinitionService::ReportDefinitionServiceInterfacePort->new();

my $response;
$response = $interface->getReportFields();

DESCRIPTION

SOAP Interface for the ReportDefinitionService web service located at https://adwords.google.com/api/adwords/cm/v201809/ReportDefinitionService.

SERVICE ReportDefinitionService

Port ReportDefinitionServiceInterfacePort

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.

getReportFields

Returns the available report fields for a given report type. When using this method the {@code clientCustomerId} header field is optional. Callers are discouraged from setting the clientCustomerId header field in calls to this method as its presence will trigger an authorization error if the caller does not have access to the customer with the included ID. @param reportType The type of report. @return The list of available report fields. Each {@link ReportDefinitionField} encapsulates the field name, the field data type, and the enum values (if the field's type is {@code enum}). @throws ApiException if a problem occurred while fetching the ReportDefinitionField information.

Returns a Google::Ads::AdWords::v201809::ReportDefinitionService::getReportFieldsResponse object.

$response = $interface->getReportFields( {
   reportType => $some_value, # ReportDefinition.ReportType
 },,
);

AUTHOR

Generated by SOAP::WSDL on Thu Sep 20 11:09:59 2018