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
Required. The Document resource ID. This field is a member of oneof _ document_descriptor .
|
name |
str
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}
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 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
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. |