* $analyticsadminService = new Google\Service\GoogleAnalyticsAdmin(...); * $customMetrics = $analyticsadminService->properties_customMetrics; * */ class PropertiesCustomMetrics extends \Google\Service\Resource { /** * Archives a CustomMetric on a property. (customMetrics.archive) * * @param string $name Required. The name of the CustomMetric to archive. * Example format: properties/1234/customMetrics/5678 * @param GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest $postBody * @param array $optParams Optional parameters. * @return GoogleProtobufEmpty * @throws \Google\Service\Exception */ public function archive($name, GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('archive', [$params], GoogleProtobufEmpty::class); } /** * Creates a CustomMetric. (customMetrics.create) * * @param string $parent Required. Example format: properties/1234 * @param GoogleAnalyticsAdminV1betaCustomMetric $postBody * @param array $optParams Optional parameters. * @return GoogleAnalyticsAdminV1betaCustomMetric * @throws \Google\Service\Exception */ public function create($parent, GoogleAnalyticsAdminV1betaCustomMetric $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GoogleAnalyticsAdminV1betaCustomMetric::class); } /** * Lookup for a single CustomMetric. (customMetrics.get) * * @param string $name Required. The name of the CustomMetric to get. Example * format: properties/1234/customMetrics/5678 * @param array $optParams Optional parameters. * @return GoogleAnalyticsAdminV1betaCustomMetric * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleAnalyticsAdminV1betaCustomMetric::class); } /** * Lists CustomMetrics on a property. * (customMetrics.listPropertiesCustomMetrics) * * @param string $parent Required. Example format: properties/1234 * @param array $optParams Optional parameters. * * @opt_param int pageSize The maximum number of resources to return. If * unspecified, at most 50 resources will be returned. The maximum value is 200 * (higher values will be coerced to the maximum). * @opt_param string pageToken A page token, received from a previous * `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When * paginating, all other parameters provided to `ListCustomMetrics` must match * the call that provided the page token. * @return GoogleAnalyticsAdminV1betaListCustomMetricsResponse * @throws \Google\Service\Exception */ public function listPropertiesCustomMetrics($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], GoogleAnalyticsAdminV1betaListCustomMetricsResponse::class); } /** * Updates a CustomMetric on a property. (customMetrics.patch) * * @param string $name Output only. Resource name for this CustomMetric * resource. Format: properties/{property}/customMetrics/{customMetric} * @param GoogleAnalyticsAdminV1betaCustomMetric $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask Required. The list of fields to be updated. * Omitted fields will not be updated. To replace the entire entity, use one * path with the string "*" to match all fields. * @return GoogleAnalyticsAdminV1betaCustomMetric * @throws \Google\Service\Exception */ public function patch($name, GoogleAnalyticsAdminV1betaCustomMetric $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], GoogleAnalyticsAdminV1betaCustomMetric::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(PropertiesCustomMetrics::class, 'Google_Service_GoogleAnalyticsAdmin_Resource_PropertiesCustomMetrics');