Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class DocumentInfo.
Detailed document information associated with a user event.
Generated from protobuf message google.cloud.discoveryengine.v1beta.DocumentInfo
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ id
string
Required. The Document resource ID.
↳ name
string
Required. The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}
↳ quantity
int
Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 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.
getId
Required. The Document resource ID.
string
hasId
setId
Required. The Document resource ID.
var
string
$this
getName
Required. The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}
string
hasName
setName
Required. The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}
var
string
$this
getQuantity
Quantity of the Document associated with the user event. Defaults to 1.
For example, this field will be 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 will be 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
getDocumentDescriptor
string
