@n8n-dev/n8n-nodes-googleapis-recommendationengine 1.0.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.
Files changed (22) hide show
  1. package/README.md +116 -0
  2. package/dist/banner.svg +155 -0
  3. package/dist/credentials/GoogleapisRecommendationengineApi.credentials.d.ts +9 -0
  4. package/dist/credentials/GoogleapisRecommendationengineApi.credentials.js +49 -0
  5. package/dist/credentials/GoogleapisRecommendationengineApi.credentials.js.map +1 -0
  6. package/dist/icons/googleapis-recommendationengine.dark.svg +21 -0
  7. package/dist/icons/googleapis-recommendationengine.svg +21 -0
  8. package/dist/nodes/GoogleapisRecommendationengine/GoogleapisRecommendationengine.node.d.ts +4 -0
  9. package/dist/nodes/GoogleapisRecommendationengine/GoogleapisRecommendationengine.node.js +54 -0
  10. package/dist/nodes/GoogleapisRecommendationengine/GoogleapisRecommendationengine.node.js.map +1 -0
  11. package/dist/nodes/GoogleapisRecommendationengine/GoogleapisRecommendationengine.node.json +20 -0
  12. package/dist/nodes/GoogleapisRecommendationengine/googleapis-recommendationengine.dark.svg +21 -0
  13. package/dist/nodes/GoogleapisRecommendationengine/googleapis-recommendationengine.svg +21 -0
  14. package/dist/nodes/GoogleapisRecommendationengine/resources/index.d.ts +1 -0
  15. package/dist/nodes/GoogleapisRecommendationengine/resources/index.js +6 -0
  16. package/dist/nodes/GoogleapisRecommendationengine/resources/index.js.map +1 -0
  17. package/dist/nodes/GoogleapisRecommendationengine/resources/projects/index.d.ts +2 -0
  18. package/dist/nodes/GoogleapisRecommendationengine/resources/projects/index.js +2361 -0
  19. package/dist/nodes/GoogleapisRecommendationengine/resources/projects/index.js.map +1 -0
  20. package/dist/package.json +62 -0
  21. package/dist/tsconfig.tsbuildinfo +1 -0
  22. package/package.json +62 -0
