PHP Class ReportService, googleads-php-lib

Inheritance: extends DfpSoapClient

ファイルを表示 Open project: googleads/googleads-php-lib Class Usage Examples

Public Properties

Property	Type	Description
$classmap	array	Default class map for wsdl=>php
$endpoint	string	The endpoint of the service

Public Methods

Method	Description
__construct ( string $wsdl, array $options, $user )	Constructor using wsdl location and options array
getReportDownloadURL ( $reportJobId, $exportFormat ) : the	Returns the URL at which the report file can be downloaded.
getReportDownloadUrlWithOptions ( $reportJobId, $reportDownloadOptions ) : the	Returns the URL at which the report file can be downloaded, and allows for customization of the downloaded report.
getReportJobStatus ( $reportJobId )	Returns the {@link ReportJobStatus} of the report job with the specified ID.
runReportJob ( $reportJob ) : the	Initiates the execution of a {@link ReportQuery} on the server.

Method Details

__construct() public method

Constructor using wsdl location and options array

public __construct ( string $wsdl, array $options, $user )
$wsdl	string	WSDL location for this service
$options	array	Options for the SoapClient

getReportDownloadURL() public method

The report will be generated as a gzip archive, containing the report file itself.

public getReportDownloadURL ( $reportJobId, $exportFormat ) : the
return	the	URL for report file download

getReportDownloadUrlWithOptions() public method

By default, the report will be generated as a gzip archive, containing the report file itself. This can be changed by setting {@link ReportDownloadOptions#useGzipCompression} to false.

public getReportDownloadUrlWithOptions ( $reportJobId, $reportDownloadOptions ) : the
return	the	URL for report file download

getReportJobStatus() public method

Returns the {@link ReportJobStatus} of the report job with the specified ID.

public getReportJobStatus ( $reportJobId )

runReportJob() public method

The following fields are required:

{@link ReportJob#reportQuery}

public runReportJob ( $reportJob ) : the
return	the	report job with its ID filled in

Property Details

$classmap public_oe static_oe property

Default class map for wsdl=>php

public static array $classmap
return	array

$endpoint public_oe static_oe property

The endpoint of the service

public static string $endpoint
return	string