• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1type: google.api.Service
2config_version: 3
3name: retail.googleapis.com
4title: Retail API
5
6apis:
7- name: google.cloud.location.Locations
8- name: google.cloud.retail.v2.AnalyticsService
9- name: google.cloud.retail.v2.CatalogService
10- name: google.cloud.retail.v2.CompletionService
11- name: google.cloud.retail.v2.ControlService
12- name: google.cloud.retail.v2.ModelService
13- name: google.cloud.retail.v2.PredictionService
14- name: google.cloud.retail.v2.ProductService
15- name: google.cloud.retail.v2.SearchService
16- name: google.cloud.retail.v2.ServingConfigService
17- name: google.cloud.retail.v2.UserEventService
18- name: google.longrunning.Operations
19
20types:
21- name: google.cloud.retail.logging.ErrorLog
22- name: google.cloud.retail.v2.AddFulfillmentPlacesMetadata
23- name: google.cloud.retail.v2.AddFulfillmentPlacesResponse
24- name: google.cloud.retail.v2.AddLocalInventoriesMetadata
25- name: google.cloud.retail.v2.AddLocalInventoriesResponse
26- name: google.cloud.retail.v2.CreateModelMetadata
27- name: google.cloud.retail.v2.ExportAnalyticsMetricsResponse
28- name: google.cloud.retail.v2.ExportMetadata
29- name: google.cloud.retail.v2.ImportCompletionDataResponse
30- name: google.cloud.retail.v2.ImportErrorsConfig
31- name: google.cloud.retail.v2.ImportMetadata
32- name: google.cloud.retail.v2.ImportProductsResponse
33- name: google.cloud.retail.v2.ImportUserEventsResponse
34- name: google.cloud.retail.v2.Model
35- name: google.cloud.retail.v2.PurgeMetadata
36- name: google.cloud.retail.v2.PurgeUserEventsResponse
37- name: google.cloud.retail.v2.RejoinUserEventsMetadata
38- name: google.cloud.retail.v2.RejoinUserEventsResponse
39- name: google.cloud.retail.v2.RemoveFulfillmentPlacesMetadata
40- name: google.cloud.retail.v2.RemoveFulfillmentPlacesResponse
41- name: google.cloud.retail.v2.RemoveLocalInventoriesMetadata
42- name: google.cloud.retail.v2.RemoveLocalInventoriesResponse
43- name: google.cloud.retail.v2.SetInventoryMetadata
44- name: google.cloud.retail.v2.SetInventoryResponse
45- name: google.cloud.retail.v2.TuneModelMetadata
46- name: google.cloud.retail.v2.TuneModelResponse
47
48documentation:
49  summary: |-
50    Cloud Retail service enables customers to build end-to-end personalized
51    recommendation systems without requiring a high level of expertise in
52    machine learning, recommendation system, or Google Cloud.
53  rules:
54  - selector: google.cloud.location.Locations.GetLocation
55    description: Gets information about a location.
56
57  - selector: google.cloud.location.Locations.ListLocations
58    description: Lists information about the supported locations for this service.
59
60backend:
61  rules:
62  - selector: google.cloud.retail.v2.CatalogService.UpdateCatalog
63    deadline: 10.0
64  - selector: google.cloud.retail.v2.CompletionService.ImportCompletionData
65    deadline: 300.0
66  - selector: 'google.cloud.retail.v2.ModelService.*'
67    deadline: 60.0
68  - selector: 'google.cloud.retail.v2.ProductService.*'
69    deadline: 30.0
70  - selector: google.cloud.retail.v2.ProductService.ImportProducts
71    deadline: 300.0
72  - selector: google.cloud.retail.v2.UserEventService.CollectUserEvent
73    deadline: 10.0
74  - selector: google.cloud.retail.v2.UserEventService.ImportUserEvents
75    deadline: 600.0
76  - selector: google.cloud.retail.v2.UserEventService.PurgeUserEvents
77    deadline: 30.0
78  - selector: google.longrunning.Operations.ListOperations
79    deadline: 300.0
80
81http:
82  rules:
83  - selector: google.longrunning.Operations.GetOperation
84    get: '/v2/{name=projects/*/locations/*/operations/*}'
85    additional_bindings:
86    - get: '/v2/{name=projects/*/locations/*/catalogs/*/branches/*/operations/*}'
87    - get: '/v2/{name=projects/*/locations/*/catalogs/*/operations/*}'
88    - get: '/v2/{name=projects/*/operations/*}'
89  - selector: google.longrunning.Operations.ListOperations
90    get: '/v2/{name=projects/*/locations/*}/operations'
91    additional_bindings:
92    - get: '/v2/{name=projects/*/locations/*/catalogs/*}/operations'
93    - get: '/v2/{name=projects/*}/operations'
94
95authentication:
96  rules:
97  - selector: google.cloud.location.Locations.GetLocation
98    oauth:
99      canonical_scopes: |-
100        https://www.googleapis.com/auth/cloud-platform
101  - selector: google.cloud.location.Locations.ListLocations
102    oauth:
103      canonical_scopes: |-
104        https://www.googleapis.com/auth/cloud-platform
105  - selector: google.cloud.retail.v2.AnalyticsService.ExportAnalyticsMetrics
106    oauth:
107      canonical_scopes: |-
108        https://www.googleapis.com/auth/cloud-platform
109  - selector: 'google.cloud.retail.v2.CatalogService.*'
110    oauth:
111      canonical_scopes: |-
112        https://www.googleapis.com/auth/cloud-platform
113  - selector: google.cloud.retail.v2.CompletionService.CompleteQuery
114    oauth:
115      canonical_scopes: |-
116        https://www.googleapis.com/auth/cloud-platform
117  - selector: google.cloud.retail.v2.CompletionService.ImportCompletionData
118    oauth:
119      canonical_scopes: |-
120        https://www.googleapis.com/auth/cloud-platform
121  - selector: 'google.cloud.retail.v2.ControlService.*'
122    oauth:
123      canonical_scopes: |-
124        https://www.googleapis.com/auth/cloud-platform
125  - selector: 'google.cloud.retail.v2.ModelService.*'
126    oauth:
127      canonical_scopes: |-
128        https://www.googleapis.com/auth/cloud-platform
129  - selector: google.cloud.retail.v2.PredictionService.Predict
130    oauth:
131      canonical_scopes: |-
132        https://www.googleapis.com/auth/cloud-platform
133  - selector: 'google.cloud.retail.v2.ProductService.*'
134    oauth:
135      canonical_scopes: |-
136        https://www.googleapis.com/auth/cloud-platform
137  - selector: google.cloud.retail.v2.SearchService.Search
138    oauth:
139      canonical_scopes: |-
140        https://www.googleapis.com/auth/cloud-platform
141  - selector: 'google.cloud.retail.v2.ServingConfigService.*'
142    oauth:
143      canonical_scopes: |-
144        https://www.googleapis.com/auth/cloud-platform
145  - selector: 'google.cloud.retail.v2.UserEventService.*'
146    oauth:
147      canonical_scopes: |-
148        https://www.googleapis.com/auth/cloud-platform
149  - selector: google.longrunning.Operations.GetOperation
150    oauth:
151      canonical_scopes: |-
152        https://www.googleapis.com/auth/cloud-platform
153  - selector: google.longrunning.Operations.ListOperations
154    oauth:
155      canonical_scopes: |-
156        https://www.googleapis.com/auth/cloud-platform
157