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