@maxim_mazurok/gapi.client.retail-v2 0.0.20230321 → 0.0.20230406
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +17 -14
- package/package.json +1 -1
- package/tests.ts +8 -8
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://retail.googleapis.com/$discovery/rest?version=v2
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20230406
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1813,11 +1813,6 @@ declare namespace gapi.client {
|
|
|
1813
1813
|
synonyms?: string[];
|
|
1814
1814
|
}
|
|
1815
1815
|
interface GoogleCloudRetailV2SearchRequest {
|
|
1816
|
-
/**
|
|
1817
|
-
* Represents the banner in request, for projects that combine banners. For example: a retailer can sell products under different banners like retailer-main, retailer-baby,
|
|
1818
|
-
* retailer-meds, etc. under one project.
|
|
1819
|
-
*/
|
|
1820
|
-
banner?: string;
|
|
1821
1816
|
/**
|
|
1822
1817
|
* Boost specification to boost certain products. See more details at this [user guide](https://cloud.google.com/retail/docs/boosting). Notice that if both
|
|
1823
1818
|
* ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the
|
|
@@ -1840,7 +1835,12 @@ declare namespace gapi.client {
|
|
|
1840
1835
|
* that only textual facets can be dynamically generated.
|
|
1841
1836
|
*/
|
|
1842
1837
|
dynamicFacetSpec?: GoogleCloudRetailV2SearchRequestDynamicFacetSpec;
|
|
1843
|
-
/**
|
|
1838
|
+
/**
|
|
1839
|
+
* The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If
|
|
1840
|
+
* this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.
|
|
1841
|
+
*/
|
|
1842
|
+
entity?: string;
|
|
1843
|
+
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
1844
1844
|
facetSpecs?: GoogleCloudRetailV2SearchRequestFacetSpec[];
|
|
1845
1845
|
/**
|
|
1846
1846
|
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. See
|
|
@@ -2307,11 +2307,6 @@ declare namespace gapi.client {
|
|
|
2307
2307
|
* recording events on product K's page, log the PredictResponse.attribution_token to this field.
|
|
2308
2308
|
*/
|
|
2309
2309
|
attributionToken?: string;
|
|
2310
|
-
/**
|
|
2311
|
-
* Represents the banner of the user event, for projects that combine banners. For example: retailer can have events from multiple banners like retailer-main, retailer-baby,
|
|
2312
|
-
* retailer-meds, etc. under one project.
|
|
2313
|
-
*/
|
|
2314
|
-
banner?: string;
|
|
2315
2310
|
/**
|
|
2316
2311
|
* The ID or name of the associated shopping cart. This ID is used to associate multiple items added or present in the cart before purchase. This can only be set for `add-to-cart`,
|
|
2317
2312
|
* `purchase-complete`, or `shopping-cart-page-view` events.
|
|
@@ -2319,6 +2314,11 @@ declare namespace gapi.client {
|
|
|
2319
2314
|
cartId?: string;
|
|
2320
2315
|
/** The main auto-completion details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search. */
|
|
2321
2316
|
completionDetail?: GoogleCloudRetailV2CompletionDetail;
|
|
2317
|
+
/**
|
|
2318
|
+
* The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. It
|
|
2319
|
+
* is recommended to set this field to get better per-entity search, completion and prediction results.
|
|
2320
|
+
*/
|
|
2321
|
+
entity?: string;
|
|
2322
2322
|
/** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
|
|
2323
2323
|
eventTime?: string;
|
|
2324
2324
|
/**
|
|
@@ -4993,8 +4993,6 @@ declare namespace gapi.client {
|
|
|
4993
4993
|
access_token?: string;
|
|
4994
4994
|
/** Data format for response. */
|
|
4995
4995
|
alt?: string;
|
|
4996
|
-
/** The banner context for completion suggestions. */
|
|
4997
|
-
banner?: string;
|
|
4998
4996
|
/** JSONP */
|
|
4999
4997
|
callback?: string;
|
|
5000
4998
|
/** Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/*/locations/global/catalogs/default_catalog`. */
|
|
@@ -5011,6 +5009,11 @@ declare namespace gapi.client {
|
|
|
5011
5009
|
* `OTHER_`, e.g. `OTHER_IPHONE`.
|
|
5012
5010
|
*/
|
|
5013
5011
|
deviceType?: string;
|
|
5012
|
+
/**
|
|
5013
|
+
* The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc.
|
|
5014
|
+
* If this is set, it should be exactly matched with UserEvent.entity to get per-entity autocomplete results.
|
|
5015
|
+
*/
|
|
5016
|
+
entity?: string;
|
|
5014
5017
|
/** Selector specifying which fields to include in a partial response. */
|
|
5015
5018
|
fields?: string;
|
|
5016
5019
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
package/package.json
CHANGED
package/tests.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
4
4
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
5
5
|
|
|
6
|
-
// Revision:
|
|
6
|
+
// Revision: 20230406
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -34,10 +34,10 @@ gapi.load('client', async () => {
|
|
|
34
34
|
* feature.
|
|
35
35
|
*/
|
|
36
36
|
await gapi.client.retail.projects.locations.catalogs.completeQuery({
|
|
37
|
-
banner: "Test string",
|
|
38
37
|
catalog: "Test string",
|
|
39
38
|
dataset: "Test string",
|
|
40
39
|
deviceType: "Test string",
|
|
40
|
+
entity: "Test string",
|
|
41
41
|
languageCodes: "Test string",
|
|
42
42
|
maxSuggestions: 42,
|
|
43
43
|
query: "Test string",
|
|
@@ -1374,13 +1374,13 @@ gapi.load('client', async () => {
|
|
|
1374
1374
|
}
|
|
1375
1375
|
},
|
|
1376
1376
|
attributionToken: "Test string",
|
|
1377
|
-
banner: "Test string",
|
|
1378
1377
|
cartId: "Test string",
|
|
1379
1378
|
completionDetail: {
|
|
1380
1379
|
completionAttributionToken: "Test string",
|
|
1381
1380
|
selectedPosition: 42,
|
|
1382
1381
|
selectedSuggestion: "Test string",
|
|
1383
1382
|
},
|
|
1383
|
+
entity: "Test string",
|
|
1384
1384
|
eventTime: "Test string",
|
|
1385
1385
|
eventType: "Test string",
|
|
1386
1386
|
experimentIds: [
|
|
@@ -1585,7 +1585,6 @@ gapi.load('client', async () => {
|
|
|
1585
1585
|
await gapi.client.retail.projects.locations.catalogs.placements.search({
|
|
1586
1586
|
placement: "Test string",
|
|
1587
1587
|
}, {
|
|
1588
|
-
banner: "Test string",
|
|
1589
1588
|
boostSpec: {
|
|
1590
1589
|
conditionBoostSpecs: [
|
|
1591
1590
|
{
|
|
@@ -1600,6 +1599,7 @@ gapi.load('client', async () => {
|
|
|
1600
1599
|
dynamicFacetSpec: {
|
|
1601
1600
|
mode: "Test string",
|
|
1602
1601
|
},
|
|
1602
|
+
entity: "Test string",
|
|
1603
1603
|
facetSpecs: [
|
|
1604
1604
|
{
|
|
1605
1605
|
enableDynamicPosition: true,
|
|
@@ -1816,13 +1816,13 @@ gapi.load('client', async () => {
|
|
|
1816
1816
|
}
|
|
1817
1817
|
},
|
|
1818
1818
|
attributionToken: "Test string",
|
|
1819
|
-
banner: "Test string",
|
|
1820
1819
|
cartId: "Test string",
|
|
1821
1820
|
completionDetail: {
|
|
1822
1821
|
completionAttributionToken: "Test string",
|
|
1823
1822
|
selectedPosition: 42,
|
|
1824
1823
|
selectedSuggestion: "Test string",
|
|
1825
1824
|
},
|
|
1825
|
+
entity: "Test string",
|
|
1826
1826
|
eventTime: "Test string",
|
|
1827
1827
|
eventType: "Test string",
|
|
1828
1828
|
experimentIds: [
|
|
@@ -2033,7 +2033,6 @@ gapi.load('client', async () => {
|
|
|
2033
2033
|
await gapi.client.retail.projects.locations.catalogs.servingConfigs.search({
|
|
2034
2034
|
placement: "Test string",
|
|
2035
2035
|
}, {
|
|
2036
|
-
banner: "Test string",
|
|
2037
2036
|
boostSpec: {
|
|
2038
2037
|
conditionBoostSpecs: [
|
|
2039
2038
|
{
|
|
@@ -2048,6 +2047,7 @@ gapi.load('client', async () => {
|
|
|
2048
2047
|
dynamicFacetSpec: {
|
|
2049
2048
|
mode: "Test string",
|
|
2050
2049
|
},
|
|
2050
|
+
entity: "Test string",
|
|
2051
2051
|
facetSpecs: [
|
|
2052
2052
|
{
|
|
2053
2053
|
enableDynamicPosition: true,
|
|
@@ -2172,13 +2172,13 @@ gapi.load('client', async () => {
|
|
|
2172
2172
|
}
|
|
2173
2173
|
},
|
|
2174
2174
|
attributionToken: "Test string",
|
|
2175
|
-
banner: "Test string",
|
|
2176
2175
|
cartId: "Test string",
|
|
2177
2176
|
completionDetail: {
|
|
2178
2177
|
completionAttributionToken: "Test string",
|
|
2179
2178
|
selectedPosition: 42,
|
|
2180
2179
|
selectedSuggestion: "Test string",
|
|
2181
2180
|
},
|
|
2181
|
+
entity: "Test string",
|
|
2182
2182
|
eventTime: "Test string",
|
|
2183
2183
|
eventType: "Test string",
|
|
2184
2184
|
experimentIds: [
|
|
@@ -2419,13 +2419,13 @@ gapi.load('client', async () => {
|
|
|
2419
2419
|
}
|
|
2420
2420
|
},
|
|
2421
2421
|
attributionToken: "Test string",
|
|
2422
|
-
banner: "Test string",
|
|
2423
2422
|
cartId: "Test string",
|
|
2424
2423
|
completionDetail: {
|
|
2425
2424
|
completionAttributionToken: "Test string",
|
|
2426
2425
|
selectedPosition: 42,
|
|
2427
2426
|
selectedSuggestion: "Test string",
|
|
2428
2427
|
},
|
|
2428
|
+
entity: "Test string",
|
|
2429
2429
|
eventTime: "Test string",
|
|
2430
2430
|
eventType: "Test string",
|
|
2431
2431
|
experimentIds: [
|