Documentation

Google_Service_GoogleAnalyticsAdmin_Resource_Properties extends Google_Service_Resource
in package

Application

The "properties" collection of methods.

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

$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_GoogleAnalyticsAdminV1alphaProperty: Creates an "App+Web" property with the specified location and attributes.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty: Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged.
get() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaProperty: Lookup for a single "App+Web" Property. Throws "Target not found" if no such property found, if property is not of the type "App+Web", or if caller does not have permissions to access it. (properties.get)
listProperties() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListPropertiesResponse: Returns child Properties under the specified parent Account. Only "App+Web" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
patch() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaProperty: Updates a property. (properties.patch)
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 an "App+Web" property with the specified location and attributes.


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

(properties.create)

Parameters

$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaProperty
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaProperty —

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()

Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged.


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

https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an App+Web Property. (properties.delete)

Parameters

$name : string: Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty —

get()

Lookup for a single "App+Web" Property. Throws "Target not found" if no such property found, if property is not of the type "App+Web", or if caller does not have permissions to access it. (properties.get)


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

Parameters

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

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaProperty —

listProperties()

Returns child Properties under the specified parent Account. Only "App+Web" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.


    public
                listProperties([array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListPropertiesResponse

(properties.listProperties)

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListPropertiesResponse —

patch()

Updates a property. (properties.patch)


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

Parameters

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

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaProperty —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —