Google Ads Ad Manager V1 Client - Class ReportServiceClient (0.1.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class ReportServiceClient.

Service Description: Provides methods for interacting with reports.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Ads \ AdManager \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. At the moment, supports only `rest`. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createReport

API to create a Report object.

The async variant is Google\Ads\AdManager\V1\Client\ReportServiceClient::createReportAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\CreateReportRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Ads\AdManager\V1\Report`

Example

use Google\Ads\AdManager\V1\Client\ReportServiceClient;
use Google\Ads\AdManager\V1\CreateReportRequest;
use Google\Ads\AdManager\V1\Report;
use Google\Ads\AdManager\V1\ReportDefinition;
use Google\Ads\AdManager\V1\Report\DateRange;
use Google\Ads\AdManager\V1\Report\Dimension;
use Google\Ads\AdManager\V1\Report\Metric;
use Google\Ads\AdManager\V1\Report\ReportType;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                         The parent resource where this `Report` will be created.
 *                                                        Format: `networks/{network_code}`
 *                                                        Please see {@see ReportServiceClient::networkName()} for help formatting this field.
 * @param int    $reportReportDefinitionDimensionsElement The list of dimensions to report on. If empty, the report will
 *                                                        have no dimensions, and any metrics will be totals.
 * @param int    $reportReportDefinitionMetricsElement    The list of metrics to report on. If empty, the report will have
 *                                                        no metrics.
 * @param int    $reportReportDefinitionReportType        The type of this report.
 */
function create_report_sample(
    string $formattedParent,
    int $reportReportDefinitionDimensionsElement,
    int $reportReportDefinitionMetricsElement,
    int $reportReportDefinitionReportType
): void {
    // Create a client.
    $reportServiceClient = new ReportServiceClient();

    // Prepare the request message.
    $reportReportDefinitionDimensions = [$reportReportDefinitionDimensionsElement,];
    $reportReportDefinitionMetrics = [$reportReportDefinitionMetricsElement,];
    $reportReportDefinitionDateRange = new DateRange();
    $reportReportDefinition = (new ReportDefinition())
        ->setDimensions($reportReportDefinitionDimensions)
        ->setMetrics($reportReportDefinitionMetrics)
        ->setDateRange($reportReportDefinitionDateRange)
        ->setReportType($reportReportDefinitionReportType);
    $report = (new Report())
        ->setReportDefinition($reportReportDefinition);
    $request = (new CreateReportRequest())
        ->setParent($formattedParent)
        ->setReport($report);

    // Call the API and handle any network failures.
    try {
        /** @var Report $response */
        $response = $reportServiceClient->createReport($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ReportServiceClient::networkName('[NETWORK_CODE]');
    $reportReportDefinitionDimensionsElement = Dimension::DIMENSION_UNSPECIFIED;
    $reportReportDefinitionMetricsElement = Metric::METRIC_UNSPECIFIED;
    $reportReportDefinitionReportType = ReportType::REPORT_TYPE_UNSPECIFIED;

    create_report_sample(
        $formattedParent,
        $reportReportDefinitionDimensionsElement,
        $reportReportDefinitionMetricsElement,
        $reportReportDefinitionReportType
    );
}

fetchReportResultRows

Returns the result rows from a completed report.

The caller must have previously called RunReport and waited for that operation to complete. The rows will be returned according to the order specified by the sorts member of the report definition.

The async variant is Google\Ads\AdManager\V1\Client\ReportServiceClient::fetchReportResultRowsAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\FetchReportResultRowsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Ads\AdManager\V1\FetchReportResultRowsResponse`

Example

use Google\Ads\AdManager\V1\Client\ReportServiceClient;
use Google\Ads\AdManager\V1\FetchReportResultRowsRequest;
use Google\Ads\AdManager\V1\FetchReportResultRowsResponse;
use Google\ApiCore\ApiException;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function fetch_report_result_rows_sample(): void
{
    // Create a client.
    $reportServiceClient = new ReportServiceClient();

    // Prepare the request message.
    $request = new FetchReportResultRowsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var FetchReportResultRowsResponse $response */
        $response = $reportServiceClient->fetchReportResultRows($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getReport

API to retrieve a Report object.

The async variant is Google\Ads\AdManager\V1\Client\ReportServiceClient::getReportAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\GetReportRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Ads\AdManager\V1\Report`

Example

use Google\Ads\AdManager\V1\Client\ReportServiceClient;
use Google\Ads\AdManager\V1\GetReportRequest;
use Google\Ads\AdManager\V1\Report;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the report.
 *                              Format: `networks/{network_code}/reports/{report_id}`
 *                              Please see {@see ReportServiceClient::reportName()} for help formatting this field.
 */
function get_report_sample(string $formattedName): void
{
    // Create a client.
    $reportServiceClient = new ReportServiceClient();

    // Prepare the request message.
    $request = (new GetReportRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Report $response */
        $response = $reportServiceClient->getReport($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ReportServiceClient::reportName('[NETWORK_CODE]', '[REPORT]');

    get_report_sample($formattedName);
}

listReports

API to retrieve a list of Report objects.

The async variant is Google\Ads\AdManager\V1\Client\ReportServiceClient::listReportsAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\ListReportsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\Ads\AdManager\V1\Client\ReportServiceClient;
use Google\Ads\AdManager\V1\ListReportsRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The parent, which owns this collection of reports.
 *                                Format: `networks/{network_code}`
 *                                Please see {@see ReportServiceClient::networkName()} for help formatting this field.
 */
function list_reports_sample(string $formattedParent): void
{
    // Create a client.
    $reportServiceClient = new ReportServiceClient();

    // Prepare the request message.
    $request = (new ListReportsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $reportServiceClient->listReports($request);

        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ReportServiceClient::networkName('[NETWORK_CODE]');

    list_reports_sample($formattedParent);
}

runReport

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation via OperationsService.GetOperation.

Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a report_result that can be passed to the FetchReportResultRows method to retrieve the report data.

The async variant is Google\Ads\AdManager\V1\Client\ReportServiceClient::runReportAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\RunReportRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\Ads\AdManager\V1\Client\ReportServiceClient;
use Google\Ads\AdManager\V1\RunReportRequest;
use Google\Ads\AdManager\V1\RunReportResponse;
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName The report to run.
 *                              Format: `networks/{network_code}/reports/{report_id}`
 *                              Please see {@see ReportServiceClient::reportName()} for help formatting this field.
 */
function run_report_sample(string $formattedName): void
{
    // Create a client.
    $reportServiceClient = new ReportServiceClient();

    // Prepare the request message.
    $request = (new RunReportRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $reportServiceClient->runReport($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var RunReportResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ReportServiceClient::reportName('[NETWORK_CODE]', '[REPORT]');

    run_report_sample($formattedName);
}

updateReport

API to update a Report object.

The async variant is Google\Ads\AdManager\V1\Client\ReportServiceClient::updateReportAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\UpdateReportRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Ads\AdManager\V1\Report`

Example

use Google\Ads\AdManager\V1\Client\ReportServiceClient;
use Google\Ads\AdManager\V1\Report;
use Google\Ads\AdManager\V1\ReportDefinition;
use Google\Ads\AdManager\V1\Report\DateRange;
use Google\Ads\AdManager\V1\Report\Dimension;
use Google\Ads\AdManager\V1\Report\Metric;
use Google\Ads\AdManager\V1\Report\ReportType;
use Google\Ads\AdManager\V1\UpdateReportRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;

/**
 * @param int $reportReportDefinitionDimensionsElement The list of dimensions to report on. If empty, the report will
 *                                                     have no dimensions, and any metrics will be totals.
 * @param int $reportReportDefinitionMetricsElement    The list of metrics to report on. If empty, the report will have
 *                                                     no metrics.
 * @param int $reportReportDefinitionReportType        The type of this report.
 */
function update_report_sample(
    int $reportReportDefinitionDimensionsElement,
    int $reportReportDefinitionMetricsElement,
    int $reportReportDefinitionReportType
): void {
    // Create a client.
    $reportServiceClient = new ReportServiceClient();

    // Prepare the request message.
    $reportReportDefinitionDimensions = [$reportReportDefinitionDimensionsElement,];
    $reportReportDefinitionMetrics = [$reportReportDefinitionMetricsElement,];
    $reportReportDefinitionDateRange = new DateRange();
    $reportReportDefinition = (new ReportDefinition())
        ->setDimensions($reportReportDefinitionDimensions)
        ->setMetrics($reportReportDefinitionMetrics)
        ->setDateRange($reportReportDefinitionDateRange)
        ->setReportType($reportReportDefinitionReportType);
    $report = (new Report())
        ->setReportDefinition($reportReportDefinition);
    $updateMask = new FieldMask();
    $request = (new UpdateReportRequest())
        ->setReport($report)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Report $response */
        $response = $reportServiceClient->updateReport($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $reportReportDefinitionDimensionsElement = Dimension::DIMENSION_UNSPECIFIED;
    $reportReportDefinitionMetricsElement = Metric::METRIC_UNSPECIFIED;
    $reportReportDefinitionReportType = ReportType::REPORT_TYPE_UNSPECIFIED;

    update_report_sample(
        $reportReportDefinitionDimensionsElement,
        $reportReportDefinitionMetricsElement,
        $reportReportDefinitionReportType
    );
}

PromiseInterface

Returns
Type	Description
`void`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\LongRunning\Client\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::networkName

Formats a string containing the fully-qualified path to represent a network resource.

Parameter
Name	Description
`networkCode`	`string`

Returns
Type	Description
`string`	The formatted network resource.

static::reportName

Formats a string containing the fully-qualified path to represent a report resource.

Parameters
Name	Description
`networkCode`	`string`
`report`	`string`

Returns
Type	Description
`string`	The formatted report resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

network: networks/{network_code}
report: networks/{network_code}/reports/{report}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.