Optional. The conversion value associated with this Document.
Must be set if
[UserEvent.event_type][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.Document] resource full
name, of the form:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis webpage provides reference documentation for the \u003ccode\u003eDocumentInfo\u003c/code\u003e class within the Google Cloud Discovery Engine v1 API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDocumentInfo\u003c/code\u003e is a class that implements interfaces like \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and is used to store detailed information about a document.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the \u003ccode\u003eDocumentInfo\u003c/code\u003e class available is 1.6.0, and it offers methods like two constructors \u003ccode\u003eDocumentInfo()\u003c/code\u003e and \u003ccode\u003eDocumentInfo(DocumentInfo other)\u003c/code\u003e, along with properties to check the current state of a document.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDocumentInfo\u003c/code\u003e contains properties like \u003ccode\u003eId\u003c/code\u003e, \u003ccode\u003eName\u003c/code\u003e, \u003ccode\u003eQuantity\u003c/code\u003e, and \u003ccode\u003eUri\u003c/code\u003e to describe different attributes of a document, such as its resource ID, full name, associated quantity in a user event, and the document's URI.\u003c/p\u003e\n"],["\u003cp\u003eThe class allows developers to retrieve information about whether certain properties, like the resource ID or resource name, are set, and provides properties like \u003ccode\u003eJoined\u003c/code\u003e, which indicates whether the document can be found in the data store.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1 API - Class DocumentInfo (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.DocumentInfo)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.8.0/Google.Cloud.DiscoveryEngine.V1.DocumentInfo)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.7.0/Google.Cloud.DiscoveryEngine.V1.DocumentInfo)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.6.0/Google.Cloud.DiscoveryEngine.V1.DocumentInfo)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.5.0/Google.Cloud.DiscoveryEngine.V1.DocumentInfo)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.4.0/Google.Cloud.DiscoveryEngine.V1.DocumentInfo)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.3.0/Google.Cloud.DiscoveryEngine.V1.DocumentInfo)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.2.0/Google.Cloud.DiscoveryEngine.V1.DocumentInfo)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.1.0/Google.Cloud.DiscoveryEngine.V1.DocumentInfo)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.0.0-beta06/Google.Cloud.DiscoveryEngine.V1.DocumentInfo) \n\n public sealed class DocumentInfo : IMessage\u003cDocumentInfo\u003e, IEquatable\u003cDocumentInfo\u003e, IDeepCloneable\u003cDocumentInfo\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Discovery Engine v1 API class DocumentInfo.\n\nDetailed document information associated with a user event. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e DocumentInfo \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[DocumentInfo](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.DocumentInfo), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[DocumentInfo](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.DocumentInfo), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[DocumentInfo](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.DocumentInfo), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DiscoveryEngine.V1](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1.dll\n\nConstructors\n------------\n\n### DocumentInfo()\n\n public DocumentInfo()\n\n### DocumentInfo(DocumentInfo)\n\n public DocumentInfo(DocumentInfo other)\n\nProperties\n----------\n\n### ConversionValue\n\n public float ConversionValue { get; set; }\n\nOptional. The conversion value associated with this Document.\nMust be set if\n\\[UserEvent.event_type\\]\\[google.cloud.discoveryengine.v1.UserEvent.event_type\\]\nis \"conversion\".\n\nFor example, a value of 1000 signifies that 1000 seconds were spent viewing\na Document for the `watch` conversion type.\n\n### DocumentDescriptorCase\n\n public DocumentInfo.DocumentDescriptorOneofCase DocumentDescriptorCase { get; }\n\n### DocumentName\n\n public DocumentName DocumentName { get; set; }\n\n[DocumentName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.DocumentName)-typed view over the [Name](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.DocumentInfo#Google_Cloud_DiscoveryEngine_V1_DocumentInfo_Name) resource name property.\n\n### HasConversionValue\n\n public bool HasConversionValue { get; }\n\nGets whether the \"conversion_value\" field is set\n\n### HasId\n\n public bool HasId { get; }\n\nGets whether the \"id\" field is set\n\n### HasName\n\n public bool HasName { get; }\n\nGets whether the \"name\" field is set\n\n### HasQuantity\n\n public bool HasQuantity { get; }\n\nGets whether the \"quantity\" field is set\n\n### HasUri\n\n public bool HasUri { get; }\n\nGets whether the \"uri\" field is set\n\n### Id\n\n public string Id { get; set; }\n\nThe \\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\] resource ID.\n\n### Joined\n\n public bool Joined { get; set; }\n\nOutput only. Whether the referenced Document can be found in the data\nstore.\n\n### Name\n\n public string Name { get; set; }\n\nThe \\[Document\\]\\[google.cloud.discoveryengine.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### PromotionIds\n\n public RepeatedField\u003cstring\u003e PromotionIds { get; }\n\nThe promotion IDs associated with this Document.\nCurrently, this field is restricted to at most one ID.\n\n### Quantity\n\n public int Quantity { get; set; }\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.\n\nRequired for events of the following event types:\n\n- `add-to-cart`\n- `purchase`\n\n### Uri\n\n public string Uri { get; set; }\n\nThe \\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\] URI - only\nallowed for website data stores."]]
