Documentation

Google_Service_ConsumerSurveys_Resource_Surveys extends Google_Service_Resource
in package

Application

The "surveys" collection of methods.

Typical usage is: $consumersurveysService = new Google_Service_ConsumerSurveys(...); $surveys = $consumersurveysService->surveys;

$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.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_ConsumerSurveys_SurveysDeleteResponse: Removes a survey from view in all user GET requests. (surveys.delete)
get() : Google_Service_ConsumerSurveys_Survey: Retrieves information about the specified survey. (surveys.get)
insert() : Google_Service_ConsumerSurveys_Survey: Creates a survey. (surveys.insert)
listSurveys() : Google_Service_ConsumerSurveys_SurveysListResponse: Lists the surveys owned by the authenticated user. (surveys.listSurveys)
start() : Google_Service_ConsumerSurveys_SurveysStartResponse: Begins running a survey. (surveys.start)
stop() : Google_Service_ConsumerSurveys_SurveysStopResponse: Stops a running survey. (surveys.stop)
update() : Google_Service_ConsumerSurveys_Survey: Updates a survey. Currently the only property that can be updated is the owners property. (surveys.update)
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 —

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

Removes a survey from view in all user GET requests. (surveys.delete)


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

Parameters

$surveyUrlId : string: External URL ID for the survey.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ConsumerSurveys_SurveysDeleteResponse —

get()

Retrieves information about the specified survey. (surveys.get)


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

Parameters

$surveyUrlId : string: External URL ID for the survey.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ConsumerSurveys_Survey —

insert()

Creates a survey. (surveys.insert)


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

Parameters

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

Return values

Google_Service_ConsumerSurveys_Survey —

listSurveys()

Lists the surveys owned by the authenticated user. (surveys.listSurveys)


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

Parameters

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

Return values

Google_Service_ConsumerSurveys_SurveysListResponse —

start()

Begins running a survey. (surveys.start)


    public
                start(string $resourceId, Google_Service_ConsumerSurveys_SurveysStartRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ConsumerSurveys_SurveysStartResponse

Parameters

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

Return values

Google_Service_ConsumerSurveys_SurveysStartResponse —

stop()

Stops a running survey. (surveys.stop)


    public
                stop(string $resourceId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ConsumerSurveys_SurveysStopResponse

Parameters

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

Return values

Google_Service_ConsumerSurveys_SurveysStopResponse —

update()

Updates a survey. Currently the only property that can be updated is the owners property. (surveys.update)


    public
                update(string $surveyUrlId, Google_Service_ConsumerSurveys_Survey $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ConsumerSurveys_Survey

Parameters

$surveyUrlId : string: External URL ID for the survey.
$postBody : Google_Service_ConsumerSurveys_Survey
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ConsumerSurveys_Survey —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —