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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class DocumentInfo (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.DocumentInfo)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.DocumentInfo)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.DocumentInfo)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.DocumentInfo)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.DocumentInfo)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.DocumentInfo)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.DocumentInfo)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.DocumentInfo)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.DocumentInfo)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.DocumentInfo)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.DocumentInfo)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.DocumentInfo)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.DocumentInfo)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.DocumentInfo)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.DocumentInfo)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.DocumentInfo)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.DocumentInfo) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DocumentInfo.\n\nDetailed document information associated with a user event.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.DocumentInfo`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getId\n\nThe [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document) resource ID.\n\n### hasId\n\n### setId\n\nThe [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document) resource ID.\n\n### getName\n\nThe [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document) resource full\nname, of the form:\n`projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`\n\n### hasName\n\n### setName\n\nThe [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document) resource full\nname, of the form:\n`projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`\n\n### getUri\n\nThe [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document) URI - only\nallowed for website data stores.\n\n### hasUri\n\n### setUri\n\nThe [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document) URI - only\nallowed for website data stores.\n\n### getQuantity\n\nQuantity of the Document associated with the user event. Defaults to 1.\n\nFor example, this field is 2 if two quantities of the same Document\nare involved in a `add-to-cart` event.\nRequired for events of the following event types:\n\n- `add-to-cart`\n- `purchase`\n\n### hasQuantity\n\n### clearQuantity\n\n### setQuantity\n\nQuantity of the Document associated with the user event. Defaults to 1.\n\nFor example, this field is 2 if two quantities of the same Document\nare involved in a `add-to-cart` event.\nRequired for events of the following event types:\n\n- `add-to-cart`\n- `purchase`\n\n### getPromotionIds\n\nThe promotion IDs associated with this Document.\n\nCurrently, this field is restricted to at most one ID.\n\n### setPromotionIds\n\nThe promotion IDs associated with this Document.\n\nCurrently, this field is restricted to at most one ID.\n\n### getJoined\n\nOutput only. Whether the referenced Document can be found in the data\nstore.\n\n### setJoined\n\nOutput only. Whether the referenced Document can be found in the data\nstore.\n\n### getConversionValue\n\nOptional. The conversion value associated with this Document.\n\nMust be set if\n[UserEvent.event_type](/php/docs/reference/cloud-discoveryengine/latest/V1.UserEvent#_Google_Cloud_DiscoveryEngine_V1_UserEvent__getEventType__)\nis \"conversion\".\nFor example, a value of 1000 signifies that 1000 seconds were spent viewing\na Document for the `watch` conversion type.\n\n### hasConversionValue\n\n### clearConversionValue\n\n### setConversionValue\n\nOptional. The conversion value associated with this Document.\n\nMust be set if\n[UserEvent.event_type](/php/docs/reference/cloud-discoveryengine/latest/V1.UserEvent#_Google_Cloud_DiscoveryEngine_V1_UserEvent__getEventType__)\nis \"conversion\".\nFor example, a value of 1000 signifies that 1000 seconds were spent viewing\na Document for the `watch` conversion type.\n\n### getDocumentDescriptor"]]
