Detailed document information associated with a user event.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
str
The Document
resource ID.
This field is a member of oneof_ document_descriptor.
name
str
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}
This field is a member of oneof_ document_descriptor.
uri
str
The Document
URI - only allowed for website data stores.
This field is a member of oneof_ document_descriptor.
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
This field is a member of oneof_ _quantity.
promotion_ids
MutableSequence[str]
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.
[[["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-08-07 UTC."],[],[],null,["# Class DocumentInfo (0.13.11)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.11 (latest)](/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.13.10](/python/docs/reference/discoveryengine/0.13.10/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.12.3](/python/docs/reference/discoveryengine/0.12.3/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.11.14](/python/docs/reference/discoveryengine/0.11.14/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.10.0](/python/docs/reference/discoveryengine/0.10.0/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.9.1](/python/docs/reference/discoveryengine/0.9.1/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.8.1](/python/docs/reference/discoveryengine/0.8.1/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.7.0](/python/docs/reference/discoveryengine/0.7.0/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.6.0](/python/docs/reference/discoveryengine/0.6.0/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.5.0](/python/docs/reference/discoveryengine/0.5.0/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.4.1](/python/docs/reference/discoveryengine/0.4.1/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.3.1](/python/docs/reference/discoveryengine/0.3.1/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.2.1](/python/docs/reference/discoveryengine/0.2.1/google.cloud.discoveryengine_v1beta.types.DocumentInfo)\n- [0.1.1](/python/docs/reference/discoveryengine/0.1.1/google.cloud.discoveryengine_v1beta.types.DocumentInfo) \n\n DocumentInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nDetailed document information associated with a user event.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e"]]