Package types (0.2.1)

API documentation for discoveryengine_v1beta.types package.

Classes

BigQuerySource

BigQuery source import data from.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CollectUserEventRequest

Request message for CollectUserEvent method.

CompletionInfo

Detailed completion information including completion attribution token and clicked completion info.

CreateDocumentRequest

Request message for DocumentService.CreateDocument method.

CustomAttribute

A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.

DeleteDocumentRequest

Request message for DocumentService.DeleteDocument method.

Document

Document captures all raw metadata information of items to be recommended or searched.

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

DocumentInfo

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

GcsSource

Google Cloud Storage location for input content. format.

GetDocumentRequest

Request message for DocumentService.GetDocument method.

ImportDocumentsMetadata

Metadata related to the progress of the ImportDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

ImportDocumentsRequest

Request message for Import methods.

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

ImportDocumentsResponse

Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

ImportErrorConfig

Configuration of destination for Import related errors.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportUserEventsMetadata

Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.

ImportUserEventsRequest

Request message for the ImportUserEvents request.

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

ImportUserEventsResponse

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

ListDocumentsRequest

Request message for DocumentService.ListDocuments method.

ListDocumentsResponse

Response message for DocumentService.ListDocuments method.

MediaInfo

Media-specific user event information.

PageInfo

Detailed page information.

PanelInfo

Detailed panel information associated with a user event.

RecommendRequest

Request message for Recommend method.

RecommendResponse

Response message for Recommend method.

SearchInfo

Detailed search information.

TransactionInfo

A transaction represents the entire purchase transaction.

UpdateDocumentRequest

Request message for DocumentService.UpdateDocument method.

UserEvent

UserEvent captures all metadata information DiscoveryEngine API needs to know about how end users interact with customers' website.

UserInfo

Information of an end user.

WriteUserEventRequest

Request message for WriteUserEvent method.