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 \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
↳ 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.
string
hasId
setId
The Document resource ID.
var
string
$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}
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}
var
string
$this
getUri
The Document URI - only allowed for website data stores.
string
hasUri
setUri
The Document URI - only allowed for website data stores.
var
string
$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
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
var
int
$this
getPromotionIds
The promotion IDs associated with this Document.
Currently, this field is restricted to at most one ID.
setPromotionIds
The promotion IDs associated with this Document.
Currently, this field is restricted to at most one ID.
var
string[]
$this
getJoined
Output only. Whether the referenced Document can be found in the data store.
bool
setJoined
Output only. Whether the referenced Document can be found in the data store.
var
bool
$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.
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.
var
float
$this
getDocumentDescriptor
string
