<?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\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\Resource;
use Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse;
use Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret;
use Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleProtobufEmpty;
/**
* The "measurementProtocolSecrets" collection of methods.
* Typical usage is:
* <code>
* $analyticsadminService = new Google\Service\GoogleAnalyticsAdmin(...);
* $measurementProtocolSecrets = $analyticsadminService->measurementProtocolSecrets;
* </code>
*/
class PropertiesIosAppDataStreamsMeasurementProtocolSecrets extends \Google\Site_Kit_Dependencies\Google\Service\Resource
{
/**
* Creates a measurement protocol secret. (measurementProtocolSecrets.create)
*
* @param string $parent Required. The parent resource where this secret will be
* created. Any type of stream (WebDataStream, IosAppDataStream,
* AndroidAppDataStream) may be a parent. Format:
* properties/{property}/webDataStreams/{webDataStream}
* @param GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret $postBody
* @param array $optParams Optional parameters.
* @return GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
*/
public function create($parent, \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = \array_merge($params, $optParams);
return $this->call('create', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::class);
}
/**
* Deletes target MeasurementProtocolSecret. (measurementProtocolSecrets.delete)
*
* @param string $name Required. The name of the MeasurementProtocolSecret to
* delete. Format: properties/{property}/webDataStreams/{webDataStream}/measurem
* entProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream
* (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.
* @param array $optParams Optional parameters.
* @return GoogleProtobufEmpty
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = \array_merge($params, $optParams);
return $this->call('delete', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleProtobufEmpty::class);
}
/**
* Lookup for a single "GA4" MeasurementProtocolSecret.
* (measurementProtocolSecrets.get)
*
* @param string $name Required. The name of the measurement protocol secret to
* lookup. Format: properties/{property}/webDataStreams/{webDataStream}/measurem
* entProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream
* (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.
* @param array $optParams Optional parameters.
* @return GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = \array_merge($params, $optParams);
return $this->call('get', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::class);
}
/**
* Returns child MeasurementProtocolSecrets under the specified parent Property.
* (measurementProtocolSecrets.listPropertiesIosAppDataStreamsMeasurementProtoco
* lSecrets)
*
* @param string $parent Required. The resource name of the parent stream. Any
* type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be
* a parent. Format: properties/{property}/webDataStreams/{webDataStream}/measur
* ementProtocolSecrets
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of resources to return. If
* unspecified, at most 10 resources will be returned. The maximum value is 10.
* Higher values will be coerced to the maximum.
* @opt_param string pageToken A page token, received from a previous
* `ListMeasurementProtocolSecrets` call. Provide this to retrieve the
* subsequent page. When paginating, all other parameters provided to
* `ListMeasurementProtocolSecrets` must match the call that provided the page
* token.
* @return GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
*/
public function listPropertiesIosAppDataStreamsMeasurementProtocolSecrets($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = \array_merge($params, $optParams);
return $this->call('list', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse::class);
}
/**
* Updates a measurement protocol secret. (measurementProtocolSecrets.patch)
*
* @param string $name Output only. Resource name of this secret. This secret
* may be a child of any type of stream. Format: properties/{property}/webDataSt
* reams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
* @param GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask The list of fields to be updated. Omitted fields
* will not be updated.
* @return GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
*/
public function patch($name, \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = \array_merge($params, $optParams);
return $this->call('patch', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
\class_alias(\Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\Resource\PropertiesIosAppDataStreamsMeasurementProtocolSecrets::class, 'Google\\Site_Kit_Dependencies\\Google_Service_GoogleAnalyticsAdmin_Resource_PropertiesIosAppDataStreamsMeasurementProtocolSecrets');