PHP Class ReportUtilsDelegate, googleads-php-lib

Use ReportUtils to download AdWords API reports.
ファイルを表示 Open project: googleads/googleads-php-lib Class Usage Examples

Public Properties

Property Type Description
$CLASS_MAP The mapping of XML tag names in report download's XML error response to PHP classes, which are needed in XML deserialization.

Public Methods

Method Description
DownloadReport ( $reportDefinition, $path = null, AdWordsUser $user, array $options = null )
DownloadReport ( $reportDefinition, $path = null, AdWordsUser $user, array $options = null, array $customCurlOptions = null )
DownloadReportWithAwql ( $reportQuery, $path = null, AdWordsUser $user, $reportFormat, array $options = null )
DownloadReportWithAwql ( $reportQuery, $path = null, AdWordsUser $user, $reportFormat, array $options = null, array $customCurlOptions = null )

Private Methods

Method Description
DownloadReportFromUrl ( string $url, array $headers, array $params, string $path = null ) : mixed Downloads a report using the URL provided.
DownloadReportFromUrl ( string $url, array $headers, array $params, string $path = null, array $customCurlOptions = null ) : mixed Downloads a report using the URL provided.
GetHeaders ( AdWordsUser $user, string $url, array $options = null ) : array Gets the HTTP headers for the report download request.
GetParams ( mixed $reportDefinition ) : array Generates the parameters to use for the download request.
GetQueryParams ( string $reportQuery, string $reportFormat ) : array Generates the parameters to use for the download request with AWQL.
GetUrl ( AdWordsUser $user, array $options = null ) : string Generates the URL to use for the download request.
LogRequest ( string $requestHeaders, integer $responseCode, array $params = null, Exception $exception = null ) Logs the report download request.
ParseApiErrorXml ( string $responseXml ) : object | null Tries to parse the error response xml from the AdWords API server as an object.
__construct ( ) The ReportUtils class is not meant to have any instances.

Method Details

DownloadReport() public static method

See also: ReportUtils::DownloadReport
public static DownloadReport ( $reportDefinition, $path = null, AdWordsUser $user, array $options = null )
$user AdWordsUser
$options array

DownloadReport() public static method

See also: ReportUtils::DownloadReport
public static DownloadReport ( $reportDefinition, $path = null, AdWordsUser $user, array $options = null, array $customCurlOptions = null )
$user AdWordsUser
$options array
$customCurlOptions array

DownloadReportWithAwql() public static method

See also: ReportUtils::DownloadReportWithAwql
public static DownloadReportWithAwql ( $reportQuery, $path = null, AdWordsUser $user, $reportFormat, array $options = null )
$user AdWordsUser
$options array

DownloadReportWithAwql() public static method

See also: ReportUtils::DownloadReportWithAwql
public static DownloadReportWithAwql ( $reportQuery, $path = null, AdWordsUser $user, $reportFormat, array $options = null, array $customCurlOptions = null )
$user AdWordsUser
$options array
$customCurlOptions array

Property Details

$CLASS_MAP public_oe static_oe property

The mapping of XML tag names in report download's XML error response to PHP classes, which are needed in XML deserialization.
public static $CLASS_MAP