source: vendor/google/apiclient-services/src/Adsense/Resource/AccountsReportsSaved.php

<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\Adsense\Resource;

use Google\Service\Adsense\HttpBody;
use Google\Service\Adsense\ListSavedReportsResponse;
use Google\Service\Adsense\ReportResult;

/**
 * The "saved" collection of methods.
 * Typical usage is:
 *  <code>
 *   $adsenseService = new Google\Service\Adsense(...);
 *   $saved = $adsenseService->accounts_reports_saved;
 *  </code>
 */
class AccountsReportsSaved extends \Google\Service\Resource
{
  /**
   * Generates a saved report. (saved.generate)
   *
   * @param string $name Required. Name of the saved report. Format:
   * accounts/{account}/reports/{report}
   * @param array $optParams Optional parameters.
   *
   * @opt_param string currencyCode The [ISO-4217 currency
   * code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on
   * monetary metrics. Defaults to the account's currency if not set.
   * @opt_param string dateRange Date range of the report, if unset the range will
   * be considered CUSTOM.
   * @opt_param int endDate.day Day of a month. Must be from 1 to 31 and valid for
   * the year and month, or 0 to specify a year by itself or a year and month
   * where the day isn't significant.
   * @opt_param int endDate.month Month of a year. Must be from 1 to 12, or 0 to
   * specify a year without a month and day.
   * @opt_param int endDate.year Year of the date. Must be from 1 to 9999, or 0 to
   * specify a date without a year.
   * @opt_param string languageCode The language to use for translating report
   * output. If unspecified, this defaults to English ("en"). If the given
   * language is not supported, report output will be returned in English. The
   * language is specified as an [IETF BCP-47 language
   * code](https://en.wikipedia.org/wiki/IETF_language_tag).
   * @opt_param string reportingTimeZone Timezone in which to generate the report.
   * If unspecified, this defaults to the account timezone. For more information,
   * see [changing the time zone of your
   * reports](https://support.google.com/adsense/answer/9830725).
   * @opt_param int startDate.day Day of a month. Must be from 1 to 31 and valid
   * for the year and month, or 0 to specify a year by itself or a year and month
   * where the day isn't significant.
   * @opt_param int startDate.month Month of a year. Must be from 1 to 12, or 0 to
   * specify a year without a month and day.
   * @opt_param int startDate.year Year of the date. Must be from 1 to 9999, or 0
   * to specify a date without a year.
   * @return ReportResult
   * @throws \Google\Service\Exception
   */
  public function generate($name, $optParams = [])
  {
    $params = ['name' => $name];
    $params = array_merge($params, $optParams);
    return $this->call('generate', [$params], ReportResult::class);
  }
  /**
   * Generates a csv formatted saved report. (saved.generateCsv)
   *
   * @param string $name Required. Name of the saved report. Format:
   * accounts/{account}/reports/{report}
   * @param array $optParams Optional parameters.
   *
   * @opt_param string currencyCode The [ISO-4217 currency
   * code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on
   * monetary metrics. Defaults to the account's currency if not set.
   * @opt_param string dateRange Date range of the report, if unset the range will
   * be considered CUSTOM.
   * @opt_param int endDate.day Day of a month. Must be from 1 to 31 and valid for
   * the year and month, or 0 to specify a year by itself or a year and month
   * where the day isn't significant.
   * @opt_param int endDate.month Month of a year. Must be from 1 to 12, or 0 to
   * specify a year without a month and day.
   * @opt_param int endDate.year Year of the date. Must be from 1 to 9999, or 0 to
   * specify a date without a year.
   * @opt_param string languageCode The language to use for translating report
   * output. If unspecified, this defaults to English ("en"). If the given
   * language is not supported, report output will be returned in English. The
   * language is specified as an [IETF BCP-47 language
   * code](https://en.wikipedia.org/wiki/IETF_language_tag).
   * @opt_param string reportingTimeZone Timezone in which to generate the report.
   * If unspecified, this defaults to the account timezone. For more information,
   * see [changing the time zone of your
   * reports](https://support.google.com/adsense/answer/9830725).
   * @opt_param int startDate.day Day of a month. Must be from 1 to 31 and valid
   * for the year and month, or 0 to specify a year by itself or a year and month
   * where the day isn't significant.
   * @opt_param int startDate.month Month of a year. Must be from 1 to 12, or 0 to
   * specify a year without a month and day.
   * @opt_param int startDate.year Year of the date. Must be from 1 to 9999, or 0
   * to specify a date without a year.
   * @return HttpBody
   * @throws \Google\Service\Exception
   */
  public function generateCsv($name, $optParams = [])
  {
    $params = ['name' => $name];
    $params = array_merge($params, $optParams);
    return $this->call('generateCsv', [$params], HttpBody::class);
  }
  /**
   * Lists saved reports. (saved.listAccountsReportsSaved)
   *
   * @param string $parent Required. The account which owns the collection of
   * reports. Format: accounts/{account}
   * @param array $optParams Optional parameters.
   *
   * @opt_param int pageSize The maximum number of reports to include in the
   * response, used for paging. If unspecified, at most 10000 reports will be
   * returned. The maximum value is 10000; values above 10000 will be coerced to
   * 10000.
   * @opt_param string pageToken A page token, received from a previous
   * `ListSavedReports` call. Provide this to retrieve the subsequent page. When
   * paginating, all other parameters provided to `ListSavedReports` must match
   * the call that provided the page token.
   * @return ListSavedReportsResponse
   * @throws \Google\Service\Exception
   */
  public function listAccountsReportsSaved($parent, $optParams = [])
  {
    $params = ['parent' => $parent];
    $params = array_merge($params, $optParams);
    return $this->call('list', [$params], ListSavedReportsResponse::class);
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AccountsReportsSaved::class, 'Google_Service_Adsense_Resource_AccountsReportsSaved');