Documentation

Google_Service_GoogleAnalyticsAdmin_Resource_PropertiesWebDataStreams extends Google_Service_Resource
in package

Application

The "webDataStreams" collection of methods.

Typical usage is: $analyticsadminService = new Google_Service_GoogleAnalyticsAdmin(...); $webDataStreams = $analyticsadminService->webDataStreams;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream: Creates a web stream with the specified location and attributes.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty: Deletes a web stream on a property. (webDataStreams.delete)
get() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream: Lookup for a single WebDataStream Throws "Target not found" if no such web data stream found, or if the caller does not have permissions to access it.
getEnhancedMeasurementSettings() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings: Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect. (webDataStreams.getEnhancedMeasurementSettings)
getGlobalSiteTag() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaGlobalSiteTag: Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. (webDataStreams.getGlobalSiteTag)
listPropertiesWebDataStreams() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse: Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.
patch() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream: Updates a web stream on a property. (webDataStreams.patch)
updateEnhancedMeasurementSettings() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings: Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect. (webDataStreams.updateEnhancedMeasurementSettings)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a web stream with the specified location and attributes.


    public
                create(string $parent, Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream

(webDataStreams.create)

Parameters

$parent : string: Required. The parent resource where this web data stream will be created. Format: properties/123
$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes a web stream on a property. (webDataStreams.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty

Parameters

$name : string: Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456"
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty —

get()

Lookup for a single WebDataStream Throws "Target not found" if no such web data stream found, or if the caller does not have permissions to access it.


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream

(webDataStreams.get)

Parameters

$name : string: Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456"
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream —

getEnhancedMeasurementSettings()

Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect. (webDataStreams.getEnhancedMeasurementSettings)


    public
                getEnhancedMeasurementSettings(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings

Parameters

$name : string: Required. The name of the settings to lookup. Format: pro perties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings —

getGlobalSiteTag()

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. (webDataStreams.getGlobalSiteTag)


    public
                getGlobalSiteTag(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaGlobalSiteTag

Parameters

$name : string: Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/webDataStreams/{stream_id}/globalSiteTag Example: "properties/123/webDataStreams/456/globalSiteTag"
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaGlobalSiteTag —

listPropertiesWebDataStreams()

Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.


    public
                listPropertiesWebDataStreams(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse

(webDataStreams.listPropertiesWebDataStreams)

Parameters

$parent : string: Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: "properties/123"
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse —

patch()

Updates a web stream on a property. (webDataStreams.patch)


    public
                patch(string $name, Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream

Parameters

$name : string: Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"
$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaWebDataStream —

updateEnhancedMeasurementSettings()

Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect. (webDataStreams.updateEnhancedMeasurementSettings)


    public
                updateEnhancedMeasurementSettings(string $name, Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings

Parameters

$name : string: Output only. Resource name of this Data Stream. Format: p roperties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSetting s Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —