Documentation

Google_Service_Cih_Resource_UserInteractions extends Google_Service_Resource
in package

The "userInteractions" collection of methods.

Typical usage is: $cihService = new Google_Service_Cih(...); $userInteractions = $cihService->userInteractions;

Table of Contents

$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.
get()  : Google_Service_Cih_UserInteraction
Gets an interaction. (userInteractions.get)
insert()  : Google_Service_Cih_UserInteraction
Inserts a new interaction to CIH. (userInteractions.insert)
listUserInteractions()  : Google_Service_Cih_UserInteractionsListResponse
Get a list of interactions for the given entity and its relatives if requested. The returned list is sorted by timestamp in descending order.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
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>
Tags
static
Return values
string —

$requestUrl

get()

Gets an interaction. (userInteractions.get)

public get(string $entityType, string $entityId, string $timestamp, string $interactionType[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Cih_UserInteraction
Parameters
$entityType : string

Represents the Type of the entity whose interaction will be returned. Possible Values: COMPANY, ADWORDS_CID, EMAIL, ADDRESS_DIGEST, GAIA_ID.

$entityId : string

Represents the Id of the Entity whose interaction will be returned.

$timestamp : string

the timestamp of the interaction to be returned. It is measured as the number of microseconds since the Epoch.

$interactionType : string

The type of the interaction to be returned.

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

Optional parameters.

Return values
Google_Service_Cih_UserInteraction —

listUserInteractions()

Get a list of interactions for the given entity and its relatives if requested. The returned list is sorted by timestamp in descending order.

public listUserInteractions(string|array<string|int, mixed> $entity[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Cih_UserInteractionsListResponse

(userInteractions.listUserInteractions)

Parameters
$entity : string|array<string|int, mixed>

List of entities to retrieve. At least one item must be present. Each item must be in 'ENTITY_TYPE:ENTITY_ID' format which ENTITY_TYPE is COMPANY, ADWORDS_CID, EMAIL, ADDRESS_DIGEST or GAIA_ID.

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

Optional parameters.

Tags
opt_param

string entityFilter Primary or secondary entities, if available only interactions whose primary or secondary entities are given are returned. For info about the format of this field see the comments of UserInteractionsApiaryFilter proto.

opt_param

bool excludePassedInteractionOrigin Indicates the inclusive or exclusive behavior of interactionOrigin field. See the description of interactionOrigin.

opt_param

bool excludePassedInteractionType Indicates the inclusive or exclusive behavior of interactionType field. See the description of interactionType.

opt_param

bool includeRelatedInteractions By default, all interactions which apply to any member of the entity structure which contains the provided entity are returned. If include_related_interactions is false, then only the interactions which are associated directly with this entity are returned, and neither parent_entity nor child_entities in the Entity object returned by this operation are populated.

opt_param

string interactionOrigin This limit is ignored if absent and all interactions regardless of their origin will be returned. Otherwise the meaning of this field depends on the include_interaction_origin field. 1. exclude_passed_interaction_origin is true: Only interactions whose Origin is contained in interaction_origin will be returned. 2. exclude_passed_interaction_origin is false: Only interactions whose Origin isn't contained in interaction_origin will be returned.

opt_param

string interactionType This limit is ignored if absent and all interactions regardless of their type will be returned. Otherwise the meaning of this field depends on the exclude_passed_interaction_type field. 1. exclude_passed_interaction_type is true: Only interactions whose Type is contained in interaction_type will be returned. 2. exclude_passed_interaction_type is false: Only interactions whose Type isn't contained in interaction_type will be returned.

opt_param

bool lookup_participant_info Request to get additional information about interaction participants, such as names, email addresses. May increase latency of this call.

opt_param

int maxInteractionsPerPage The limit on the number of returned interactions. This is the maximum number of interactions which will be returned, starting with the most recent. Thie default value is 100. If it is equal to zero then only the entity structure is returned.

opt_param

string maxResults The maximum number of results per page.

opt_param

string metaTypeFilter Represents the interaction's classification. Possible values: SALES, SUPPORT, MARKETING. For more info see http://go/cih- gt-api

opt_param

int minMainEntityInteractions Attempt to read at least this many main entity interactions. The default value is set to 0. Pagination is disabled if a positive value is set.

opt_param

string pageToken The pagination token.

opt_param

string phoneMatcher If available only interactions whose phone number is given are returned. For info about the format of this field see the comments of UserInteractionsApiaryFilter proto.

opt_param

string timestampEnd Upper limit on the timestamp for the returned interactions. It is measured as the number of microseconds since the Epoch.

opt_param

string timestampStart Lower limit on the timestamp for the returned interactions. It is measured as the number of microseconds since the Epoch.

Return values
Google_Service_Cih_UserInteractionsListResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results