Skip to content

Commit 72adf13

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Keep the API doc up-to-date
feat: update grpc service config settings to reflect correct API deadlines PiperOrigin-RevId: 411660243
1 parent eddd3d8 commit 72adf13

11 files changed

Lines changed: 83 additions & 27 deletions

‎google/cloud/retail/v2/catalog.proto‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ message ProductLevelConfig {
3737
// The type of [Product][google.cloud.retail.v2.Product]s allowed to be
3838
// ingested into the catalog. Acceptable values are:
3939
//
40-
// * `primary` (default): You can only ingest
41-
// [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
42-
// [Product][google.cloud.retail.v2.Product]s. This means
43-
// [Product.primary_product_id][google.cloud.retail.v2.Product.primary_product_id]
44-
// can only be empty or set to the same value as
45-
// [Product.id][google.cloud.retail.v2.Product.id].
40+
// * `primary` (default): You can ingest
41+
// [Product][google.cloud.retail.v2.Product]s of all types. When
42+
// ingesting a [Product][google.cloud.retail.v2.Product], its type will
43+
// default to
44+
// [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] if
45+
// unset.
4646
// * `variant`: You can only ingest
4747
// [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
4848
// [Product][google.cloud.retail.v2.Product]s.

‎google/cloud/retail/v2/retail_grpc_service_config.json‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,26 @@
4444
{
4545
"service": "google.cloud.retail.v2.ProductService",
4646
"method": "ImportProducts"
47-
},
47+
}
48+
],
49+
"timeout": "300s",
50+
"retryPolicy": {
51+
"initialBackoff": "0.100s",
52+
"maxBackoff": "300s",
53+
"backoffMultiplier": 1.3,
54+
"retryableStatusCodes": [
55+
"UNAVAILABLE",
56+
"DEADLINE_EXCEEDED"
57+
]
58+
}
59+
}, {
60+
"name": [
4861
{
4962
"service": "google.cloud.retail.v2.UserEventService",
5063
"method": "ImportUserEvents"
5164
}
5265
],
53-
"timeout": "300s",
66+
"timeout": "600s",
5467
"retryPolicy": {
5568
"initialBackoff": "0.100s",
5669
"maxBackoff": "300s",

‎google/cloud/retail/v2/search_service.proto‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ message SearchRequest {
9696
// * "customFulfillment3"
9797
// * "customFulfillment4"
9898
// * "customFulfillment5"
99+
// * "inventory(place_id,attributes.key)"
99100
//
100101
// * numerical_field =
101102
// * "price"
@@ -104,6 +105,7 @@ message SearchRequest {
104105
// * "ratingCount"
105106
// * "attributes.key"
106107
// * "inventory(place_id,price)"
108+
// * "inventory(place_id,attributes.key)"
107109
string key = 1 [(google.api.field_behavior) = REQUIRED];
108110

109111
// Set only if values should be bucketized into intervals. Must be set
@@ -513,7 +515,10 @@ message SearchRequest {
513515
// * price
514516
// * originalPrice
515517
// * discount
518+
// * variantId
516519
// * inventory(place_id,price)
520+
// * inventory(place_id,attributes.key), where key is any key in the
521+
// [Product.inventories.attributes][] map.
517522
// * attributes.key, where key is any key in the
518523
// [Product.attributes][google.cloud.retail.v2.Product.attributes] map.
519524
// * pickupInStore.id, where id is any

‎google/cloud/retail/v2alpha/catalog.proto‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ message ProductLevelConfig {
3737
// The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be
3838
// ingested into the catalog. Acceptable values are:
3939
//
40-
// * `primary` (default): You can only ingest
41-
// [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
42-
// [Product][google.cloud.retail.v2alpha.Product]s. This means
43-
// [Product.primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id]
44-
// can only be empty or set to the same value as
45-
// [Product.id][google.cloud.retail.v2alpha.Product.id].
40+
// * `primary` (default): You can ingest
41+
// [Product][google.cloud.retail.v2alpha.Product]s of all types. When
42+
// ingesting a [Product][google.cloud.retail.v2alpha.Product], its type will
43+
// default to
44+
// [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
45+
// if unset.
4646
// * `variant`: You can only ingest
4747
// [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
4848
// [Product][google.cloud.retail.v2alpha.Product]s.
@@ -106,8 +106,8 @@ message MerchantCenterLink {
106106
// List of possible values can be found here.
107107
// [https://support.google.com/merchants/answer/7501026]
108108
// List of allowed string values:
109-
// "shopping-ads", "buy-on-google-listings", "display-ads", "local-inventory
110-
// -ads", "free-listings", "free-local-listings"
109+
// "Shopping_ads", "Buy_on_google_listings", "Display_ads", "Local_inventory
110+
// _ads", "Free_listings", "Free_local_listings"
111111
// NOTE: The string values are case sensitive.
112112
repeated string destinations = 3;
113113
}

‎google/cloud/retail/v2alpha/common.proto‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -456,5 +456,7 @@ message LocalInventory {
456456
// * The attribute values must be of the same type (text or number).
457457
// * The max number of values per attribute is 10.
458458
// * For text values, the length limit is 10 UTF-8 characters.
459+
// * The attribute does not support search. The `searchable` field should be
460+
// unset or set to false.
459461
map<string, CustomAttribute> attributes = 3;
460462
}

‎google/cloud/retail/v2alpha/product_service.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -711,7 +711,7 @@ message AddLocalInventoriesRequest {
711711
// not found, the local inventory will still be processed and retained for at
712712
// most 1 day and processed once the
713713
// [Product][google.cloud.retail.v2alpha.Product] is created. If set to false,
714-
// an INVALID_ARGUMENT error is returned if the
714+
// a NOT_FOUND error is returned if the
715715
// [Product][google.cloud.retail.v2alpha.Product] is not found.
716716
bool allow_missing = 6;
717717
}

‎google/cloud/retail/v2alpha/retail_grpc_service_config.json‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,26 @@
4444
{
4545
"service": "google.cloud.retail.v2alpha.ProductService",
4646
"method": "ImportProducts"
47-
},
47+
}
48+
],
49+
"timeout": "300s",
50+
"retryPolicy": {
51+
"initialBackoff": "0.100s",
52+
"maxBackoff": "300s",
53+
"backoffMultiplier": 1.3,
54+
"retryableStatusCodes": [
55+
"UNAVAILABLE",
56+
"DEADLINE_EXCEEDED"
57+
]
58+
}
59+
}, {
60+
"name": [
4861
{
4962
"service": "google.cloud.retail.v2alpha.UserEventService",
5063
"method": "ImportUserEvents"
5164
}
5265
],
53-
"timeout": "300s",
66+
"timeout": "600s",
5467
"retryPolicy": {
5568
"initialBackoff": "0.100s",
5669
"maxBackoff": "300s",

‎google/cloud/retail/v2alpha/search_service.proto‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ message SearchRequest {
9797
// * "customFulfillment3"
9898
// * "customFulfillment4"
9999
// * "customFulfillment5"
100+
// * "inventory(place_id,attributes.key)"
100101
//
101102
// * numerical_field =
102103
// * "price"
@@ -105,6 +106,7 @@ message SearchRequest {
105106
// * "ratingCount"
106107
// * "attributes.key"
107108
// * "inventory(place_id,price)"
109+
// * "inventory(place_id,attributes.key)"
108110
string key = 1 [(google.api.field_behavior) = REQUIRED];
109111

110112
// Set only if values should be bucketized into intervals. Must be set
@@ -550,7 +552,10 @@ message SearchRequest {
550552
// * price
551553
// * originalPrice
552554
// * discount
555+
// * variantId
553556
// * inventory(place_id,price)
557+
// * inventory(place_id,attributes.key), where key is any key in the
558+
// [Product.inventories.attributes][] map.
554559
// * attributes.key, where key is any key in the
555560
// [Product.attributes][google.cloud.retail.v2alpha.Product.attributes] map.
556561
// * pickupInStore.id, where id is any

‎google/cloud/retail/v2beta/catalog.proto‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ message ProductLevelConfig {
3737
// The type of [Product][google.cloud.retail.v2beta.Product]s allowed to be
3838
// ingested into the catalog. Acceptable values are:
3939
//
40-
// * `primary` (default): You can only ingest
41-
// [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
42-
// [Product][google.cloud.retail.v2beta.Product]s. This means
43-
// [Product.primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id]
44-
// can only be empty or set to the same value as
45-
// [Product.id][google.cloud.retail.v2beta.Product.id].
40+
// * `primary` (default): You can ingest
41+
// [Product][google.cloud.retail.v2beta.Product]s of all types. When
42+
// ingesting a [Product][google.cloud.retail.v2beta.Product], its type will
43+
// default to
44+
// [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
45+
// if unset.
4646
// * `variant`: You can only ingest
4747
// [Product.Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]
4848
// [Product][google.cloud.retail.v2beta.Product]s.

‎google/cloud/retail/v2beta/retail_grpc_service_config.json‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,26 @@
4444
{
4545
"service": "google.cloud.retail.v2beta.ProductService",
4646
"method": "ImportProducts"
47-
},
47+
}
48+
],
49+
"timeout": "300s",
50+
"retryPolicy": {
51+
"initialBackoff": "0.100s",
52+
"maxBackoff": "300s",
53+
"backoffMultiplier": 1.3,
54+
"retryableStatusCodes": [
55+
"UNAVAILABLE",
56+
"DEADLINE_EXCEEDED"
57+
]
58+
}
59+
}, {
60+
"name": [
4861
{
4962
"service": "google.cloud.retail.v2beta.UserEventService",
5063
"method": "ImportUserEvents"
5164
}
5265
],
53-
"timeout": "300s",
66+
"timeout": "600s",
5467
"retryPolicy": {
5568
"initialBackoff": "0.100s",
5669
"maxBackoff": "300s",

0 commit comments

Comments
 (0)