Google Cloud Discovery Engine V1 Client - Class DocumentInfo (1.9.1)

Version latest

• 1.9.1 (latest)
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.1
• 1.4.0
• 1.3.3
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DocumentInfo.

Detailed document information associated with a user event.

Generated from protobuf message google.cloud.discoveryengine.v1.DocumentInfo

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ id	string The Document resource ID.
↳ name	string The Document resource full name, of the form: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}
↳ uri	string The Document URI - only allowed for website data stores.
↳ quantity	int Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a add-to-cart event. Required for events of the following event types: * * add-to-cart * * purchase
↳ promotion_ids	array The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
↳ joined	bool Output only. Whether the referenced Document can be found in the data store.
↳ conversion_value	float Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is "conversion". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the watch conversion type.

getId

The Document resource ID.

Returns
Type	Description
string

hasId

setId

The Document resource ID.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getName

The Document resource full name, of the form: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

Returns
Type	Description
string

hasName

setName

The Document resource full name, of the form: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getUri

The Document URI - only allowed for website data stores.

Returns
Type	Description
string

hasUri

setUri

The Document URI - only allowed for website data stores.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getQuantity

Quantity of the Document associated with the user event. Defaults to 1.

For example, this field is 2 if two quantities of the same Document are involved in a add-to-cart event. Required for events of the following event types:

• add-to-cart
• purchase

Returns
Type	Description
int

hasQuantity

clearQuantity

setQuantity

Quantity of the Document associated with the user event. Defaults to 1.

For example, this field is 2 if two quantities of the same Document are involved in a add-to-cart event. Required for events of the following event types:

• add-to-cart
• purchase

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPromotionIds

The promotion IDs associated with this Document.

Currently, this field is restricted to at most one ID.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPromotionIds

The promotion IDs associated with this Document.

Currently, this field is restricted to at most one ID.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getJoined

Output only. Whether the referenced Document can be found in the data store.

Returns
Type	Description
bool

setJoined

Output only. Whether the referenced Document can be found in the data store.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getConversionValue

Optional. The conversion value associated with this Document.

Must be set if UserEvent.event_type is "conversion". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the watch conversion type.

Returns
Type	Description
float

hasConversionValue

clearConversionValue

setConversionValue

Optional. The conversion value associated with this Document.

Must be set if UserEvent.event_type is "conversion". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the watch conversion type.

Parameter
Name	Description
var	float

Returns
Type	Description
$this

getDocumentDescriptor

Returns
Type	Description
string