summaryrefslogtreecommitdiff
path: root/third_party/googleapis/google/cloud/retail/v2/retail_v2.yaml
blob: caa125739fe88cc41b93777b0b27dad3c433f33a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
type: google.api.Service
config_version: 3
name: retail.googleapis.com
title: Retail API

apis:
- name: google.cloud.location.Locations
- name: google.cloud.retail.v2.CatalogService
- name: google.cloud.retail.v2.CompletionService
- name: google.cloud.retail.v2.ControlService
- name: google.cloud.retail.v2.PredictionService
- name: google.cloud.retail.v2.ProductService
- name: google.cloud.retail.v2.SearchService
- name: google.cloud.retail.v2.ServingConfigService
- name: google.cloud.retail.v2.UserEventService
- name: google.longrunning.Operations

types:
- name: google.cloud.retail.logging.ErrorLog
- name: google.cloud.retail.v2.AddFulfillmentPlacesMetadata
- name: google.cloud.retail.v2.AddFulfillmentPlacesResponse
- name: google.cloud.retail.v2.AddLocalInventoriesMetadata
- name: google.cloud.retail.v2.AddLocalInventoriesResponse
- name: google.cloud.retail.v2.ImportCompletionDataResponse
- name: google.cloud.retail.v2.ImportErrorsConfig
- name: google.cloud.retail.v2.ImportMetadata
- name: google.cloud.retail.v2.ImportProductsResponse
- name: google.cloud.retail.v2.ImportUserEventsResponse
- name: google.cloud.retail.v2.PurgeMetadata
- name: google.cloud.retail.v2.PurgeUserEventsResponse
- name: google.cloud.retail.v2.RejoinUserEventsMetadata
- name: google.cloud.retail.v2.RejoinUserEventsResponse
- name: google.cloud.retail.v2.RemoveFulfillmentPlacesMetadata
- name: google.cloud.retail.v2.RemoveFulfillmentPlacesResponse
- name: google.cloud.retail.v2.RemoveLocalInventoriesMetadata
- name: google.cloud.retail.v2.RemoveLocalInventoriesResponse
- name: google.cloud.retail.v2.SetInventoryMetadata
- name: google.cloud.retail.v2.SetInventoryResponse

documentation:
  summary: |-
    Cloud Retail service enables customers to build end-to-end personalized
    recommendation systems without requiring a high level of expertise in
    machine learning, recommendation system, or Google Cloud.
  rules:
  - selector: google.cloud.location.Locations.GetLocation
    description: Gets information about a location.

  - selector: google.cloud.location.Locations.ListLocations
    description: Lists information about the supported locations for this service.

backend:
  rules:
  - selector: google.cloud.retail.v2.CatalogService.UpdateCatalog
    deadline: 10.0
  - selector: 'google.cloud.retail.v2.ProductService.*'
    deadline: 30.0
  - selector: google.cloud.retail.v2.ProductService.ImportProducts
    deadline: 300.0
  - selector: google.cloud.retail.v2.UserEventService.ImportUserEvents
    deadline: 600.0
  - selector: google.cloud.retail.v2.UserEventService.PurgeUserEvents
    deadline: 30.0
  - selector: google.longrunning.Operations.ListOperations
    deadline: 300.0

http:
  rules:
  - selector: google.longrunning.Operations.GetOperation
    get: '/v2/{name=projects/*/locations/*/operations/*}'
    additional_bindings:
    - get: '/v2/{name=projects/*/locations/*/catalogs/*/branches/*/operations/*}'
    - get: '/v2/{name=projects/*/locations/*/catalogs/*/operations/*}'
    - get: '/v2/{name=projects/*/operations/*}'
  - selector: google.longrunning.Operations.ListOperations
    get: '/v2/{name=projects/*/locations/*}/operations'
    additional_bindings:
    - get: '/v2/{name=projects/*/locations/*/catalogs/*}/operations'
    - get: '/v2/{name=projects/*}/operations'

authentication:
  rules:
  - selector: google.cloud.location.Locations.GetLocation
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: google.cloud.location.Locations.ListLocations
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: 'google.cloud.retail.v2.CatalogService.*'
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: google.cloud.retail.v2.CompletionService.CompleteQuery
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: google.cloud.retail.v2.CompletionService.ImportCompletionData
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: 'google.cloud.retail.v2.ControlService.*'
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: google.cloud.retail.v2.PredictionService.Predict
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: 'google.cloud.retail.v2.ProductService.*'
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: google.cloud.retail.v2.SearchService.Search
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: 'google.cloud.retail.v2.ServingConfigService.*'
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: 'google.cloud.retail.v2.UserEventService.*'
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: google.longrunning.Operations.GetOperation
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform
  - selector: google.longrunning.Operations.ListOperations
    oauth:
      canonical_scopes: |-
        https://www.googleapis.com/auth/cloud-platform