google-apis-discoveryengine_v1beta 0.14.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +148 -88
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +29 -0
- data/lib/google/apis/discoveryengine_v1beta/service.rb +8 -8
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: eda2601833d0c3308a8af301e4d31528e7e675e5a711c6dd3d18f5a0c9b4be18
|
4
|
+
data.tar.gz: d3457589221386fa6727c33f65644321af14fa029372aaa0d533a252b3cd2629
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eefa84ad2f2699d6d8e1ea1faef87dcce120697d898cc4e19ac0f800c0e7de72b4f3db2f047fa7356557a03d012319d1c6a9c4f167483b5068bdfb0d716d75e8
|
7
|
+
data.tar.gz: ead23fd38e7d99cedcc90eaec55d1867a49d1a9b1e4ea45b6cd0ef46c0f20e1d8c44e65577585542fd2e4f412093a3453909f2dae028b1ad53bb1fbbcf6b20e9
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-discoveryengine_v1beta
|
2
2
|
|
3
|
+
### v0.16.0 (2023-07-02)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20230623
|
6
|
+
|
7
|
+
### v0.15.0 (2023-06-25)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20230620
|
10
|
+
|
3
11
|
### v0.14.0 (2023-05-28)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20230525
|
@@ -276,8 +276,8 @@ module Google
|
|
276
276
|
end
|
277
277
|
end
|
278
278
|
|
279
|
-
# Metadata related to the progress of the ImportDocuments operation. This
|
280
|
-
#
|
279
|
+
# Metadata related to the progress of the ImportDocuments operation. This is
|
280
|
+
# returned by the google.longrunning.Operation.metadata field.
|
281
281
|
class GoogleCloudDiscoveryengineV1ImportDocumentsMetadata
|
282
282
|
include Google::Apis::Core::Hashable
|
283
283
|
|
@@ -347,7 +347,7 @@ module Google
|
|
347
347
|
include Google::Apis::Core::Hashable
|
348
348
|
|
349
349
|
# Cloud Storage prefix for import errors. This must be an empty, existing Cloud
|
350
|
-
# Storage directory. Import errors
|
350
|
+
# Storage directory. Import errors are written to sharded files in this
|
351
351
|
# directory, one per line, as a JSON-encoded `google.rpc.Status` message.
|
352
352
|
# Corresponds to the JSON property `gcsPrefix`
|
353
353
|
# @return [String]
|
@@ -363,8 +363,8 @@ module Google
|
|
363
363
|
end
|
364
364
|
end
|
365
365
|
|
366
|
-
# Metadata related to the progress of the Import operation. This
|
367
|
-
#
|
366
|
+
# Metadata related to the progress of the Import operation. This is returned by
|
367
|
+
# the google.longrunning.Operation.metadata field.
|
368
368
|
class GoogleCloudDiscoveryengineV1ImportUserEventsMetadata
|
369
369
|
include Google::Apis::Core::Hashable
|
370
370
|
|
@@ -563,8 +563,8 @@ module Google
|
|
563
563
|
end
|
564
564
|
end
|
565
565
|
|
566
|
-
# Metadata related to the progress of the ImportDocuments operation. This
|
567
|
-
#
|
566
|
+
# Metadata related to the progress of the ImportDocuments operation. This is
|
567
|
+
# returned by the google.longrunning.Operation.metadata field.
|
568
568
|
class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
|
569
569
|
include Google::Apis::Core::Hashable
|
570
570
|
|
@@ -634,7 +634,7 @@ module Google
|
|
634
634
|
include Google::Apis::Core::Hashable
|
635
635
|
|
636
636
|
# Cloud Storage prefix for import errors. This must be an empty, existing Cloud
|
637
|
-
# Storage directory. Import errors
|
637
|
+
# Storage directory. Import errors are written to sharded files in this
|
638
638
|
# directory, one per line, as a JSON-encoded `google.rpc.Status` message.
|
639
639
|
# Corresponds to the JSON property `gcsPrefix`
|
640
640
|
# @return [String]
|
@@ -650,8 +650,8 @@ module Google
|
|
650
650
|
end
|
651
651
|
end
|
652
652
|
|
653
|
-
# Metadata related to the progress of the Import operation. This
|
654
|
-
#
|
653
|
+
# Metadata related to the progress of the Import operation. This is returned by
|
654
|
+
# the google.longrunning.Operation.metadata field.
|
655
655
|
class GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata
|
656
656
|
include Google::Apis::Core::Hashable
|
657
657
|
|
@@ -797,6 +797,66 @@ module Google
|
|
797
797
|
end
|
798
798
|
end
|
799
799
|
|
800
|
+
# Metadata related to the progress of the PurgeUserEvents operation. This will
|
801
|
+
# be returned by the google.longrunning.Operation.metadata field.
|
802
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata
|
803
|
+
include Google::Apis::Core::Hashable
|
804
|
+
|
805
|
+
# Operation create time.
|
806
|
+
# Corresponds to the JSON property `createTime`
|
807
|
+
# @return [String]
|
808
|
+
attr_accessor :create_time
|
809
|
+
|
810
|
+
# Count of entries that encountered errors while processing.
|
811
|
+
# Corresponds to the JSON property `failureCount`
|
812
|
+
# @return [Fixnum]
|
813
|
+
attr_accessor :failure_count
|
814
|
+
|
815
|
+
# Count of entries that were deleted successfully.
|
816
|
+
# Corresponds to the JSON property `successCount`
|
817
|
+
# @return [Fixnum]
|
818
|
+
attr_accessor :success_count
|
819
|
+
|
820
|
+
# Operation last update time. If the operation is done, this is also the finish
|
821
|
+
# time.
|
822
|
+
# Corresponds to the JSON property `updateTime`
|
823
|
+
# @return [String]
|
824
|
+
attr_accessor :update_time
|
825
|
+
|
826
|
+
def initialize(**args)
|
827
|
+
update!(**args)
|
828
|
+
end
|
829
|
+
|
830
|
+
# Update properties of this object
|
831
|
+
def update!(**args)
|
832
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
833
|
+
@failure_count = args[:failure_count] if args.key?(:failure_count)
|
834
|
+
@success_count = args[:success_count] if args.key?(:success_count)
|
835
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
836
|
+
end
|
837
|
+
end
|
838
|
+
|
839
|
+
# Response of the PurgeUserEventsRequest. If the long running operation is
|
840
|
+
# successfully done, then this message is returned by the google.longrunning.
|
841
|
+
# Operations.response field.
|
842
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse
|
843
|
+
include Google::Apis::Core::Hashable
|
844
|
+
|
845
|
+
# The total count of events purged as a result of the operation.
|
846
|
+
# Corresponds to the JSON property `purgeCount`
|
847
|
+
# @return [Fixnum]
|
848
|
+
attr_accessor :purge_count
|
849
|
+
|
850
|
+
def initialize(**args)
|
851
|
+
update!(**args)
|
852
|
+
end
|
853
|
+
|
854
|
+
# Update properties of this object
|
855
|
+
def update!(**args)
|
856
|
+
@purge_count = args[:purge_count] if args.key?(:purge_count)
|
857
|
+
end
|
858
|
+
end
|
859
|
+
|
800
860
|
# Defines the structure and layout of a type of document data.
|
801
861
|
class GoogleCloudDiscoveryengineV1alphaSchema
|
802
862
|
include Google::Apis::Core::Hashable
|
@@ -835,12 +895,12 @@ module Google
|
|
835
895
|
class GoogleCloudDiscoveryengineV1alphaTargetSite
|
836
896
|
include Google::Apis::Core::Hashable
|
837
897
|
|
838
|
-
# Input only. If set to false,
|
839
|
-
#
|
840
|
-
# uri_pattern
|
898
|
+
# Input only. If set to false, a uri_pattern is generated to include all pages
|
899
|
+
# whose address contains the provided_uri_pattern. If set to true, an
|
900
|
+
# uri_pattern is generated to try to be an exact match of the
|
841
901
|
# provided_uri_pattern or just the specific page if the provided_uri_pattern is
|
842
|
-
# a specific one. provided_uri_pattern
|
843
|
-
#
|
902
|
+
# a specific one. provided_uri_pattern is always normalized to generate the URI
|
903
|
+
# pattern to be used by the search engine.
|
844
904
|
# Corresponds to the JSON property `exactMatch`
|
845
905
|
# @return [Boolean]
|
846
906
|
attr_accessor :exact_match
|
@@ -859,7 +919,7 @@ module Google
|
|
859
919
|
# @return [String]
|
860
920
|
attr_accessor :name
|
861
921
|
|
862
|
-
# Required. Input only. The user provided
|
922
|
+
# Required. Input only. The user provided URI pattern from which the `
|
863
923
|
# generated_uri_pattern` is generated.
|
864
924
|
# Corresponds to the JSON property `providedUriPattern`
|
865
925
|
# @return [String]
|
@@ -900,7 +960,7 @@ module Google
|
|
900
960
|
# values for document imports: * `document` (default): One Document format per
|
901
961
|
# row. Each document must have a valid Document.id and one of Document.json_data
|
902
962
|
# or Document.struct_data. * `custom`: One custom data per row in arbitrary
|
903
|
-
# format that conforms the defined Schema of the data store. This can only be
|
963
|
+
# format that conforms to the defined Schema of the data store. This can only be
|
904
964
|
# used by the GENERIC Data Store vertical.
|
905
965
|
# Corresponds to the JSON property `dataSchema`
|
906
966
|
# @return [String]
|
@@ -964,13 +1024,13 @@ module Google
|
|
964
1024
|
class GoogleCloudDiscoveryengineV1betaCompletionInfo
|
965
1025
|
include Google::Apis::Core::Hashable
|
966
1026
|
|
967
|
-
# End user selected CompleteQueryResponse.
|
1027
|
+
# End user selected CompleteQueryResponse.QuerySuggestion.suggestion position,
|
968
1028
|
# starting from 0.
|
969
1029
|
# Corresponds to the JSON property `selectedPosition`
|
970
1030
|
# @return [Fixnum]
|
971
1031
|
attr_accessor :selected_position
|
972
1032
|
|
973
|
-
# End user selected CompleteQueryResponse.
|
1033
|
+
# End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
|
974
1034
|
# Corresponds to the JSON property `selectedSuggestion`
|
975
1035
|
# @return [String]
|
976
1036
|
attr_accessor :selected_suggestion
|
@@ -1032,7 +1092,7 @@ module Google
|
|
1032
1092
|
attr_accessor :id
|
1033
1093
|
|
1034
1094
|
# The JSON string representation of the document. It should conform to the
|
1035
|
-
# registered Schema
|
1095
|
+
# registered Schema or an `INVALID_ARGUMENT` error is thrown.
|
1036
1096
|
# Corresponds to the JSON property `jsonData`
|
1037
1097
|
# @return [String]
|
1038
1098
|
attr_accessor :json_data
|
@@ -1058,7 +1118,7 @@ module Google
|
|
1058
1118
|
attr_accessor :schema_id
|
1059
1119
|
|
1060
1120
|
# The structured JSON data for the document. It should conform to the registered
|
1061
|
-
# Schema
|
1121
|
+
# Schema or an `INVALID_ARGUMENT` error is thrown.
|
1062
1122
|
# Corresponds to the JSON property `structData`
|
1063
1123
|
# @return [Hash<String,Object>]
|
1064
1124
|
attr_accessor :struct_data
|
@@ -1082,14 +1142,14 @@ module Google
|
|
1082
1142
|
class GoogleCloudDiscoveryengineV1betaDocumentInfo
|
1083
1143
|
include Google::Apis::Core::Hashable
|
1084
1144
|
|
1085
|
-
#
|
1145
|
+
# The Document resource ID.
|
1086
1146
|
# Corresponds to the JSON property `id`
|
1087
1147
|
# @return [String]
|
1088
1148
|
attr_accessor :id
|
1089
1149
|
|
1090
|
-
#
|
1091
|
-
#
|
1092
|
-
#
|
1150
|
+
# The Document resource full name, of the form: `projects/`project_id`/locations/
|
1151
|
+
# `location`/collections/`collection_id`/dataStores/`data_store_id`/branches/`
|
1152
|
+
# branch_id`/documents/`document_id``
|
1093
1153
|
# Corresponds to the JSON property `name`
|
1094
1154
|
# @return [String]
|
1095
1155
|
attr_accessor :name
|
@@ -1108,8 +1168,7 @@ module Google
|
|
1108
1168
|
# @return [Fixnum]
|
1109
1169
|
attr_accessor :quantity
|
1110
1170
|
|
1111
|
-
#
|
1112
|
-
# PUBLIC_WEBSITE.
|
1171
|
+
# The Document URI - only allowed for website data stores.
|
1113
1172
|
# Corresponds to the JSON property `uri`
|
1114
1173
|
# @return [String]
|
1115
1174
|
attr_accessor :uri
|
@@ -1135,11 +1194,13 @@ module Google
|
|
1135
1194
|
# The schema to use when parsing the data from the source. Supported values for
|
1136
1195
|
# document imports: * `document` (default): One JSON Document per line. Each
|
1137
1196
|
# document must have a valid Document.id. * `content`: Unstructured data (e.g.
|
1138
|
-
# PDF, HTML). Each file matched by `input_uris`
|
1139
|
-
#
|
1140
|
-
#
|
1141
|
-
# Schema of the data store. This can only be used by
|
1142
|
-
#
|
1197
|
+
# PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID
|
1198
|
+
# set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`:
|
1199
|
+
# One custom data JSON per row in arbitrary format that conforms to the defined
|
1200
|
+
# Schema of the data store. This can only be used by Gen App Builder. * `csv`: A
|
1201
|
+
# CSV file with header conforming to the defined Schema of the data store. Each
|
1202
|
+
# entry after the header is imported as a Document. This can only be used by Gen
|
1203
|
+
# App Builder. Supported values for user even imports: * `user_event` (default):
|
1143
1204
|
# One JSON UserEvent per line.
|
1144
1205
|
# Corresponds to the JSON property `dataSchema`
|
1145
1206
|
# @return [String]
|
@@ -1166,8 +1227,8 @@ module Google
|
|
1166
1227
|
end
|
1167
1228
|
end
|
1168
1229
|
|
1169
|
-
# Metadata related to the progress of the ImportDocuments operation. This
|
1170
|
-
#
|
1230
|
+
# Metadata related to the progress of the ImportDocuments operation. This is
|
1231
|
+
# returned by the google.longrunning.Operation.metadata field.
|
1171
1232
|
class GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata
|
1172
1233
|
include Google::Apis::Core::Hashable
|
1173
1234
|
|
@@ -1214,10 +1275,10 @@ module Google
|
|
1214
1275
|
# payload, where IDs may not be consistent during multiple imports. In which
|
1215
1276
|
# case ReconciliationMode.FULL is highly recommended to avoid duplicate contents.
|
1216
1277
|
# If unset or set to `false`, Document.ids have to be specified using id_field,
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
#
|
1220
|
-
# error is thrown.
|
1278
|
+
# otherwise, documents without IDs fail to be imported. Only set this field when
|
1279
|
+
# using GcsSource or BigQuerySource, and when GcsSource.data_schema or
|
1280
|
+
# BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an
|
1281
|
+
# INVALID_ARGUMENT error is thrown.
|
1221
1282
|
# Corresponds to the JSON property `autoGenerateIds`
|
1222
1283
|
# @return [Boolean]
|
1223
1284
|
attr_accessor :auto_generate_ids
|
@@ -1242,15 +1303,15 @@ module Google
|
|
1242
1303
|
# IDs of the documents. For GcsSource it is the key of the JSON field. For
|
1243
1304
|
# instance, `my_id` for JSON ``"my_id": "some_uuid"``. For BigQuerySource it is
|
1244
1305
|
# the column name of the BigQuery table where the unique ids are stored. The
|
1245
|
-
# values of the JSON field or the BigQuery column
|
1246
|
-
#
|
1247
|
-
#
|
1248
|
-
#
|
1249
|
-
#
|
1250
|
-
#
|
1251
|
-
#
|
1252
|
-
#
|
1253
|
-
#
|
1306
|
+
# values of the JSON field or the BigQuery column are used as the Document.ids.
|
1307
|
+
# The JSON field or the BigQuery column must be of string type, and the values
|
1308
|
+
# must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/
|
1309
|
+
# rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to
|
1310
|
+
# be imported. Only set this field when using GcsSource or BigQuerySource, and
|
1311
|
+
# when GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And only
|
1312
|
+
# set this field when auto_generate_ids is unset or set as `false`. Otherwise,
|
1313
|
+
# an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is
|
1314
|
+
# used when importing from the allowed data sources.
|
1254
1315
|
# Corresponds to the JSON property `idField`
|
1255
1316
|
# @return [String]
|
1256
1317
|
attr_accessor :id_field
|
@@ -1334,7 +1395,7 @@ module Google
|
|
1334
1395
|
include Google::Apis::Core::Hashable
|
1335
1396
|
|
1336
1397
|
# Cloud Storage prefix for import errors. This must be an empty, existing Cloud
|
1337
|
-
# Storage directory. Import errors
|
1398
|
+
# Storage directory. Import errors are written to sharded files in this
|
1338
1399
|
# directory, one per line, as a JSON-encoded `google.rpc.Status` message.
|
1339
1400
|
# Corresponds to the JSON property `gcsPrefix`
|
1340
1401
|
# @return [String]
|
@@ -1350,8 +1411,8 @@ module Google
|
|
1350
1411
|
end
|
1351
1412
|
end
|
1352
1413
|
|
1353
|
-
# Metadata related to the progress of the Import operation. This
|
1354
|
-
#
|
1414
|
+
# Metadata related to the progress of the Import operation. This is returned by
|
1415
|
+
# the google.longrunning.Operation.metadata field.
|
1355
1416
|
class GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata
|
1356
1417
|
include Google::Apis::Core::Hashable
|
1357
1418
|
|
@@ -1549,10 +1610,10 @@ module Google
|
|
1549
1610
|
# path of category, use '>' sign to separate different hierarchies. If '>' is
|
1550
1611
|
# part of the category name, please replace it with other character(s). Category
|
1551
1612
|
# pages include special pages such as sales or promotions. For instance, a
|
1552
|
-
# special sale page may have the category hierarchy: "pageCategory" : "Sales >
|
1553
|
-
# 2017 Black Friday Deals"
|
1554
|
-
# event types should not set this field. Otherwise, an INVALID_ARGUMENT error
|
1555
|
-
# returned.
|
1613
|
+
# special sale page may have the category hierarchy: `"pageCategory" : "Sales >
|
1614
|
+
# 2017 Black Friday Deals"`. Required for `view-category-page` events. Other
|
1615
|
+
# event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error
|
1616
|
+
# is returned.
|
1556
1617
|
# Corresponds to the JSON property `pageCategory`
|
1557
1618
|
# @return [String]
|
1558
1619
|
attr_accessor :page_category
|
@@ -1560,10 +1621,10 @@ module Google
|
|
1560
1621
|
# A unique ID of a web page view. This should be kept the same for all user
|
1561
1622
|
# events triggered from the same pageview. For example, an item detail page view
|
1562
1623
|
# could trigger multiple events as the user is browsing the page. The `
|
1563
|
-
#
|
1564
|
-
# can be grouped together properly. When using the client side event
|
1565
|
-
# with JavaScript pixel and Google Tag Manager, this value is filled
|
1566
|
-
# automatically.
|
1624
|
+
# pageview_id` property should be kept the same for all these events so that
|
1625
|
+
# they can be grouped together properly. When using the client side event
|
1626
|
+
# reporting with JavaScript pixel and Google Tag Manager, this value is filled
|
1627
|
+
# in automatically.
|
1567
1628
|
# Corresponds to the JSON property `pageviewId`
|
1568
1629
|
# @return [String]
|
1569
1630
|
attr_accessor :pageview_id
|
@@ -1935,28 +1996,29 @@ module Google
|
|
1935
1996
|
|
1936
1997
|
# An integer that specifies the current offset for pagination (the 0-indexed
|
1937
1998
|
# starting location, amongst the products deemed by the API as relevant). See
|
1938
|
-
# SearchRequest.offset for definition. If this field is negative, an
|
1939
|
-
# INVALID_ARGUMENT is returned. This can only be set for `search` events. Other
|
1940
|
-
# event types should not set this field. Otherwise, an INVALID_ARGUMENT error
|
1941
|
-
# returned.
|
1999
|
+
# SearchRequest.offset for definition. If this field is negative, an `
|
2000
|
+
# INVALID_ARGUMENT` is returned. This can only be set for `search` events. Other
|
2001
|
+
# event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error
|
2002
|
+
# is returned.
|
1942
2003
|
# Corresponds to the JSON property `offset`
|
1943
2004
|
# @return [Fixnum]
|
1944
2005
|
attr_accessor :offset
|
1945
2006
|
|
1946
2007
|
# The order in which products are returned, if applicable. See SearchRequest.
|
1947
2008
|
# order_by for definition and syntax. The value must be a UTF-8 encoded string
|
1948
|
-
# with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT
|
1949
|
-
# is returned. This can only be set for `search` events. Other event types
|
1950
|
-
# should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.
|
2009
|
+
# with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT`
|
2010
|
+
# error is returned. This can only be set for `search` events. Other event types
|
2011
|
+
# should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
1951
2012
|
# Corresponds to the JSON property `orderBy`
|
1952
2013
|
# @return [String]
|
1953
2014
|
attr_accessor :order_by
|
1954
2015
|
|
1955
2016
|
# The user's search query. See SearchRequest.query for definition. The value
|
1956
2017
|
# must be a UTF-8 encoded string with a length limit of 5,000 characters.
|
1957
|
-
# Otherwise, an INVALID_ARGUMENT error is returned. At least one of
|
1958
|
-
# or PageInfo.page_category is required for `search` events. Other
|
1959
|
-
# should not set this field. Otherwise, an INVALID_ARGUMENT error
|
2018
|
+
# Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of
|
2019
|
+
# search_query or PageInfo.page_category is required for `search` events. Other
|
2020
|
+
# event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error
|
2021
|
+
# is returned.
|
1960
2022
|
# Corresponds to the JSON property `searchQuery`
|
1961
2023
|
# @return [String]
|
1962
2024
|
attr_accessor :search_query
|
@@ -2051,7 +2113,7 @@ module Google
|
|
2051
2113
|
# values are not allowed. Each value must be a UTF-8 encoded string with a
|
2052
2114
|
# length limit of 256 characters. * For number attributes, at most 400 values
|
2053
2115
|
# are allowed. For product recommendations, an example of extra user information
|
2054
|
-
# is `
|
2116
|
+
# is `traffic_channel`, which is how a user arrives at the site. Users can
|
2055
2117
|
# arrive at the site by coming to the site directly, coming through Google
|
2056
2118
|
# search, or in other ways.
|
2057
2119
|
# Corresponds to the JSON property `attributes`
|
@@ -2061,17 +2123,16 @@ module Google
|
|
2061
2123
|
# Token to attribute an API response to user action(s) to trigger the event.
|
2062
2124
|
# Highly recommended for user events that are the result of
|
2063
2125
|
# RecommendationService.Recommend. This field enables accurate attribution of
|
2064
|
-
# recommendation model performance. The value must be one of: *
|
2065
|
-
# attribution_token for events that are the result of
|
2066
|
-
# Recommend. * SearchResponse.attribution_token for events
|
2067
|
-
# of SearchService.Search.
|
2068
|
-
#
|
2069
|
-
#
|
2070
|
-
#
|
2071
|
-
#
|
2072
|
-
#
|
2073
|
-
#
|
2074
|
-
# attribution_token to this field.
|
2126
|
+
# recommendation model performance. The value must be one of: *
|
2127
|
+
# RecommendResponse.attribution_token for events that are the result of
|
2128
|
+
# RecommendationService.Recommend. * SearchResponse.attribution_token for events
|
2129
|
+
# that are the result of SearchService.Search. This token enables us to
|
2130
|
+
# accurately attribute page view or conversion completion back to the event and
|
2131
|
+
# the particular predict response containing this clicked/purchased product. If
|
2132
|
+
# user clicks on product K in the recommendation results, pass RecommendResponse.
|
2133
|
+
# attribution_token as a URL parameter to product K's page. When recording
|
2134
|
+
# events on product K's page, log the RecommendResponse.attribution_token to
|
2135
|
+
# this field.
|
2075
2136
|
# Corresponds to the JSON property `attributionToken`
|
2076
2137
|
# @return [String]
|
2077
2138
|
attr_accessor :attribution_token
|
@@ -2130,7 +2191,7 @@ module Google
|
|
2130
2191
|
# RecommendationService.RecommendRequest, this field may be populated directly
|
2131
2192
|
# from RecommendationService.RecommendRequest.filter conforming to https://
|
2132
2193
|
# google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a
|
2133
|
-
# length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is
|
2194
|
+
# length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
2134
2195
|
# returned.
|
2135
2196
|
# Corresponds to the JSON property `filter`
|
2136
2197
|
# @return [String]
|
@@ -2195,7 +2256,7 @@ module Google
|
|
2195
2256
|
# visitor log in/out of the website. Do not set the field to the same fixed ID
|
2196
2257
|
# for different users. This mixes the event history of those users together,
|
2197
2258
|
# which results in degraded model quality. The field must be a UTF-8 encoded
|
2198
|
-
# string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
|
2259
|
+
# string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT`
|
2199
2260
|
# error is returned. The field should not contain PII or user-data. We recommend
|
2200
2261
|
# to use Google Analytics [Client ID](https://developers.google.com/analytics/
|
2201
2262
|
# devguides/collection/analyticsjs/field-reference#clientId) for this field.
|
@@ -2234,12 +2295,11 @@ module Google
|
|
2234
2295
|
class GoogleCloudDiscoveryengineV1betaUserInfo
|
2235
2296
|
include Google::Apis::Core::Hashable
|
2236
2297
|
|
2237
|
-
# User agent as included in the HTTP header.
|
2238
|
-
#
|
2239
|
-
#
|
2240
|
-
#
|
2241
|
-
#
|
2242
|
-
# direct_user_request is set.
|
2298
|
+
# User agent as included in the HTTP header. The field must be a UTF-8 encoded
|
2299
|
+
# string with a length limit of 1,000 characters. Otherwise, an `
|
2300
|
+
# INVALID_ARGUMENT` error is returned. This should not be set when using the
|
2301
|
+
# client side event reporting with GTM or JavaScript tag in UserEventService.
|
2302
|
+
# CollectUserEvent or if UserEvent.direct_user_request is set.
|
2243
2303
|
# Corresponds to the JSON property `userAgent`
|
2244
2304
|
# @return [String]
|
2245
2305
|
attr_accessor :user_agent
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module DiscoveryengineV1beta
|
18
18
|
# Version of the google-apis-discoveryengine_v1beta gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.16.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.12.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20230623"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -160,6 +160,18 @@ module Google
|
|
160
160
|
include Google::Apis::Core::JsonObjectSupport
|
161
161
|
end
|
162
162
|
|
163
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata
|
164
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
165
|
+
|
166
|
+
include Google::Apis::Core::JsonObjectSupport
|
167
|
+
end
|
168
|
+
|
169
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse
|
170
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
171
|
+
|
172
|
+
include Google::Apis::Core::JsonObjectSupport
|
173
|
+
end
|
174
|
+
|
163
175
|
class GoogleCloudDiscoveryengineV1alphaSchema
|
164
176
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
165
177
|
|
@@ -601,6 +613,23 @@ module Google
|
|
601
613
|
end
|
602
614
|
end
|
603
615
|
|
616
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata
|
617
|
+
# @private
|
618
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
619
|
+
property :create_time, as: 'createTime'
|
620
|
+
property :failure_count, :numeric_string => true, as: 'failureCount'
|
621
|
+
property :success_count, :numeric_string => true, as: 'successCount'
|
622
|
+
property :update_time, as: 'updateTime'
|
623
|
+
end
|
624
|
+
end
|
625
|
+
|
626
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse
|
627
|
+
# @private
|
628
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
629
|
+
property :purge_count, :numeric_string => true, as: 'purgeCount'
|
630
|
+
end
|
631
|
+
end
|
632
|
+
|
604
633
|
class GoogleCloudDiscoveryengineV1alphaSchema
|
605
634
|
# @private
|
606
635
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -205,8 +205,8 @@ module Google
|
|
205
205
|
# Required. The parent branch resource name, such as `projects/`project`/
|
206
206
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
207
207
|
# `branch``. Use `default_branch` as the branch ID, to list documents under the
|
208
|
-
# default branch. If the caller does not have permission to list
|
209
|
-
#
|
208
|
+
# default branch. If the caller does not have permission to list Documents under
|
209
|
+
# this branch, regardless of whether or not this branch exists, a `
|
210
210
|
# PERMISSION_DENIED` error is returned.
|
211
211
|
# @param [Fixnum] page_size
|
212
212
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
@@ -646,7 +646,7 @@ module Google
|
|
646
646
|
end
|
647
647
|
|
648
648
|
# Writes a single user event from the browser. This uses a GET request to due to
|
649
|
-
# browser restriction of POST-ing to a
|
649
|
+
# browser restriction of POST-ing to a third-party domain. This method is used
|
650
650
|
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
651
651
|
# Users should not call this method directly.
|
652
652
|
# @param [String] parent
|
@@ -659,7 +659,7 @@ module Google
|
|
659
659
|
# @param [String] uri
|
660
660
|
# The URL including cgi-parameters but excluding the hash fragment with a length
|
661
661
|
# limit of 5,000 characters. This is often more useful than the referer URL,
|
662
|
-
# because many browsers only send the domain for
|
662
|
+
# because many browsers only send the domain for third-party requests.
|
663
663
|
# @param [String] user_event
|
664
664
|
# Required. URL encoded UserEvent proto with a length limit of 2,000,000
|
665
665
|
# characters.
|
@@ -1063,8 +1063,8 @@ module Google
|
|
1063
1063
|
# Required. The parent branch resource name, such as `projects/`project`/
|
1064
1064
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
1065
1065
|
# `branch``. Use `default_branch` as the branch ID, to list documents under the
|
1066
|
-
# default branch. If the caller does not have permission to list
|
1067
|
-
#
|
1066
|
+
# default branch. If the caller does not have permission to list Documents under
|
1067
|
+
# this branch, regardless of whether or not this branch exists, a `
|
1068
1068
|
# PERMISSION_DENIED` error is returned.
|
1069
1069
|
# @param [Fixnum] page_size
|
1070
1070
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
@@ -1433,7 +1433,7 @@ module Google
|
|
1433
1433
|
end
|
1434
1434
|
|
1435
1435
|
# Writes a single user event from the browser. This uses a GET request to due to
|
1436
|
-
# browser restriction of POST-ing to a
|
1436
|
+
# browser restriction of POST-ing to a third-party domain. This method is used
|
1437
1437
|
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
1438
1438
|
# Users should not call this method directly.
|
1439
1439
|
# @param [String] parent
|
@@ -1446,7 +1446,7 @@ module Google
|
|
1446
1446
|
# @param [String] uri
|
1447
1447
|
# The URL including cgi-parameters but excluding the hash fragment with a length
|
1448
1448
|
# limit of 5,000 characters. This is often more useful than the referer URL,
|
1449
|
-
# because many browsers only send the domain for
|
1449
|
+
# because many browsers only send the domain for third-party requests.
|
1450
1450
|
# @param [String] user_event
|
1451
1451
|
# Required. URL encoded UserEvent proto with a length limit of 2,000,000
|
1452
1452
|
# characters.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-discoveryengine_v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.16.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-07-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.16.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|