You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/retail_v2.projects.locations.catalogs.placements.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -105,7 +105,7 @@ <h3>Method Details</h3>
105
105
"params": { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given 'score' indicates the probability of an product 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 products instead of empty if your filter blocks all prediction results.
106
106
"a_key": "",
107
107
},
108
-
"userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22 # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging.
108
+
"userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging.
109
109
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
110
110
"a_key": { # A custom attribute that is not explicitly modeled in Product.
111
111
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
Copy file name to clipboardExpand all lines: docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -155,7 +155,7 @@ <h3>Method Details</h3>
155
155
},
156
156
"userEventInlineSource": { # The inline source for the input config for ImportUserEvents method. # Required. The Inline source for the input content for UserEvents.
157
157
"userEvents": [ # Required. A list of user events to import. Recommended max of 10k items.
158
-
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22
158
+
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
159
159
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
160
160
"a_key": { # A custom attribute that is not explicitly modeled in Product.
161
161
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -369,7 +369,7 @@ <h3>Method Details</h3>
369
369
body: object, The request body.
370
370
The object takes the form of:
371
371
372
-
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22
372
+
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
373
373
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
374
374
"a_key": { # A custom attribute that is not explicitly modeled in Product.
375
375
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -464,7 +464,7 @@ <h3>Method Details</h3>
464
464
Returns:
465
465
An object of the form:
466
466
467
-
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22
467
+
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
468
468
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
469
469
"a_key": { # A custom attribute that is not explicitly modeled in Product.
470
470
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
Copy file name to clipboardExpand all lines: docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -105,7 +105,7 @@ <h3>Method Details</h3>
105
105
"params": { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given 'score' indicates the probability of an product 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 products instead of empty if your filter blocks all prediction results.
106
106
"a_key": "",
107
107
},
108
-
"userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22 # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging.
108
+
"userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging.
109
109
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
110
110
"a_key": { # A custom attribute that is not explicitly modeled in Product.
111
111
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
Copy file name to clipboardExpand all lines: docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -155,7 +155,7 @@ <h3>Method Details</h3>
155
155
},
156
156
"userEventInlineSource": { # The inline source for the input config for ImportUserEvents method. # Required. The Inline source for the input content for UserEvents.
157
157
"userEvents": [ # Required. A list of user events to import. Recommended max of 10k items.
158
-
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22
158
+
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
159
159
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
160
160
"a_key": { # A custom attribute that is not explicitly modeled in Product.
161
161
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -370,7 +370,7 @@ <h3>Method Details</h3>
370
370
body: object, The request body.
371
371
The object takes the form of:
372
372
373
-
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22
373
+
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
374
374
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
375
375
"a_key": { # A custom attribute that is not explicitly modeled in Product.
376
376
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -466,7 +466,7 @@ <h3>Method Details</h3>
466
466
Returns:
467
467
An object of the form:
468
468
469
-
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22
469
+
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
470
470
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
471
471
"a_key": { # A custom attribute that is not explicitly modeled in Product.
472
472
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
Copy file name to clipboardExpand all lines: docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -105,7 +105,7 @@ <h3>Method Details</h3>
105
105
"params": { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given 'score' indicates the probability of an product 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 products instead of empty if your filter blocks all prediction results.
106
106
"a_key": "",
107
107
},
108
-
"userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22 # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging.
108
+
"userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging.
109
109
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
110
110
"a_key": { # A custom attribute that is not explicitly modeled in Product.
111
111
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
Copy file name to clipboardExpand all lines: docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -155,7 +155,7 @@ <h3>Method Details</h3>
155
155
},
156
156
"userEventInlineSource": { # The inline source for the input config for ImportUserEvents method. # Required. The Inline source for the input content for UserEvents.
157
157
"userEvents": [ # Required. A list of user events to import. Recommended max of 10k items.
158
-
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22
158
+
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
159
159
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
160
160
"a_key": { # A custom attribute that is not explicitly modeled in Product.
161
161
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -369,7 +369,7 @@ <h3>Method Details</h3>
369
369
body: object, The request body.
370
370
The object takes the form of:
371
371
372
-
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22
372
+
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
373
373
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
374
374
"a_key": { # A custom attribute that is not explicitly modeled in Product.
375
375
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -464,7 +464,7 @@ <h3>Method Details</h3>
464
464
Returns:
465
465
An object of the form:
466
466
467
-
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Next tag: 22
467
+
{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
468
468
"attributes": { # Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.
469
469
"a_key": { # A custom attribute that is not explicitly modeled in Product.
470
470
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
0 commit comments