DocumentInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
id |
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. |