@@ -0,0 +1,2361 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.projectsDescription = void 0;
4
+ exports.projectsDescription = [
5
+ {
6
+ "displayName": "Operation",
7
+ "name": "operation",
8
+ "type": "options",
9
+ "noDataExpression": true,
10
+ "displayOptions": {
11
+ "show": {
12
+ "resource": [
13
+ "Projects"
14
+ ]
15
+ }
16
+ },
17
+ "options": [
18
+ {
19
+ "name": "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations Delete",
20
+ "value": "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations Delete",
21
+ "action": "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations Delete",
22
+ "description": "Unregister an apiKey from using for predict method.",
23
+ "routing": {
24
+ "request": {
25
+ "method": "DELETE",
26
+ "url": "=/v1beta1/{{$parameter[\"name\"]}}"
27
+ }
28
+ }
29
+ },
30
+ {
31
+ "name": "Recommendationengine Projects Locations Catalogs Operations Get",
32
+ "value": "Recommendationengine Projects Locations Catalogs Operations Get",
33
+ "action": "Recommendationengine Projects Locations Catalogs Operations Get",
34
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
35
+ "routing": {
36
+ "request": {
37
+ "method": "GET",
38
+ "url": "=/v1beta1/{{$parameter[\"name\"]}}"
39
+ }
40
+ }
41
+ },
42
+ {
43
+ "name": "Recommendationengine Projects Locations Catalogs Catalog Items Patch",
44
+ "value": "Recommendationengine Projects Locations Catalogs Catalog Items Patch",
45
+ "action": "Recommendationengine Projects Locations Catalogs Catalog Items Patch",
46
+ "description": "Updates a catalog item. Partial updating is supported. Non-existing items will be created.",
47
+ "routing": {
48
+ "request": {
49
+ "method": "PATCH",
50
+ "url": "=/v1beta1/{{$parameter[\"name\"]}}"
51
+ }
52
+ }
53
+ },
54
+ {
55
+ "name": "Recommendationengine Projects Locations Catalogs Operations List",
56
+ "value": "Recommendationengine Projects Locations Catalogs Operations List",
57
+ "action": "Recommendationengine Projects Locations Catalogs Operations List",
58
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
59
+ "routing": {
60
+ "request": {
61
+ "method": "GET",
62
+ "url": "=/v1beta1/{{$parameter[\"name\"]}}/operations"
63
+ }
64
+ }
65
+ },
66
+ {
67
+ "name": "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict",
68
+ "value": "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict",
69
+ "action": "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict",
70
+ "description": "Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](https://cloud.google.com/recommendations-ai/docs/setting-up#register-key).",
71
+ "routing": {
72
+ "request": {
73
+ "method": "POST",
74
+ "url": "=/v1beta1/{{$parameter[\"name\"]}}:predict"
75
+ }
76
+ }
77
+ },
78
+ {
79
+ "name": "Recommendationengine Projects Locations Catalogs Catalog Items List",
80
+ "value": "Recommendationengine Projects Locations Catalogs Catalog Items List",
81
+ "action": "Recommendationengine Projects Locations Catalogs Catalog Items List",
82
+ "description": "Gets a list of catalog items.",
83
+ "routing": {
84
+ "request": {
85
+ "method": "GET",
86
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/catalogItems"
87
+ }
88
+ }
89
+ },
90
+ {
91
+ "name": "Recommendationengine Projects Locations Catalogs Catalog Items Create",
92
+ "value": "Recommendationengine Projects Locations Catalogs Catalog Items Create",
93
+ "action": "Recommendationengine Projects Locations Catalogs Catalog Items Create",
94
+ "description": "Creates a catalog item.",
95
+ "routing": {
96
+ "request": {
97
+ "method": "POST",
98
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/catalogItems"
99
+ }
100
+ }
101
+ },
102
+ {
103
+ "name": "Recommendationengine Projects Locations Catalogs Catalog Items Import",
104
+ "value": "Recommendationengine Projects Locations Catalogs Catalog Items Import",
105
+ "action": "Recommendationengine Projects Locations Catalogs Catalog Items Import",
106
+ "description": "Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.",
107
+ "routing": {
108
+ "request": {
109
+ "method": "POST",
110
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/catalogItems:import"
111
+ }
112
+ }
113
+ },
114
+ {
115
+ "name": "Recommendationengine Projects Locations Catalogs List",
116
+ "value": "Recommendationengine Projects Locations Catalogs List",
117
+ "action": "Recommendationengine Projects Locations Catalogs List",
118
+ "description": "Lists all the catalog configurations associated with the project.",
119
+ "routing": {
120
+ "request": {
121
+ "method": "GET",
122
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/catalogs"
123
+ }
124
+ }
125
+ },
126
+ {
127
+ "name": "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations List",
128
+ "value": "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations List",
129
+ "action": "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations List",
130
+ "description": "List the registered apiKeys for use with predict method.",
131
+ "routing": {
132
+ "request": {
133
+ "method": "GET",
134
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/predictionApiKeyRegistrations"
135
+ }
136
+ }
137
+ },
138
+ {
139
+ "name": "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations Create",
140
+ "value": "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations Create",
141
+ "action": "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations Create",
142
+ "description": "Register an API key for use with predict method.",
143
+ "routing": {
144
+ "request": {
145
+ "method": "POST",
146
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/predictionApiKeyRegistrations"
147
+ }
148
+ }
149
+ },
150
+ {
151
+ "name": "Recommendationengine Projects Locations Catalogs Event Stores User Events List",
152
+ "value": "Recommendationengine Projects Locations Catalogs Event Stores User Events List",
153
+ "action": "Recommendationengine Projects Locations Catalogs Event Stores User Events List",
154
+ "description": "Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event.",
155
+ "routing": {
156
+ "request": {
157
+ "method": "GET",
158
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/userEvents"
159
+ }
160
+ }
161
+ },
162
+ {
163
+ "name": "Recommendationengine Projects Locations Catalogs Event Stores User Events Collect",
164
+ "value": "Recommendationengine Projects Locations Catalogs Event Stores User Events Collect",
165
+ "action": "Recommendationengine Projects Locations Catalogs Event Stores User Events Collect",
166
+ "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly.",
167
+ "routing": {
168
+ "request": {
169
+ "method": "GET",
170
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/userEvents:collect"
171
+ }
172
+ }
173
+ },
174
+ {
175
+ "name": "Recommendationengine Projects Locations Catalogs Event Stores User Events Import",
176
+ "value": "Recommendationengine Projects Locations Catalogs Event Stores User Events Import",
177
+ "action": "Recommendationengine Projects Locations Catalogs Event Stores User Events Import",
178
+ "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.",
179
+ "routing": {
180
+ "request": {
181
+ "method": "POST",
182
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/userEvents:import"
183
+ }
184
+ }
185
+ },
186
+ {
187
+ "name": "Recommendationengine Projects Locations Catalogs Event Stores User Events Purge",
188
+ "value": "Recommendationengine Projects Locations Catalogs Event Stores User Events Purge",
189
+ "action": "Recommendationengine Projects Locations Catalogs Event Stores User Events Purge",
190
+ "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.",
191
+ "routing": {
192
+ "request": {
193
+ "method": "POST",
194
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/userEvents:purge"
195
+ }
196
+ }
197
+ },
198
+ {
199
+ "name": "Recommendationengine Projects Locations Catalogs Event Stores User Events Rejoin",
200
+ "value": "Recommendationengine Projects Locations Catalogs Event Stores User Events Rejoin",
201
+ "action": "Recommendationengine Projects Locations Catalogs Event Stores User Events Rejoin",
202
+ "description": "Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of catalog items. It can also be used to correct events joined with wrong catalog items.",
203
+ "routing": {
204
+ "request": {
205
+ "method": "POST",
206
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/userEvents:rejoin"
207
+ }
208
+ }
209
+ },
210
+ {
211
+ "name": "Recommendationengine Projects Locations Catalogs Event Stores User Events Write",
212
+ "value": "Recommendationengine Projects Locations Catalogs Event Stores User Events Write",
213
+ "action": "Recommendationengine Projects Locations Catalogs Event Stores User Events Write",
214
+ "description": "Writes a single user event.",
215
+ "routing": {
216
+ "request": {
217
+ "method": "POST",
218
+ "url": "=/v1beta1/{{$parameter[\"parent\"]}}/userEvents:write"
219
+ }
220
+ }
221
+ }
222
+ ],
223
+ "default": ""
224
+ },
225
+ {
226
+ "displayName": "DELETE /v1beta1/{name}",
227
+ "name": "operation",
228
+ "type": "notice",
229
+ "typeOptions": {
230
+ "theme": "info"
231
+ },
232
+ "default": "",
233
+ "displayOptions": {
234
+ "show": {
235
+ "resource": [
236
+ "Projects"
237
+ ],
238
+ "operation": [
239
+ "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations Delete"
240
+ ]
241
+ }
242
+ }
243
+ },
244
+ {
245
+ "displayName": "Name",
246
+ "name": "name",
247
+ "required": true,
248
+ "description": "Required. The API key to unregister including full resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/`",
249
+ "default": "",
250
+ "type": "string",
251
+ "displayOptions": {
252
+ "show": {
253
+ "resource": [
254
+ "Projects"
255
+ ],
256
+ "operation": [
257
+ "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations Delete"
258
+ ]
259
+ }
260
+ }
261
+ },
262
+ {
263
+ "displayName": "GET /v1beta1/{name}",
264
+ "name": "operation",
265
+ "type": "notice",
266
+ "typeOptions": {
267
+ "theme": "info"
268
+ },
269
+ "default": "",
270
+ "displayOptions": {
271
+ "show": {
272
+ "resource": [
273
+ "Projects"
274
+ ],
275
+ "operation": [
276
+ "Recommendationengine Projects Locations Catalogs Operations Get"
277
+ ]
278
+ }
279
+ }
280
+ },
281
+ {
282
+ "displayName": "Name",
283
+ "name": "name",
284
+ "required": true,
285
+ "description": "The name of the operation resource.",
286
+ "default": "",
287
+ "type": "string",
288
+ "displayOptions": {
289
+ "show": {
290
+ "resource": [
291
+ "Projects"
292
+ ],
293
+ "operation": [
294
+ "Recommendationengine Projects Locations Catalogs Operations Get"
295
+ ]
296
+ }
297
+ }
298
+ },
299
+ {
300
+ "displayName": "PATCH /v1beta1/{name}",
301
+ "name": "operation",
302
+ "type": "notice",
303
+ "typeOptions": {
304
+ "theme": "info"
305
+ },
306
+ "default": "",
307
+ "displayOptions": {
308
+ "show": {
309
+ "resource": [
310
+ "Projects"
311
+ ],
312
+ "operation": [
313
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
314
+ ]
315
+ }
316
+ }
317
+ },
318
+ {
319
+ "displayName": "Name",
320
+ "name": "name",
321
+ "required": true,
322
+ "description": "Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.",
323
+ "default": "",
324
+ "type": "string",
325
+ "displayOptions": {
326
+ "show": {
327
+ "resource": [
328
+ "Projects"
329
+ ],
330
+ "operation": [
331
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
332
+ ]
333
+ }
334
+ }
335
+ },
336
+ {
337
+ "displayName": "Update Mask",
338
+ "name": "updateMask",
339
+ "description": "Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields.",
340
+ "default": "",
341
+ "type": "string",
342
+ "routing": {
343
+ "send": {
344
+ "type": "query",
345
+ "property": "updateMask",
346
+ "value": "={{ $value }}",
347
+ "propertyInDotNotation": false
348
+ }
349
+ },
350
+ "displayOptions": {
351
+ "show": {
352
+ "resource": [
353
+ "Projects"
354
+ ],
355
+ "operation": [
356
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
357
+ ]
358
+ }
359
+ }
360
+ },
361
+ {
362
+ "displayName": "Category Hierarchies",
363
+ "name": "categoryHierarchies",
364
+ "type": "json",
365
+ "default": "[\n {\n \"categories\": [\n null\n ]\n }\n]",
366
+ "description": "Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both [\"Shoes & Accessories\" -> \"Shoes\"] and [\"Sports & Fitness\" -> \"Athletic Clothing\" -> \"Shoes\"], it could be represented as: \"categoryHierarchies\": [ { \"categories\": [\"Shoes & Accessories\", \"Shoes\"]}, { \"categories\": [\"Sports & Fitness\", \"Athletic Clothing\", \"Shoes\"] } ]",
367
+ "routing": {
368
+ "send": {
369
+ "property": "categoryHierarchies",
370
+ "propertyInDotNotation": false,
371
+ "type": "body",
372
+ "value": "={{ JSON.parse($value) }}"
373
+ }
374
+ },
375
+ "displayOptions": {
376
+ "show": {
377
+ "resource": [
378
+ "Projects"
379
+ ],
380
+ "operation": [
381
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
382
+ ]
383
+ }
384
+ }
385
+ },
386
+ {
387
+ "displayName": "Description",
388
+ "name": "description",
389
+ "type": "string",
390
+ "default": "",
391
+ "description": "Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.",
392
+ "routing": {
393
+ "send": {
394
+ "property": "description",
395
+ "propertyInDotNotation": false,
396
+ "type": "body",
397
+ "value": "={{ $value }}"
398
+ }
399
+ },
400
+ "displayOptions": {
401
+ "show": {
402
+ "resource": [
403
+ "Projects"
404
+ ],
405
+ "operation": [
406
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
407
+ ]
408
+ }
409
+ }
410
+ },
411
+ {
412
+ "displayName": "ID",
413
+ "name": "id",
414
+ "type": "string",
415
+ "default": "",
416
+ "description": "Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.",
417
+ "routing": {
418
+ "send": {
419
+ "property": "id",
420
+ "propertyInDotNotation": false,
421
+ "type": "body",
422
+ "value": "={{ $value }}"
423
+ }
424
+ },
425
+ "displayOptions": {
426
+ "show": {
427
+ "resource": [
428
+ "Projects"
429
+ ],
430
+ "operation": [
431
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
432
+ ]
433
+ }
434
+ }
435
+ },
436
+ {
437
+ "displayName": "Item Attributes",
438
+ "name": "itemAttributes",
439
+ "type": "json",
440
+ "default": "{}",
441
+ "description": "FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.",
442
+ "routing": {
443
+ "send": {
444
+ "property": "itemAttributes",
445
+ "propertyInDotNotation": false,
446
+ "type": "body",
447
+ "value": "={{ JSON.parse($value) }}"
448
+ }
449
+ },
450
+ "displayOptions": {
451
+ "show": {
452
+ "resource": [
453
+ "Projects"
454
+ ],
455
+ "operation": [
456
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
457
+ ]
458
+ }
459
+ }
460
+ },
461
+ {
462
+ "displayName": "Item Group ID",
463
+ "name": "itemGroupId",
464
+ "type": "string",
465
+ "default": "",
466
+ "description": "Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).",
467
+ "routing": {
468
+ "send": {
469
+ "property": "itemGroupId",
470
+ "propertyInDotNotation": false,
471
+ "type": "body",
472
+ "value": "={{ $value }}"
473
+ }
474
+ },
475
+ "displayOptions": {
476
+ "show": {
477
+ "resource": [
478
+ "Projects"
479
+ ],
480
+ "operation": [
481
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
482
+ ]
483
+ }
484
+ }
485
+ },
486
+ {
487
+ "displayName": "Language Code",
488
+ "name": "languageCode",
489
+ "type": "string",
490
+ "default": "",
491
+ "description": "Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance.",
492
+ "routing": {
493
+ "send": {
494
+ "property": "languageCode",
495
+ "propertyInDotNotation": false,
496
+ "type": "body",
497
+ "value": "={{ $value }}"
498
+ }
499
+ },
500
+ "displayOptions": {
501
+ "show": {
502
+ "resource": [
503
+ "Projects"
504
+ ],
505
+ "operation": [
506
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
507
+ ]
508
+ }
509
+ }
510
+ },
511
+ {
512
+ "displayName": "Product Metadata",
513
+ "name": "productMetadata",
514
+ "type": "json",
515
+ "default": "{\n \"exactPrice\": {},\n \"images\": [\n {}\n ],\n \"priceRange\": {}\n}",
516
+ "description": "ProductCatalogItem captures item metadata specific to retail products.",
517
+ "routing": {
518
+ "send": {
519
+ "property": "productMetadata",
520
+ "propertyInDotNotation": false,
521
+ "type": "body",
522
+ "value": "={{ JSON.parse($value) }}"
523
+ }
524
+ },
525
+ "displayOptions": {
526
+ "show": {
527
+ "resource": [
528
+ "Projects"
529
+ ],
530
+ "operation": [
531
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
532
+ ]
533
+ }
534
+ }
535
+ },
536
+ {
537
+ "displayName": "Tags",
538
+ "name": "tags",
539
+ "type": "json",
540
+ "default": "[\n null\n]",
541
+ "description": "Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter.",
542
+ "routing": {
543
+ "send": {
544
+ "property": "tags",
545
+ "propertyInDotNotation": false,
546
+ "type": "body",
547
+ "value": "={{ JSON.parse($value) }}"
548
+ }
549
+ },
550
+ "displayOptions": {
551
+ "show": {
552
+ "resource": [
553
+ "Projects"
554
+ ],
555
+ "operation": [
556
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
557
+ ]
558
+ }
559
+ }
560
+ },
561
+ {
562
+ "displayName": "Title",
563
+ "name": "title",
564
+ "type": "string",
565
+ "default": "",
566
+ "description": "Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.",
567
+ "routing": {
568
+ "send": {
569
+ "property": "title",
570
+ "propertyInDotNotation": false,
571
+ "type": "body",
572
+ "value": "={{ $value }}"
573
+ }
574
+ },
575
+ "displayOptions": {
576
+ "show": {
577
+ "resource": [
578
+ "Projects"
579
+ ],
580
+ "operation": [
581
+ "Recommendationengine Projects Locations Catalogs Catalog Items Patch"
582
+ ]
583
+ }
584
+ }
585
+ },
586
+ {
587
+ "displayName": "GET /v1beta1/{name}/operations",
588
+ "name": "operation",
589
+ "type": "notice",
590
+ "typeOptions": {
591
+ "theme": "info"
592
+ },
593
+ "default": "",
594
+ "displayOptions": {
595
+ "show": {
596
+ "resource": [
597
+ "Projects"
598
+ ],
599
+ "operation": [
600
+ "Recommendationengine Projects Locations Catalogs Operations List"
601
+ ]
602
+ }
603
+ }
604
+ },
605
+ {
606
+ "displayName": "Name",
607
+ "name": "name",
608
+ "required": true,
609
+ "description": "The name of the operation's parent resource.",
610
+ "default": "",
611
+ "type": "string",
612
+ "displayOptions": {
613
+ "show": {
614
+ "resource": [
615
+ "Projects"
616
+ ],
617
+ "operation": [
618
+ "Recommendationengine Projects Locations Catalogs Operations List"
619
+ ]
620
+ }
621
+ }
622
+ },
623
+ {
624
+ "displayName": "Filter",
625
+ "name": "filter",
626
+ "description": "The standard list filter.",
627
+ "default": "",
628
+ "type": "string",
629
+ "routing": {
630
+ "send": {
631
+ "type": "query",
632
+ "property": "filter",
633
+ "value": "={{ $value }}",
634
+ "propertyInDotNotation": false
635
+ }
636
+ },
637
+ "displayOptions": {
638
+ "show": {
639
+ "resource": [
640
+ "Projects"
641
+ ],
642
+ "operation": [
643
+ "Recommendationengine Projects Locations Catalogs Operations List"
644
+ ]
645
+ }
646
+ }
647
+ },
648
+ {
649
+ "displayName": "Page Size",
650
+ "name": "pageSize",
651
+ "description": "The standard list page size.",
652
+ "default": 0,
653
+ "type": "number",
654
+ "routing": {
655
+ "send": {
656
+ "type": "query",
657
+ "property": "pageSize",
658
+ "value": "={{ $value }}",
659
+ "propertyInDotNotation": false
660
+ }
661
+ },
662
+ "displayOptions": {
663
+ "show": {
664
+ "resource": [
665
+ "Projects"
666
+ ],
667
+ "operation": [
668
+ "Recommendationengine Projects Locations Catalogs Operations List"
669
+ ]
670
+ }
671
+ }
672
+ },
673
+ {
674
+ "displayName": "Page Token",
675
+ "name": "pageToken",
676
+ "description": "The standard list page token.",
677
+ "default": "",
678
+ "type": "string",
679
+ "routing": {
680
+ "send": {
681
+ "type": "query",
682
+ "property": "pageToken",
683
+ "value": "={{ $value }}",
684
+ "propertyInDotNotation": false
685
+ }
686
+ },
687
+ "displayOptions": {
688
+ "show": {
689
+ "resource": [
690
+ "Projects"
691
+ ],
692
+ "operation": [
693
+ "Recommendationengine Projects Locations Catalogs Operations List"
694
+ ]
695
+ }
696
+ }
697
+ },
698
+ {
699
+ "displayName": "POST /v1beta1/{name}:predict",
700
+ "name": "operation",
701
+ "type": "notice",
702
+ "typeOptions": {
703
+ "theme": "info"
704
+ },
705
+ "default": "",
706
+ "displayOptions": {
707
+ "show": {
708
+ "resource": [
709
+ "Projects"
710
+ ],
711
+ "operation": [
712
+ "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict"
713
+ ]
714
+ }
715
+ }
716
+ },
717
+ {
718
+ "displayName": "Name",
719
+ "name": "name",
720
+ "required": true,
721
+ "default": "",
722
+ "type": "string",
723
+ "displayOptions": {
724
+ "show": {
725
+ "resource": [
726
+ "Projects"
727
+ ],
728
+ "operation": [
729
+ "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict"
730
+ ]
731
+ }
732
+ }
733
+ },
734
+ {
735
+ "displayName": "Dry Run",
736
+ "name": "dryRun",
737
+ "type": "boolean",
738
+ "default": true,
739
+ "description": "Optional. Use dryRun mode for this prediction query. If set to true, a fake model will be used that returns arbitrary catalog items. Note that the dryRun mode should only be used for testing the API, or if the model is not ready.",
740
+ "routing": {
741
+ "send": {
742
+ "property": "dryRun",
743
+ "propertyInDotNotation": false,
744
+ "type": "body",
745
+ "value": "={{ $value }}"
746
+ }
747
+ },
748
+ "displayOptions": {
749
+ "show": {
750
+ "resource": [
751
+ "Projects"
752
+ ],
753
+ "operation": [
754
+ "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict"
755
+ ]
756
+ }
757
+ }
758
+ },
759
+ {
760
+ "displayName": "Filter",
761
+ "name": "filter",
762
+ "type": "string",
763
+ "default": "",
764
+ "description": "Optional. Filter for restricting prediction results. Accepts values for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts predictions to items that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. `-\"tagA\"` is also supported and is equivalent to `NOT \"tagA\"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1 KiB. * filterOutOfStockItems. Restricts predictions to items that do not have a stockState value of OUT_OF_STOCK. Examples: * tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\") * filterOutOfStockItems tag=(-\"promotional\") * filterOutOfStockItems If your filter blocks all prediction results, nothing will be returned. If you want generic (unfiltered) popular items to be returned instead, set `strictFiltering` to false in `PredictRequest.params`.",
765
+ "routing": {
766
+ "send": {
767
+ "property": "filter",
768
+ "propertyInDotNotation": false,
769
+ "type": "body",
770
+ "value": "={{ $value }}"
771
+ }
772
+ },
773
+ "displayOptions": {
774
+ "show": {
775
+ "resource": [
776
+ "Projects"
777
+ ],
778
+ "operation": [
779
+ "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict"
780
+ ]
781
+ }
782
+ }
783
+ },
784
+ {
785
+ "displayName": "Labels",
786
+ "name": "labels",
787
+ "type": "json",
788
+ "default": "{}",
789
+ "description": "Optional. The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.",
790
+ "routing": {
791
+ "send": {
792
+ "property": "labels",
793
+ "propertyInDotNotation": false,
794
+ "type": "body",
795
+ "value": "={{ JSON.parse($value) }}"
796
+ }
797
+ },
798
+ "displayOptions": {
799
+ "show": {
800
+ "resource": [
801
+ "Projects"
802
+ ],
803
+ "operation": [
804
+ "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict"
805
+ ]
806
+ }
807
+ }
808
+ },
809
+ {
810
+ "displayName": "Page Size",
811
+ "name": "pageSize",
812
+ "type": "number",
813
+ "default": 0,
814
+ "description": "Optional. Maximum number of results to return per page. Set this property to the number of prediction results required. If zero, the service will choose a reasonable default.",
815
+ "routing": {
816
+ "send": {
817
+ "property": "pageSize",
818
+ "propertyInDotNotation": false,
819
+ "type": "body",
820
+ "value": "={{ $value }}"
821
+ }
822
+ },
823
+ "displayOptions": {
824
+ "show": {
825
+ "resource": [
826
+ "Projects"
827
+ ],
828
+ "operation": [
829
+ "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict"
830
+ ]
831
+ }
832
+ }
833
+ },
834
+ {
835
+ "displayName": "Page Token",
836
+ "name": "pageToken",
837
+ "type": "string",
838
+ "default": "",
839
+ "description": "Optional. The previous PredictResponse.next_page_token.",
840
+ "routing": {
841
+ "send": {
842
+ "property": "pageToken",
843
+ "propertyInDotNotation": false,
844
+ "type": "body",
845
+ "value": "={{ $value }}"
846
+ }
847
+ },
848
+ "displayOptions": {
849
+ "show": {
850
+ "resource": [
851
+ "Projects"
852
+ ],
853
+ "operation": [
854
+ "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict"
855
+ ]
856
+ }
857
+ }
858
+ },
859
+ {
860
+ "displayName": "Params",
861
+ "name": "params",
862
+ "type": "json",
863
+ "default": "{}",
864
+ "description": "Optional. Additional domain specific parameters for the predictions. Allowed values: * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem object will be returned in the `PredictResponse.PredictionResult.itemMetadata` object in the method response. * `returnItemScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the `metadata` field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular items instead of empty if your filter blocks all prediction results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-price-reranking', 'low-price-reranking', 'medium-price-reranking', 'high-price-reranking'}. This gives request level control and adjust prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-diversity', 'low-diversity', 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives request level control and adjust prediction results based on product category.",
865
+ "routing": {
866
+ "send": {
867
+ "property": "params",
868
+ "propertyInDotNotation": false,
869
+ "type": "body",
870
+ "value": "={{ JSON.parse($value) }}"
871
+ }
872
+ },
873
+ "displayOptions": {
874
+ "show": {
875
+ "resource": [
876
+ "Projects"
877
+ ],
878
+ "operation": [
879
+ "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict"
880
+ ]
881
+ }
882
+ }
883
+ },
884
+ {
885
+ "displayName": "User Event",
886
+ "name": "userEvent",
887
+ "type": "json",
888
+ "default": "{\n \"eventDetail\": {\n \"eventAttributes\": {},\n \"experimentIds\": [\n null\n ]\n },\n \"productEventDetail\": {\n \"pageCategories\": [\n {\n \"categories\": [\n null\n ]\n }\n ],\n \"productDetails\": [\n {\n \"itemAttributes\": {}\n }\n ],\n \"purchaseTransaction\": {}\n },\n \"userInfo\": {}\n}",
889
+ "description": "UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.",
890
+ "routing": {
891
+ "send": {
892
+ "property": "userEvent",
893
+ "propertyInDotNotation": false,
894
+ "type": "body",
895
+ "value": "={{ JSON.parse($value) }}"
896
+ }
897
+ },
898
+ "displayOptions": {
899
+ "show": {
900
+ "resource": [
901
+ "Projects"
902
+ ],
903
+ "operation": [
904
+ "Recommendationengine Projects Locations Catalogs Event Stores Placements Predict"
905
+ ]
906
+ }
907
+ }
908
+ },
909
+ {
910
+ "displayName": "GET /v1beta1/{parent}/catalogItems",
911
+ "name": "operation",
912
+ "type": "notice",
913
+ "typeOptions": {
914
+ "theme": "info"
915
+ },
916
+ "default": "",
917
+ "displayOptions": {
918
+ "show": {
919
+ "resource": [
920
+ "Projects"
921
+ ],
922
+ "operation": [
923
+ "Recommendationengine Projects Locations Catalogs Catalog Items List"
924
+ ]
925
+ }
926
+ }
927
+ },
928
+ {
929
+ "displayName": "Parent",
930
+ "name": "parent",
931
+ "required": true,
932
+ "description": "Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.",
933
+ "default": "",
934
+ "type": "string",
935
+ "displayOptions": {
936
+ "show": {
937
+ "resource": [
938
+ "Projects"
939
+ ],
940
+ "operation": [
941
+ "Recommendationengine Projects Locations Catalogs Catalog Items List"
942
+ ]
943
+ }
944
+ }
945
+ },
946
+ {
947
+ "displayName": "Filter",
948
+ "name": "filter",
949
+ "description": "Optional. Use of this field is not supported by version v1beta1.",
950
+ "default": "",
951
+ "type": "string",
952
+ "routing": {
953
+ "send": {
954
+ "type": "query",
955
+ "property": "filter",
956
+ "value": "={{ $value }}",
957
+ "propertyInDotNotation": false
958
+ }
959
+ },
960
+ "displayOptions": {
961
+ "show": {
962
+ "resource": [
963
+ "Projects"
964
+ ],
965
+ "operation": [
966
+ "Recommendationengine Projects Locations Catalogs Catalog Items List"
967
+ ]
968
+ }
969
+ }
970
+ },
971
+ {
972
+ "displayName": "Page Size",
973
+ "name": "pageSize",
974
+ "description": "Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.",
975
+ "default": 0,
976
+ "type": "number",
977
+ "routing": {
978
+ "send": {
979
+ "type": "query",
980
+ "property": "pageSize",
981
+ "value": "={{ $value }}",
982
+ "propertyInDotNotation": false
983
+ }
984
+ },
985
+ "displayOptions": {
986
+ "show": {
987
+ "resource": [
988
+ "Projects"
989
+ ],
990
+ "operation": [
991
+ "Recommendationengine Projects Locations Catalogs Catalog Items List"
992
+ ]
993
+ }
994
+ }
995
+ },
996
+ {
997
+ "displayName": "Page Token",
998
+ "name": "pageToken",
999
+ "description": "Optional. The previous ListCatalogItemsResponse.next_page_token.",
1000
+ "default": "",
1001
+ "type": "string",
1002
+ "routing": {
1003
+ "send": {
1004
+ "type": "query",
1005
+ "property": "pageToken",
1006
+ "value": "={{ $value }}",
1007
+ "propertyInDotNotation": false
1008
+ }
1009
+ },
1010
+ "displayOptions": {
1011
+ "show": {
1012
+ "resource": [
1013
+ "Projects"
1014
+ ],
1015
+ "operation": [
1016
+ "Recommendationengine Projects Locations Catalogs Catalog Items List"
1017
+ ]
1018
+ }
1019
+ }
1020
+ },
1021
+ {
1022
+ "displayName": "POST /v1beta1/{parent}/catalogItems",
1023
+ "name": "operation",
1024
+ "type": "notice",
1025
+ "typeOptions": {
1026
+ "theme": "info"
1027
+ },
1028
+ "default": "",
1029
+ "displayOptions": {
1030
+ "show": {
1031
+ "resource": [
1032
+ "Projects"
1033
+ ],
1034
+ "operation": [
1035
+ "Recommendationengine Projects Locations Catalogs Catalog Items Create"
1036
+ ]
1037
+ }
1038
+ }
1039
+ },
1040
+ {
1041
+ "displayName": "Parent",
1042
+ "name": "parent",
1043
+ "required": true,
1044
+ "description": "Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.",
1045
+ "default": "",
1046
+ "type": "string",
1047
+ "displayOptions": {
1048
+ "show": {
1049
+ "resource": [
1050
+ "Projects"
1051
+ ],
1052
+ "operation": [
1053
+ "Recommendationengine Projects Locations Catalogs Catalog Items Create"
1054
+ ]
1055
+ }
1056
+ }
1057
+ },
1058
+ {
1059
+ "displayName": "Category Hierarchies",
1060
+ "name": "categoryHierarchies",
1061
+ "type": "json",
1062
+ "default": "[\n {\n \"categories\": [\n null\n ]\n }\n]",
1063
+ "description": "Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both [\"Shoes & Accessories\" -> \"Shoes\"] and [\"Sports & Fitness\" -> \"Athletic Clothing\" -> \"Shoes\"], it could be represented as: \"categoryHierarchies\": [ { \"categories\": [\"Shoes & Accessories\", \"Shoes\"]}, { \"categories\": [\"Sports & Fitness\", \"Athletic Clothing\", \"Shoes\"] } ]",
1064
+ "routing": {
1065
+ "send": {
1066
+ "property": "categoryHierarchies",
1067
+ "propertyInDotNotation": false,
1068
+ "type": "body",
1069
+ "value": "={{ JSON.parse($value) }}"
1070
+ }
1071
+ },
1072
+ "displayOptions": {
1073
+ "show": {
1074
+ "resource": [
1075
+ "Projects"
1076
+ ],
1077
+ "operation": [
1078
+ "Recommendationengine Projects Locations Catalogs Catalog Items Create"
1079
+ ]
1080
+ }
1081
+ }
1082
+ },
1083
+ {
1084
+ "displayName": "Description",
1085
+ "name": "description",
1086
+ "type": "string",
1087
+ "default": "",
1088
+ "description": "Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.",
1089
+ "routing": {
1090
+ "send": {
1091
+ "property": "description",
1092
+ "propertyInDotNotation": false,
1093
+ "type": "body",
1094
+ "value": "={{ $value }}"
1095
+ }
1096
+ },
1097
+ "displayOptions": {
1098
+ "show": {
1099
+ "resource": [
1100
+ "Projects"
1101
+ ],
1102
+ "operation": [
1103
+ "Recommendationengine Projects Locations Catalogs Catalog Items Create"
1104
+ ]
1105
+ }
1106
+ }
1107
+ },
1108
+ {
1109
+ "displayName": "ID",
1110
+ "name": "id",
1111
+ "type": "string",
1112
+ "default": "",
1113
+ "description": "Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.",
1114
+ "routing": {
1115
+ "send": {
1116
+ "property": "id",
1117
+ "propertyInDotNotation": false,
1118
+ "type": "body",
1119
+ "value": "={{ $value }}"
1120
+ }
1121
+ },
1122
+ "displayOptions": {
1123
+ "show": {
1124
+ "resource": [
1125
+ "Projects"
1126
+ ],
1127
+ "operation": [
1128
+ "Recommendationengine Projects Locations Catalogs Catalog Items Create"
1129
+ ]
1130
+ }
1131
+ }
1132
+ },
1133
+ {
1134
+ "displayName": "Item Attributes",
1135
+ "name": "itemAttributes",
1136
+ "type": "json",
1137
+ "default": "{}",
1138
+ "description": "FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.",
1139
+ "routing": {
1140
+ "send": {
1141
+ "property": "itemAttributes",
1142
+ "propertyInDotNotation": false,
1143
+ "type": "body",
1144
+ "value": "={{ JSON.parse($value) }}"
1145
+ }
1146
+ },
1147
+ "displayOptions": {
1148
+ "show": {
1149
+ "resource": [
1150
+ "Projects"
1151
+ ],
1152
+ "operation": [
1153
+ "Recommendationengine Projects Locations Catalogs Catalog Items Create"
1154
+ ]
1155
+ }
1156
+ }
1157
+ },
1158
+ {
1159
+ "displayName": "Item Group ID",
1160
+ "name": "itemGroupId",
1161
+ "type": "string",
1162
+ "default": "",
1163
+ "description": "Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).",
1164
+ "routing": {
1165
+ "send": {
1166
+ "property": "itemGroupId",
1167
+ "propertyInDotNotation": false,
1168
+ "type": "body",
1169
+ "value": "={{ $value }}"
1170
+ }
1171
+ },
1172
+ "displayOptions": {
1173
+ "show": {
1174
+ "resource": [
1175
+ "Projects"
1176
+ ],
1177
+ "operation": [
1178
+ "Recommendationengine Projects Locations Catalogs Catalog Items Create"
1179
+ ]
1180
+ }
1181
+ }
1182
+ },
1183
+ {
1184
+ "displayName": "Language Code",
1185
+ "name": "languageCode",
1186
+ "type": "string",
1187
+ "default": "",
1188
+ "description": "Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance.",
1189
+ "routing": {
1190
+ "send": {
1191
+ "property": "languageCode",
1192
+ "propertyInDotNotation": false,
1193
+ "type": "body",
1194
+ "value": "={{ $value }}"
1195
+ }
1196
+ },
1197
+ "displayOptions": {
1198
+ "show": {
1199
+ "resource": [
1200
+ "Projects"
1201
+ ],
1202
+ "operation": [
1203
+ "Recommendationengine Projects Locations Catalogs Catalog Items Create"
1204
+ ]
1205
+ }
1206
+ }
1207
+ },
1208
+ {
1209
+ "displayName": "Product Metadata",
1210
+ "name": "productMetadata",
1211
+ "type": "json",
1212
+ "default": "{\n \"exactPrice\": {},\n \"images\": [\n {}\n ],\n \"priceRange\": {}\n}",
1213
+ "description": "ProductCatalogItem captures item metadata specific to retail products.",
1214
+ "routing": {
1215
+ "send": {
1216
+ "property": "productMetadata",
1217
+ "propertyInDotNotation": false,
1218
+ "type": "body",
1219
+ "value": "={{ JSON.parse($value) }}"
1220
+ }
1221
+ },
1222
+ "displayOptions": {
1223
+ "show": {
1224
+ "resource": [
1225
+ "Projects"
1226
+ ],
1227
+ "operation": [
1228
+ "Recommendationengine Projects Locations Catalogs Catalog Items Create"
1229
+ ]
1230
+ }
1231
+ }
1232
+ },
1233
+ {
1234
+ "displayName": "Tags",
1235
+ "name": "tags",
1236
+ "type": "json",
1237
+ "default": "[\n null\n]",
1238
+ "description": "Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter.",
1239
+ "routing": {
1240
+ "send": {
1241
+ "property": "tags",
1242
+ "propertyInDotNotation": false,
1243
+ "type": "body",
1244
+ "value": "={{ JSON.parse($value) }}"
1245
+ }
1246
+ },
1247
+ "displayOptions": {
1248
+ "show": {
1249
+ "resource": [
1250
+ "Projects"
1251
+ ],
1252
+ "operation": [
1253
+ "Recommendationengine Projects Locations Catalogs Catalog Items Create"
1254
+ ]
1255
+ }
1256
+ }
1257
+ },
1258
+ {
1259
+ "displayName": "Title",
1260
+ "name": "title",
1261
+ "type": "string",
1262
+ "default": "",
1263
+ "description": "Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.",
1264
+ "routing": {
1265
+ "send": {
1266
+ "property": "title",
1267
+ "propertyInDotNotation": false,
1268
+ "type": "body",
1269
+ "value": "={{ $value }}"
1270
+ }
1271
+ },
1272
+ "displayOptions": {
1273
+ "show": {
1274
+ "resource": [
1275
+ "Projects"
1276
+ ],
1277
+ "operation": [
1278
+ "Recommendationengine Projects Locations Catalogs Catalog Items Create"
1279
+ ]
1280
+ }
1281
+ }
1282
+ },
1283
+ {
1284
+ "displayName": "POST /v1beta1/{parent}/catalogItems:import",
1285
+ "name": "operation",
1286
+ "type": "notice",
1287
+ "typeOptions": {
1288
+ "theme": "info"
1289
+ },
1290
+ "default": "",
1291
+ "displayOptions": {
1292
+ "show": {
1293
+ "resource": [
1294
+ "Projects"
1295
+ ],
1296
+ "operation": [
1297
+ "Recommendationengine Projects Locations Catalogs Catalog Items Import"
1298
+ ]
1299
+ }
1300
+ }
1301
+ },
1302
+ {
1303
+ "displayName": "Parent",
1304
+ "name": "parent",
1305
+ "required": true,
1306
+ "description": "Required. `projects/1234/locations/global/catalogs/default_catalog` If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission.",
1307
+ "default": "",
1308
+ "type": "string",
1309
+ "displayOptions": {
1310
+ "show": {
1311
+ "resource": [
1312
+ "Projects"
1313
+ ],
1314
+ "operation": [
1315
+ "Recommendationengine Projects Locations Catalogs Catalog Items Import"
1316
+ ]
1317
+ }
1318
+ }
1319
+ },
1320
+ {
1321
+ "displayName": "Errors Config",
1322
+ "name": "errorsConfig",
1323
+ "type": "json",
1324
+ "default": "{}",
1325
+ "description": "Configuration of destination for Import related errors.",
1326
+ "routing": {
1327
+ "send": {
1328
+ "property": "errorsConfig",
1329
+ "propertyInDotNotation": false,
1330
+ "type": "body",
1331
+ "value": "={{ JSON.parse($value) }}"
1332
+ }
1333
+ },
1334
+ "displayOptions": {
1335
+ "show": {
1336
+ "resource": [
1337
+ "Projects"
1338
+ ],
1339
+ "operation": [
1340
+ "Recommendationengine Projects Locations Catalogs Catalog Items Import"
1341
+ ]
1342
+ }
1343
+ }
1344
+ },
1345
+ {
1346
+ "displayName": "Input Config",
1347
+ "name": "inputConfig",
1348
+ "type": "json",
1349
+ "default": "{\n \"bigQuerySource\": {},\n \"catalogInlineSource\": {\n \"catalogItems\": [\n {\n \"categoryHierarchies\": [\n {\n \"categories\": [\n null\n ]\n }\n ],\n \"itemAttributes\": {},\n \"productMetadata\": {\n \"exactPrice\": {},\n \"images\": [\n {}\n ],\n \"priceRange\": {}\n },\n \"tags\": [\n null\n ]\n }\n ]\n },\n \"gcsSource\": {\n \"inputUris\": [\n null\n ]\n },\n \"userEventInlineSource\": {\n \"userEvents\": [\n {\n \"eventDetail\": {\n \"eventAttributes\": {},\n \"experimentIds\": [\n null\n ]\n },\n \"productEventDetail\": {\n \"pageCategories\": [\n {}\n ],\n \"productDetails\": [\n {\n \"itemAttributes\": {}\n }\n ],\n \"purchaseTransaction\": {}\n },\n \"userInfo\": {}\n }\n ]\n }\n}",
1350
+ "description": "The input config source.",
1351
+ "routing": {
1352
+ "send": {
1353
+ "property": "inputConfig",
1354
+ "propertyInDotNotation": false,
1355
+ "type": "body",
1356
+ "value": "={{ JSON.parse($value) }}"
1357
+ }
1358
+ },
1359
+ "displayOptions": {
1360
+ "show": {
1361
+ "resource": [
1362
+ "Projects"
1363
+ ],
1364
+ "operation": [
1365
+ "Recommendationengine Projects Locations Catalogs Catalog Items Import"
1366
+ ]
1367
+ }
1368
+ }
1369
+ },
1370
+ {
1371
+ "displayName": "Request ID",
1372
+ "name": "requestId",
1373
+ "type": "string",
1374
+ "default": "",
1375
+ "description": "Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency and used for request deduplication. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response.",
1376
+ "routing": {
1377
+ "send": {
1378
+ "property": "requestId",
1379
+ "propertyInDotNotation": false,
1380
+ "type": "body",
1381
+ "value": "={{ $value }}"
1382
+ }
1383
+ },
1384
+ "displayOptions": {
1385
+ "show": {
1386
+ "resource": [
1387
+ "Projects"
1388
+ ],
1389
+ "operation": [
1390
+ "Recommendationengine Projects Locations Catalogs Catalog Items Import"
1391
+ ]
1392
+ }
1393
+ }
1394
+ },
1395
+ {
1396
+ "displayName": "Update Mask",
1397
+ "name": "updateMask",
1398
+ "type": "string",
1399
+ "default": "",
1400
+ "description": "Optional. Indicates which fields in the provided imported 'items' to update. If not set, will by default update all fields.",
1401
+ "routing": {
1402
+ "send": {
1403
+ "property": "updateMask",
1404
+ "propertyInDotNotation": false,
1405
+ "type": "body",
1406
+ "value": "={{ $value }}"
1407
+ }
1408
+ },
1409
+ "displayOptions": {
1410
+ "show": {
1411
+ "resource": [
1412
+ "Projects"
1413
+ ],
1414
+ "operation": [
1415
+ "Recommendationengine Projects Locations Catalogs Catalog Items Import"
1416
+ ]
1417
+ }
1418
+ }
1419
+ },
1420
+ {
1421
+ "displayName": "GET /v1beta1/{parent}/catalogs",
1422
+ "name": "operation",
1423
+ "type": "notice",
1424
+ "typeOptions": {
1425
+ "theme": "info"
1426
+ },
1427
+ "default": "",
1428
+ "displayOptions": {
1429
+ "show": {
1430
+ "resource": [
1431
+ "Projects"
1432
+ ],
1433
+ "operation": [
1434
+ "Recommendationengine Projects Locations Catalogs List"
1435
+ ]
1436
+ }
1437
+ }
1438
+ },
1439
+ {
1440
+ "displayName": "Parent",
1441
+ "name": "parent",
1442
+ "required": true,
1443
+ "description": "Required. The account resource name with an associated location.",
1444
+ "default": "",
1445
+ "type": "string",
1446
+ "displayOptions": {
1447
+ "show": {
1448
+ "resource": [
1449
+ "Projects"
1450
+ ],
1451
+ "operation": [
1452
+ "Recommendationengine Projects Locations Catalogs List"
1453
+ ]
1454
+ }
1455
+ }
1456
+ },
1457
+ {
1458
+ "displayName": "Page Size",
1459
+ "name": "pageSize",
1460
+ "description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
1461
+ "default": 0,
1462
+ "type": "number",
1463
+ "routing": {
1464
+ "send": {
1465
+ "type": "query",
1466
+ "property": "pageSize",
1467
+ "value": "={{ $value }}",
1468
+ "propertyInDotNotation": false
1469
+ }
1470
+ },
1471
+ "displayOptions": {
1472
+ "show": {
1473
+ "resource": [
1474
+ "Projects"
1475
+ ],
1476
+ "operation": [
1477
+ "Recommendationengine Projects Locations Catalogs List"
1478
+ ]
1479
+ }
1480
+ }
1481
+ },
1482
+ {
1483
+ "displayName": "Page Token",
1484
+ "name": "pageToken",
1485
+ "description": "Optional. A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page.",
1486
+ "default": "",
1487
+ "type": "string",
1488
+ "routing": {
1489
+ "send": {
1490
+ "type": "query",
1491
+ "property": "pageToken",
1492
+ "value": "={{ $value }}",
1493
+ "propertyInDotNotation": false
1494
+ }
1495
+ },
1496
+ "displayOptions": {
1497
+ "show": {
1498
+ "resource": [
1499
+ "Projects"
1500
+ ],
1501
+ "operation": [
1502
+ "Recommendationengine Projects Locations Catalogs List"
1503
+ ]
1504
+ }
1505
+ }
1506
+ },
1507
+ {
1508
+ "displayName": "GET /v1beta1/{parent}/predictionApiKeyRegistrations",
1509
+ "name": "operation",
1510
+ "type": "notice",
1511
+ "typeOptions": {
1512
+ "theme": "info"
1513
+ },
1514
+ "default": "",
1515
+ "displayOptions": {
1516
+ "show": {
1517
+ "resource": [
1518
+ "Projects"
1519
+ ],
1520
+ "operation": [
1521
+ "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations List"
1522
+ ]
1523
+ }
1524
+ }
1525
+ },
1526
+ {
1527
+ "displayName": "Parent",
1528
+ "name": "parent",
1529
+ "required": true,
1530
+ "description": "Required. The parent placement resource name such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`",
1531
+ "default": "",
1532
+ "type": "string",
1533
+ "displayOptions": {
1534
+ "show": {
1535
+ "resource": [
1536
+ "Projects"
1537
+ ],
1538
+ "operation": [
1539
+ "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations List"
1540
+ ]
1541
+ }
1542
+ }
1543
+ },
1544
+ {
1545
+ "displayName": "Page Size",
1546
+ "name": "pageSize",
1547
+ "description": "Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default.",
1548
+ "default": 0,
1549
+ "type": "number",
1550
+ "routing": {
1551
+ "send": {
1552
+ "type": "query",
1553
+ "property": "pageSize",
1554
+ "value": "={{ $value }}",
1555
+ "propertyInDotNotation": false
1556
+ }
1557
+ },
1558
+ "displayOptions": {
1559
+ "show": {
1560
+ "resource": [
1561
+ "Projects"
1562
+ ],
1563
+ "operation": [
1564
+ "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations List"
1565
+ ]
1566
+ }
1567
+ }
1568
+ },
1569
+ {
1570
+ "displayName": "Page Token",
1571
+ "name": "pageToken",
1572
+ "description": "Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`.",
1573
+ "default": "",
1574
+ "type": "string",
1575
+ "routing": {
1576
+ "send": {
1577
+ "type": "query",
1578
+ "property": "pageToken",
1579
+ "value": "={{ $value }}",
1580
+ "propertyInDotNotation": false
1581
+ }
1582
+ },
1583
+ "displayOptions": {
1584
+ "show": {
1585
+ "resource": [
1586
+ "Projects"
1587
+ ],
1588
+ "operation": [
1589
+ "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations List"
1590
+ ]
1591
+ }
1592
+ }
1593
+ },
1594
+ {
1595
+ "displayName": "POST /v1beta1/{parent}/predictionApiKeyRegistrations",
1596
+ "name": "operation",
1597
+ "type": "notice",
1598
+ "typeOptions": {
1599
+ "theme": "info"
1600
+ },
1601
+ "default": "",
1602
+ "displayOptions": {
1603
+ "show": {
1604
+ "resource": [
1605
+ "Projects"
1606
+ ],
1607
+ "operation": [
1608
+ "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations Create"
1609
+ ]
1610
+ }
1611
+ }
1612
+ },
1613
+ {
1614
+ "displayName": "Parent",
1615
+ "name": "parent",
1616
+ "required": true,
1617
+ "description": "Required. The parent resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`.",
1618
+ "default": "",
1619
+ "type": "string",
1620
+ "displayOptions": {
1621
+ "show": {
1622
+ "resource": [
1623
+ "Projects"
1624
+ ],
1625
+ "operation": [
1626
+ "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations Create"
1627
+ ]
1628
+ }
1629
+ }
1630
+ },
1631
+ {
1632
+ "displayName": "Prediction API Key Registration",
1633
+ "name": "predictionApiKeyRegistration",
1634
+ "type": "json",
1635
+ "default": "{}",
1636
+ "description": "Registered Api Key.",
1637
+ "routing": {
1638
+ "send": {
1639
+ "property": "predictionApiKeyRegistration",
1640
+ "propertyInDotNotation": false,
1641
+ "type": "body",
1642
+ "value": "={{ JSON.parse($value) }}"
1643
+ }
1644
+ },
1645
+ "displayOptions": {
1646
+ "show": {
1647
+ "resource": [
1648
+ "Projects"
1649
+ ],
1650
+ "operation": [
1651
+ "Recommendationengine Projects Locations Catalogs Event Stores Prediction API Key Registrations Create"
1652
+ ]
1653
+ }
1654
+ }
1655
+ },
1656
+ {
1657
+ "displayName": "GET /v1beta1/{parent}/userEvents",
1658
+ "name": "operation",
1659
+ "type": "notice",
1660
+ "typeOptions": {
1661
+ "theme": "info"
1662
+ },
1663
+ "default": "",
1664
+ "displayOptions": {
1665
+ "show": {
1666
+ "resource": [
1667
+ "Projects"
1668
+ ],
1669
+ "operation": [
1670
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events List"
1671
+ ]
1672
+ }
1673
+ }
1674
+ },
1675
+ {
1676
+ "displayName": "Parent",
1677
+ "name": "parent",
1678
+ "required": true,
1679
+ "description": "Required. The parent eventStore resource name, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.",
1680
+ "default": "",
1681
+ "type": "string",
1682
+ "displayOptions": {
1683
+ "show": {
1684
+ "resource": [
1685
+ "Projects"
1686
+ ],
1687
+ "operation": [
1688
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events List"
1689
+ ]
1690
+ }
1691
+ }
1692
+ },
1693
+ {
1694
+ "displayName": "Filter",
1695
+ "name": "filter",
1696
+ "description": "Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search We expect only 3 types of fields: * eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range. * eventType: only 1 eventType restriction can be specified. * eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" * Example 2: eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search eventTime < \"2018-04-23T18:30:43.511Z\" * Example 4: eventTime > \"2012-04-23T18:25:43.511Z\" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems",
1697
+ "default": "",
1698
+ "type": "string",
1699
+ "routing": {
1700
+ "send": {
1701
+ "type": "query",
1702
+ "property": "filter",
1703
+ "value": "={{ $value }}",
1704
+ "propertyInDotNotation": false
1705
+ }
1706
+ },
1707
+ "displayOptions": {
1708
+ "show": {
1709
+ "resource": [
1710
+ "Projects"
1711
+ ],
1712
+ "operation": [
1713
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events List"
1714
+ ]
1715
+ }
1716
+ }
1717
+ },
1718
+ {
1719
+ "displayName": "Page Size",
1720
+ "name": "pageSize",
1721
+ "description": "Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.",
1722
+ "default": 0,
1723
+ "type": "number",
1724
+ "routing": {
1725
+ "send": {
1726
+ "type": "query",
1727
+ "property": "pageSize",
1728
+ "value": "={{ $value }}",
1729
+ "propertyInDotNotation": false
1730
+ }
1731
+ },
1732
+ "displayOptions": {
1733
+ "show": {
1734
+ "resource": [
1735
+ "Projects"
1736
+ ],
1737
+ "operation": [
1738
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events List"
1739
+ ]
1740
+ }
1741
+ }
1742
+ },
1743
+ {
1744
+ "displayName": "Page Token",
1745
+ "name": "pageToken",
1746
+ "description": "Optional. The previous ListUserEventsResponse.next_page_token.",
1747
+ "default": "",
1748
+ "type": "string",
1749
+ "routing": {
1750
+ "send": {
1751
+ "type": "query",
1752
+ "property": "pageToken",
1753
+ "value": "={{ $value }}",
1754
+ "propertyInDotNotation": false
1755
+ }
1756
+ },
1757
+ "displayOptions": {
1758
+ "show": {
1759
+ "resource": [
1760
+ "Projects"
1761
+ ],
1762
+ "operation": [
1763
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events List"
1764
+ ]
1765
+ }
1766
+ }
1767
+ },
1768
+ {
1769
+ "displayName": "GET /v1beta1/{parent}/userEvents:collect",
1770
+ "name": "operation",
1771
+ "type": "notice",
1772
+ "typeOptions": {
1773
+ "theme": "info"
1774
+ },
1775
+ "default": "",
1776
+ "displayOptions": {
1777
+ "show": {
1778
+ "resource": [
1779
+ "Projects"
1780
+ ],
1781
+ "operation": [
1782
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Collect"
1783
+ ]
1784
+ }
1785
+ }
1786
+ },
1787
+ {
1788
+ "displayName": "Parent",
1789
+ "name": "parent",
1790
+ "required": true,
1791
+ "description": "Required. The parent eventStore name, such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.",
1792
+ "default": "",
1793
+ "type": "string",
1794
+ "displayOptions": {
1795
+ "show": {
1796
+ "resource": [
1797
+ "Projects"
1798
+ ],
1799
+ "operation": [
1800
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Collect"
1801
+ ]
1802
+ }
1803
+ }
1804
+ },
1805
+ {
1806
+ "displayName": "Ets",
1807
+ "name": "ets",
1808
+ "description": "Optional. The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.",
1809
+ "default": "",
1810
+ "type": "string",
1811
+ "routing": {
1812
+ "send": {
1813
+ "type": "query",
1814
+ "property": "ets",
1815
+ "value": "={{ $value }}",
1816
+ "propertyInDotNotation": false
1817
+ }
1818
+ },
1819
+ "displayOptions": {
1820
+ "show": {
1821
+ "resource": [
1822
+ "Projects"
1823
+ ],
1824
+ "operation": [
1825
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Collect"
1826
+ ]
1827
+ }
1828
+ }
1829
+ },
1830
+ {
1831
+ "displayName": "Uri",
1832
+ "name": "uri",
1833
+ "description": "Optional. The url including cgi-parameters but excluding the hash fragment. The URL must be truncated to 1.5K bytes to conservatively be under the 2K bytes. This is often more useful than the referer url, because many browsers only send the domain for 3rd party requests.",
1834
+ "default": "",
1835
+ "type": "string",
1836
+ "routing": {
1837
+ "send": {
1838
+ "type": "query",
1839
+ "property": "uri",
1840
+ "value": "={{ $value }}",
1841
+ "propertyInDotNotation": false
1842
+ }
1843
+ },
1844
+ "displayOptions": {
1845
+ "show": {
1846
+ "resource": [
1847
+ "Projects"
1848
+ ],
1849
+ "operation": [
1850
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Collect"
1851
+ ]
1852
+ }
1853
+ }
1854
+ },
1855
+ {
1856
+ "displayName": "User Event",
1857
+ "name": "userEvent",
1858
+ "description": "Required. URL encoded UserEvent proto.",
1859
+ "default": "",
1860
+ "type": "string",
1861
+ "routing": {
1862
+ "send": {
1863
+ "type": "query",
1864
+ "property": "userEvent",
1865
+ "value": "={{ $value }}",
1866
+ "propertyInDotNotation": false
1867
+ }
1868
+ },
1869
+ "displayOptions": {
1870
+ "show": {
1871
+ "resource": [
1872
+ "Projects"
1873
+ ],
1874
+ "operation": [
1875
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Collect"
1876
+ ]
1877
+ }
1878
+ }
1879
+ },
1880
+ {
1881
+ "displayName": "POST /v1beta1/{parent}/userEvents:import",
1882
+ "name": "operation",
1883
+ "type": "notice",
1884
+ "typeOptions": {
1885
+ "theme": "info"
1886
+ },
1887
+ "default": "",
1888
+ "displayOptions": {
1889
+ "show": {
1890
+ "resource": [
1891
+ "Projects"
1892
+ ],
1893
+ "operation": [
1894
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Import"
1895
+ ]
1896
+ }
1897
+ }
1898
+ },
1899
+ {
1900
+ "displayName": "Parent",
1901
+ "name": "parent",
1902
+ "required": true,
1903
+ "description": "Required. `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`",
1904
+ "default": "",
1905
+ "type": "string",
1906
+ "displayOptions": {
1907
+ "show": {
1908
+ "resource": [
1909
+ "Projects"
1910
+ ],
1911
+ "operation": [
1912
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Import"
1913
+ ]
1914
+ }
1915
+ }
1916
+ },
1917
+ {
1918
+ "displayName": "Errors Config",
1919
+ "name": "errorsConfig",
1920
+ "type": "json",
1921
+ "default": "{}",
1922
+ "description": "Configuration of destination for Import related errors.",
1923
+ "routing": {
1924
+ "send": {
1925
+ "property": "errorsConfig",
1926
+ "propertyInDotNotation": false,
1927
+ "type": "body",
1928
+ "value": "={{ JSON.parse($value) }}"
1929
+ }
1930
+ },
1931
+ "displayOptions": {
1932
+ "show": {
1933
+ "resource": [
1934
+ "Projects"
1935
+ ],
1936
+ "operation": [
1937
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Import"
1938
+ ]
1939
+ }
1940
+ }
1941
+ },
1942
+ {
1943
+ "displayName": "Input Config",
1944
+ "name": "inputConfig",
1945
+ "type": "json",
1946
+ "default": "{\n \"bigQuerySource\": {},\n \"catalogInlineSource\": {\n \"catalogItems\": [\n {\n \"categoryHierarchies\": [\n {\n \"categories\": [\n null\n ]\n }\n ],\n \"itemAttributes\": {},\n \"productMetadata\": {\n \"exactPrice\": {},\n \"images\": [\n {}\n ],\n \"priceRange\": {}\n },\n \"tags\": [\n null\n ]\n }\n ]\n },\n \"gcsSource\": {\n \"inputUris\": [\n null\n ]\n },\n \"userEventInlineSource\": {\n \"userEvents\": [\n {\n \"eventDetail\": {\n \"eventAttributes\": {},\n \"experimentIds\": [\n null\n ]\n },\n \"productEventDetail\": {\n \"pageCategories\": [\n {}\n ],\n \"productDetails\": [\n {\n \"itemAttributes\": {}\n }\n ],\n \"purchaseTransaction\": {}\n },\n \"userInfo\": {}\n }\n ]\n }\n}",
1947
+ "description": "The input config source.",
1948
+ "routing": {
1949
+ "send": {
1950
+ "property": "inputConfig",
1951
+ "propertyInDotNotation": false,
1952
+ "type": "body",
1953
+ "value": "={{ JSON.parse($value) }}"
1954
+ }
1955
+ },
1956
+ "displayOptions": {
1957
+ "show": {
1958
+ "resource": [
1959
+ "Projects"
1960
+ ],
1961
+ "operation": [
1962
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Import"
1963
+ ]
1964
+ }
1965
+ }
1966
+ },
1967
+ {
1968
+ "displayName": "Request ID",
1969
+ "name": "requestId",
1970
+ "type": "string",
1971
+ "default": "",
1972
+ "description": "Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency for expensive long running operations. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response. Note that this field must not be set if the desired input config is catalog_inline_source.",
1973
+ "routing": {
1974
+ "send": {
1975
+ "property": "requestId",
1976
+ "propertyInDotNotation": false,
1977
+ "type": "body",
1978
+ "value": "={{ $value }}"
1979
+ }
1980
+ },
1981
+ "displayOptions": {
1982
+ "show": {
1983
+ "resource": [
1984
+ "Projects"
1985
+ ],
1986
+ "operation": [
1987
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Import"
1988
+ ]
1989
+ }
1990
+ }
1991
+ },
1992
+ {
1993
+ "displayName": "POST /v1beta1/{parent}/userEvents:purge",
1994
+ "name": "operation",
1995
+ "type": "notice",
1996
+ "typeOptions": {
1997
+ "theme": "info"
1998
+ },
1999
+ "default": "",
2000
+ "displayOptions": {
2001
+ "show": {
2002
+ "resource": [
2003
+ "Projects"
2004
+ ],
2005
+ "operation": [
2006
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Purge"
2007
+ ]
2008
+ }
2009
+ }
2010
+ },
2011
+ {
2012
+ "displayName": "Parent",
2013
+ "name": "parent",
2014
+ "required": true,
2015
+ "description": "Required. The resource name of the event_store under which the events are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`",
2016
+ "default": "",
2017
+ "type": "string",
2018
+ "displayOptions": {
2019
+ "show": {
2020
+ "resource": [
2021
+ "Projects"
2022
+ ],
2023
+ "operation": [
2024
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Purge"
2025
+ ]
2026
+ }
2027
+ }
2028
+ },
2029
+ {
2030
+ "displayName": "Filter",
2031
+ "name": "filter",
2032
+ "type": "string",
2033
+ "default": "",
2034
+ "description": "Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. The eligible fields for filtering are: * `eventType`: UserEvent.eventType field of type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `visitorId`: field of type string. Specifying this will delete all events associated with a visitor. * `userId`: field of type string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType in time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = \"detail-page-view\"` * Deleting all events for a specific visitor: `visitorId = \"visitor1024\"` The filtering fields are assumed to have an implicit AND.",
2035
+ "routing": {
2036
+ "send": {
2037
+ "property": "filter",
2038
+ "propertyInDotNotation": false,
2039
+ "type": "body",
2040
+ "value": "={{ $value }}"
2041
+ }
2042
+ },
2043
+ "displayOptions": {
2044
+ "show": {
2045
+ "resource": [
2046
+ "Projects"
2047
+ ],
2048
+ "operation": [
2049
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Purge"
2050
+ ]
2051
+ }
2052
+ }
2053
+ },
2054
+ {
2055
+ "displayName": "Force",
2056
+ "name": "force",
2057
+ "type": "boolean",
2058
+ "default": true,
2059
+ "description": "Optional. The default value is false. Override this flag to true to actually perform the purge. If the field is not set to true, a sampling of events to be deleted will be returned.",
2060
+ "routing": {
2061
+ "send": {
2062
+ "property": "force",
2063
+ "propertyInDotNotation": false,
2064
+ "type": "body",
2065
+ "value": "={{ $value }}"
2066
+ }
2067
+ },
2068
+ "displayOptions": {
2069
+ "show": {
2070
+ "resource": [
2071
+ "Projects"
2072
+ ],
2073
+ "operation": [
2074
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Purge"
2075
+ ]
2076
+ }
2077
+ }
2078
+ },
2079
+ {
2080
+ "displayName": "POST /v1beta1/{parent}/userEvents:rejoin",
2081
+ "name": "operation",
2082
+ "type": "notice",
2083
+ "typeOptions": {
2084
+ "theme": "info"
2085
+ },
2086
+ "default": "",
2087
+ "displayOptions": {
2088
+ "show": {
2089
+ "resource": [
2090
+ "Projects"
2091
+ ],
2092
+ "operation": [
2093
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Rejoin"
2094
+ ]
2095
+ }
2096
+ }
2097
+ },
2098
+ {
2099
+ "displayName": "Parent",
2100
+ "name": "parent",
2101
+ "required": true,
2102
+ "description": "Required. Full resource name of user event, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.",
2103
+ "default": "",
2104
+ "type": "string",
2105
+ "displayOptions": {
2106
+ "show": {
2107
+ "resource": [
2108
+ "Projects"
2109
+ ],
2110
+ "operation": [
2111
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Rejoin"
2112
+ ]
2113
+ }
2114
+ }
2115
+ },
2116
+ {
2117
+ "displayName": "User Event Rejoin Scope",
2118
+ "name": "userEventRejoinScope",
2119
+ "type": "options",
2120
+ "default": "USER_EVENT_REJOIN_SCOPE_UNSPECIFIED",
2121
+ "description": "Required. The type of the catalog rejoin to define the scope and range of the user events to be rejoined with catalog items.",
2122
+ "options": [
2123
+ {
2124
+ "name": "USER EVENT REJOIN SCOPE UNSPECIFIED",
2125
+ "value": "USER_EVENT_REJOIN_SCOPE_UNSPECIFIED"
2126
+ },
2127
+ {
2128
+ "name": "JOINED EVENTS",
2129
+ "value": "JOINED_EVENTS"
2130
+ },
2131
+ {
2132
+ "name": "UNJOINED EVENTS",
2133
+ "value": "UNJOINED_EVENTS"
2134
+ }
2135
+ ],
2136
+ "routing": {
2137
+ "send": {
2138
+ "property": "userEventRejoinScope",
2139
+ "propertyInDotNotation": false,
2140
+ "type": "body",
2141
+ "value": "={{ $value }}"
2142
+ }
2143
+ },
2144
+ "displayOptions": {
2145
+ "show": {
2146
+ "resource": [
2147
+ "Projects"
2148
+ ],
2149
+ "operation": [
2150
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Rejoin"
2151
+ ]
2152
+ }
2153
+ }
2154
+ },
2155
+ {
2156
+ "displayName": "POST /v1beta1/{parent}/userEvents:write",
2157
+ "name": "operation",
2158
+ "type": "notice",
2159
+ "typeOptions": {
2160
+ "theme": "info"
2161
+ },
2162
+ "default": "",
2163
+ "displayOptions": {
2164
+ "show": {
2165
+ "resource": [
2166
+ "Projects"
2167
+ ],
2168
+ "operation": [
2169
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Write"
2170
+ ]
2171
+ }
2172
+ }
2173
+ },
2174
+ {
2175
+ "displayName": "Parent",
2176
+ "name": "parent",
2177
+ "required": true,
2178
+ "description": "Required. The parent eventStore resource name, such as \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\".",
2179
+ "default": "",
2180
+ "type": "string",
2181
+ "displayOptions": {
2182
+ "show": {
2183
+ "resource": [
2184
+ "Projects"
2185
+ ],
2186
+ "operation": [
2187
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Write"
2188
+ ]
2189
+ }
2190
+ }
2191
+ },
2192
+ {
2193
+ "displayName": "Event Detail",
2194
+ "name": "eventDetail",
2195
+ "type": "json",
2196
+ "default": "{\n \"eventAttributes\": {},\n \"experimentIds\": [\n null\n ]\n}",
2197
+ "description": "User event details shared by all recommendation types.",
2198
+ "routing": {
2199
+ "send": {
2200
+ "property": "eventDetail",
2201
+ "propertyInDotNotation": false,
2202
+ "type": "body",
2203
+ "value": "={{ JSON.parse($value) }}"
2204
+ }
2205
+ },
2206
+ "displayOptions": {
2207
+ "show": {
2208
+ "resource": [
2209
+ "Projects"
2210
+ ],
2211
+ "operation": [
2212
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Write"
2213
+ ]
2214
+ }
2215
+ }
2216
+ },
2217
+ {
2218
+ "displayName": "Event Source",
2219
+ "name": "eventSource",
2220
+ "type": "options",
2221
+ "default": "EVENT_SOURCE_UNSPECIFIED",
2222
+ "description": "Optional. This field should *not* be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to `EVENT_SOURCE_UNSPECIFIED`.",
2223
+ "options": [
2224
+ {
2225
+ "name": "EVENT SOURCE UNSPECIFIED",
2226
+ "value": "EVENT_SOURCE_UNSPECIFIED"
2227
+ },
2228
+ {
2229
+ "name": "AUTOML",
2230
+ "value": "AUTOML"
2231
+ },
2232
+ {
2233
+ "name": "ECOMMERCE",
2234
+ "value": "ECOMMERCE"
2235
+ },
2236
+ {
2237
+ "name": "BATCH UPLOAD",
2238
+ "value": "BATCH_UPLOAD"
2239
+ }
2240
+ ],
2241
+ "routing": {
2242
+ "send": {
2243
+ "property": "eventSource",
2244
+ "propertyInDotNotation": false,
2245
+ "type": "body",
2246
+ "value": "={{ $value }}"
2247
+ }
2248
+ },
2249
+ "displayOptions": {
2250
+ "show": {
2251
+ "resource": [
2252
+ "Projects"
2253
+ ],
2254
+ "operation": [
2255
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Write"
2256
+ ]
2257
+ }
2258
+ }
2259
+ },
2260
+ {
2261
+ "displayName": "Event Time",
2262
+ "name": "eventTime",
2263
+ "type": "string",
2264
+ "default": "",
2265
+ "description": "Optional. Only required for ImportUserEvents method. Timestamp of user event created.",
2266
+ "routing": {
2267
+ "send": {
2268
+ "property": "eventTime",
2269
+ "propertyInDotNotation": false,
2270
+ "type": "body",
2271
+ "value": "={{ $value }}"
2272
+ }
2273
+ },
2274
+ "displayOptions": {
2275
+ "show": {
2276
+ "resource": [
2277
+ "Projects"
2278
+ ],
2279
+ "operation": [
2280
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Write"
2281
+ ]
2282
+ }
2283
+ }
2284
+ },
2285
+ {
2286
+ "displayName": "Event Type",
2287
+ "name": "eventType",
2288
+ "type": "string",
2289
+ "default": "",
2290
+ "description": "Required. User event type. Allowed values are: * `add-to-cart` Products being added to cart. * `add-to-list` Items being added to a list (shopping list, favorites etc). * `category-page-view` Special pages such as sale or promotion pages viewed. * `checkout-start` User starting a checkout process. * `detail-page-view` Products detail page viewed. * `home-page-view` Homepage viewed. * `page-visit` Generic page visits not included in the event types above. * `purchase-complete` User finishing a purchase. * `refund` Purchased items being refunded or returned. * `remove-from-cart` Products being removed from cart. * `remove-from-list` Items being removed from a list. * `search` Product search. * `shopping-cart-page-view` User viewing a shopping cart. * `impression` List of items displayed. Used by Google Tag Manager.",
2291
+ "routing": {
2292
+ "send": {
2293
+ "property": "eventType",
2294
+ "propertyInDotNotation": false,
2295
+ "type": "body",
2296
+ "value": "={{ $value }}"
2297
+ }
2298
+ },
2299
+ "displayOptions": {
2300
+ "show": {
2301
+ "resource": [
2302
+ "Projects"
2303
+ ],
2304
+ "operation": [
2305
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Write"
2306
+ ]
2307
+ }
2308
+ }
2309
+ },
2310
+ {
2311
+ "displayName": "Product Event Detail",
2312
+ "name": "productEventDetail",
2313
+ "type": "json",
2314
+ "default": "{\n \"pageCategories\": [\n {\n \"categories\": [\n null\n ]\n }\n ],\n \"productDetails\": [\n {\n \"itemAttributes\": {}\n }\n ],\n \"purchaseTransaction\": {}\n}",
2315
+ "description": "ProductEventDetail captures user event information specific to retail products.",
2316
+ "routing": {
2317
+ "send": {
2318
+ "property": "productEventDetail",
2319
+ "propertyInDotNotation": false,
2320
+ "type": "body",
2321
+ "value": "={{ JSON.parse($value) }}"
2322
+ }
2323
+ },
2324
+ "displayOptions": {
2325
+ "show": {
2326
+ "resource": [
2327
+ "Projects"
2328
+ ],
2329
+ "operation": [
2330
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Write"
2331
+ ]
2332
+ }
2333
+ }
2334
+ },
2335
+ {
2336
+ "displayName": "User Info",
2337
+ "name": "userInfo",
2338
+ "type": "json",
2339
+ "default": "{}",
2340
+ "description": "Information of end users.",
2341
+ "routing": {
2342
+ "send": {
2343
+ "property": "userInfo",
2344
+ "propertyInDotNotation": false,
2345
+ "type": "body",
2346
+ "value": "={{ JSON.parse($value) }}"
2347
+ }
2348
+ },
2349
+ "displayOptions": {
2350
+ "show": {
2351
+ "resource": [
2352
+ "Projects"
2353
+ ],
2354
+ "operation": [
2355
+ "Recommendationengine Projects Locations Catalogs Event Stores User Events Write"
2356
+ ]
2357
+ }
2358
+ }
2359
+ },
2360
+ ];
2361
+ //# sourceMappingURL=index.js.map