@google-shopping/lfp 0.1.0
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/CHANGELOG.md +8 -0
- package/LICENSE +202 -0
- package/README.md +200 -0
- package/build/protos/google/shopping/merchant/lfp/v1beta/lfpinventory.proto +149 -0
- package/build/protos/google/shopping/merchant/lfp/v1beta/lfpsale.proto +122 -0
- package/build/protos/google/shopping/merchant/lfp/v1beta/lfpstore.proto +249 -0
- package/build/protos/google/shopping/type/types.proto +169 -0
- package/build/protos/protos.d.ts +8673 -0
- package/build/protos/protos.js +23511 -0
- package/build/protos/protos.json +2617 -0
- package/build/src/index.d.ts +17 -0
- package/build/src/index.js +37 -0
- package/build/src/index.js.map +1 -0
- package/build/src/v1beta/index.d.ts +3 -0
- package/build/src/v1beta/index.js +27 -0
- package/build/src/v1beta/index.js.map +1 -0
- package/build/src/v1beta/lfp_inventory_service_client.d.ts +267 -0
- package/build/src/v1beta/lfp_inventory_service_client.js +472 -0
- package/build/src/v1beta/lfp_inventory_service_client.js.map +1 -0
- package/build/src/v1beta/lfp_inventory_service_client_config.json +43 -0
- package/build/src/v1beta/lfp_sale_service_client.d.ts +250 -0
- package/build/src/v1beta/lfp_sale_service_client.js +450 -0
- package/build/src/v1beta/lfp_sale_service_client.js.map +1 -0
- package/build/src/v1beta/lfp_sale_service_client_config.json +43 -0
- package/build/src/v1beta/lfp_store_service_client.d.ts +430 -0
- package/build/src/v1beta/lfp_store_service_client.js +645 -0
- package/build/src/v1beta/lfp_store_service_client.js.map +1 -0
- package/build/src/v1beta/lfp_store_service_client_config.json +58 -0
- package/package.json +70 -0
package/CHANGELOG.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
## 0.1.0 (2024-04-18)
|
4
|
+
|
5
|
+
|
6
|
+
### Features
|
7
|
+
|
8
|
+
* Add initial files for google.shopping.merchant.lfp.v1beta ([#5256](https://github.com/googleapis/google-cloud-node/issues/5256)) ([fb90a74](https://github.com/googleapis/google-cloud-node/commit/fb90a7401d631d8ba90207fcce59fa3255cf713f))
|
package/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
@@ -0,0 +1,200 @@
|
|
1
|
+
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
|
2
|
+
[//]: # "To regenerate it, use `python -m synthtool`."
|
3
|
+
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
|
4
|
+
|
5
|
+
# [Merchant API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-shopping-merchant-lfp)
|
6
|
+
|
7
|
+
[](https://cloud.google.com/terms/launch-stages)
|
8
|
+
[](https://www.npmjs.org/package/@google-shopping/lfp)
|
9
|
+
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
Merchant API client for Node.js
|
14
|
+
|
15
|
+
|
16
|
+
A comprehensive list of changes in each version may be found in
|
17
|
+
[the CHANGELOG](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-shopping-merchant-lfp/CHANGELOG.md).
|
18
|
+
|
19
|
+
* [Merchant API Node.js Client API Reference][client-docs]
|
20
|
+
* [Merchant API Documentation][product-docs]
|
21
|
+
* [github.com/googleapis/google-cloud-node/packages/google-shopping-merchant-lfp](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-shopping-merchant-lfp)
|
22
|
+
|
23
|
+
Read more about the client libraries for Cloud APIs, including the older
|
24
|
+
Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
25
|
+
|
26
|
+
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
|
27
|
+
|
28
|
+
**Table of contents:**
|
29
|
+
|
30
|
+
|
31
|
+
* [Quickstart](#quickstart)
|
32
|
+
* [Before you begin](#before-you-begin)
|
33
|
+
* [Installing the client library](#installing-the-client-library)
|
34
|
+
* [Using the client library](#using-the-client-library)
|
35
|
+
* [Samples](#samples)
|
36
|
+
* [Versioning](#versioning)
|
37
|
+
* [Contributing](#contributing)
|
38
|
+
* [License](#license)
|
39
|
+
|
40
|
+
## Quickstart
|
41
|
+
|
42
|
+
### Before you begin
|
43
|
+
|
44
|
+
1. [Select or create a Cloud Platform project][projects].
|
45
|
+
1. [Enable billing for your project][billing].
|
46
|
+
1. [Enable the Merchant API API][enable_api].
|
47
|
+
1. [Set up authentication with a service account][auth] so you can access the
|
48
|
+
API from your local workstation.
|
49
|
+
|
50
|
+
### Installing the client library
|
51
|
+
|
52
|
+
```bash
|
53
|
+
npm install @google-shopping/lfp
|
54
|
+
```
|
55
|
+
|
56
|
+
|
57
|
+
### Using the client library
|
58
|
+
|
59
|
+
```javascript
|
60
|
+
/**
|
61
|
+
* This snippet has been automatically generated and should be regarded as a code template only.
|
62
|
+
* It will require modifications to work.
|
63
|
+
* It may require correct/in-range values for request initialization.
|
64
|
+
* TODO(developer): Uncomment these variables before running the sample.
|
65
|
+
*/
|
66
|
+
/**
|
67
|
+
* Required. The LFP partner.
|
68
|
+
* Format: `accounts/{account}`
|
69
|
+
*/
|
70
|
+
// const parent = 'abc123'
|
71
|
+
/**
|
72
|
+
* Required. The Merchant Center id of the merchant to list stores for.
|
73
|
+
*/
|
74
|
+
// const targetAccount = 1234
|
75
|
+
/**
|
76
|
+
* Optional. The maximum number of `LfpStore` resources for the given account
|
77
|
+
* to return. The service returns fewer than this value if the number of
|
78
|
+
* stores for the given account is less than the `pageSize`. The default value
|
79
|
+
* is 250. The maximum value is 1000; If a value higher than the maximum is
|
80
|
+
* specified, then the `pageSize` will default to the maximum.
|
81
|
+
*/
|
82
|
+
// const pageSize = 1234
|
83
|
+
/**
|
84
|
+
* Optional. A page token, received from a previous `ListLfpStoresRequest`
|
85
|
+
* call. Provide the page token to retrieve the subsequent page. When
|
86
|
+
* paginating, all other parameters provided to `ListLfpStoresRequest` must
|
87
|
+
* match the call that provided the page token. The token returned as
|
88
|
+
* nextPageToken google.shopping.merchant.lfp.v1beta.ListLfpStoresResponse.next_page_token
|
89
|
+
* in the response to the previous request.
|
90
|
+
*/
|
91
|
+
// const pageToken = 'abc123'
|
92
|
+
|
93
|
+
// Imports the Lfp library
|
94
|
+
const {LfpStoreServiceClient} = require('@google-shopping/lfp').v1beta;
|
95
|
+
|
96
|
+
// Instantiates a client
|
97
|
+
const lfpClient = new LfpStoreServiceClient();
|
98
|
+
|
99
|
+
async function callListLfpStores() {
|
100
|
+
// Construct request
|
101
|
+
const request = {
|
102
|
+
parent,
|
103
|
+
targetAccount,
|
104
|
+
};
|
105
|
+
|
106
|
+
// Run request
|
107
|
+
const iterable = lfpClient.listLfpStoresAsync(request);
|
108
|
+
for await (const response of iterable) {
|
109
|
+
console.log(response);
|
110
|
+
}
|
111
|
+
}
|
112
|
+
|
113
|
+
callListLfpStores();
|
114
|
+
|
115
|
+
```
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
## Samples
|
120
|
+
|
121
|
+
Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-shopping-merchant-lfp/samples) directory. Each sample's `README.md` has instructions for running its sample.
|
122
|
+
|
123
|
+
| Sample | Source Code | Try it |
|
124
|
+
| --------------------------- | --------------------------------- | ------ |
|
125
|
+
| Lfp_inventory_service.insert_lfp_inventory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_inventory_service.insert_lfp_inventory.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_inventory_service.insert_lfp_inventory.js,packages/google-shopping-merchant-lfp/samples/README.md) |
|
126
|
+
| Lfp_sale_service.insert_lfp_sale | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_sale_service.insert_lfp_sale.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_sale_service.insert_lfp_sale.js,packages/google-shopping-merchant-lfp/samples/README.md) |
|
127
|
+
| Lfp_store_service.delete_lfp_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_store_service.delete_lfp_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_store_service.delete_lfp_store.js,packages/google-shopping-merchant-lfp/samples/README.md) |
|
128
|
+
| Lfp_store_service.get_lfp_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_store_service.get_lfp_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_store_service.get_lfp_store.js,packages/google-shopping-merchant-lfp/samples/README.md) |
|
129
|
+
| Lfp_store_service.insert_lfp_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_store_service.insert_lfp_store.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_store_service.insert_lfp_store.js,packages/google-shopping-merchant-lfp/samples/README.md) |
|
130
|
+
| Lfp_store_service.list_lfp_stores | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_store_service.list_lfp_stores.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_store_service.list_lfp_stores.js,packages/google-shopping-merchant-lfp/samples/README.md) |
|
131
|
+
| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-shopping-merchant-lfp/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-shopping-merchant-lfp/samples/quickstart.js,packages/google-shopping-merchant-lfp/samples/README.md) |
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
The [Merchant API Node.js Client API Reference][client-docs] documentation
|
136
|
+
also contains samples.
|
137
|
+
|
138
|
+
## Supported Node.js Versions
|
139
|
+
|
140
|
+
Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).
|
141
|
+
Libraries are compatible with all current _active_ and _maintenance_ versions of
|
142
|
+
Node.js.
|
143
|
+
If you are using an end-of-life version of Node.js, we recommend that you update
|
144
|
+
as soon as possible to an actively supported LTS version.
|
145
|
+
|
146
|
+
Google's client libraries support legacy versions of Node.js runtimes on a
|
147
|
+
best-efforts basis with the following warnings:
|
148
|
+
|
149
|
+
* Legacy versions are not tested in continuous integration.
|
150
|
+
* Some security patches and features cannot be backported.
|
151
|
+
* Dependencies cannot be kept up-to-date.
|
152
|
+
|
153
|
+
Client libraries targeting some end-of-life versions of Node.js are available, and
|
154
|
+
can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
|
155
|
+
The dist-tags follow the naming convention `legacy-(version)`.
|
156
|
+
For example, `npm install @google-shopping/lfp@legacy-8` installs client libraries
|
157
|
+
for versions compatible with Node.js 8.
|
158
|
+
|
159
|
+
## Versioning
|
160
|
+
|
161
|
+
This library follows [Semantic Versioning](http://semver.org/).
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
This library is considered to be in **preview**. This means it is still a
|
170
|
+
work-in-progress and under active development. Any release is subject to
|
171
|
+
backwards-incompatible changes at any time.
|
172
|
+
|
173
|
+
|
174
|
+
More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
175
|
+
|
176
|
+
[launch_stages]: https://cloud.google.com/terms/launch-stages
|
177
|
+
|
178
|
+
## Contributing
|
179
|
+
|
180
|
+
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
|
181
|
+
|
182
|
+
Please note that this `README.md`, the `samples/README.md`,
|
183
|
+
and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
|
184
|
+
are generated from a central template. To edit one of these files, make an edit
|
185
|
+
to its templates in
|
186
|
+
[directory](https://github.com/googleapis/synthtool).
|
187
|
+
|
188
|
+
## License
|
189
|
+
|
190
|
+
Apache Version 2.0
|
191
|
+
|
192
|
+
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
|
193
|
+
|
194
|
+
[client-docs]: https://cloud.google.com/nodejs/docs/reference/merchantapi/latest
|
195
|
+
[product-docs]: https://developers.google.com/merchant/api
|
196
|
+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
|
197
|
+
[projects]: https://console.cloud.google.com/project
|
198
|
+
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
|
199
|
+
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=merchantapi.googleapis.com
|
200
|
+
[auth]: https://cloud.google.com/docs/authentication/getting-started
|
@@ -0,0 +1,149 @@
|
|
1
|
+
// Copyright 2023 Google LLC
|
2
|
+
//
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
// you may not use this file except in compliance with the License.
|
5
|
+
// You may obtain a copy of the License at
|
6
|
+
//
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
//
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
// See the License for the specific language governing permissions and
|
13
|
+
// limitations under the License.
|
14
|
+
|
15
|
+
syntax = "proto3";
|
16
|
+
|
17
|
+
package google.shopping.merchant.lfp.v1beta;
|
18
|
+
|
19
|
+
import "google/api/annotations.proto";
|
20
|
+
import "google/api/client.proto";
|
21
|
+
import "google/api/field_behavior.proto";
|
22
|
+
import "google/api/resource.proto";
|
23
|
+
import "google/protobuf/timestamp.proto";
|
24
|
+
import "google/shopping/type/types.proto";
|
25
|
+
|
26
|
+
option go_package = "cloud.google.com/go/shopping/merchant/lfp/apiv1beta/lfppb;lfppb";
|
27
|
+
option java_multiple_files = true;
|
28
|
+
option java_outer_classname = "LfpInventoryProto";
|
29
|
+
option java_package = "com.google.shopping.merchant.lfp.v1beta";
|
30
|
+
option (google.api.resource_definition) = {
|
31
|
+
type: "merchantapi.googleapis.com/Account"
|
32
|
+
pattern: "accounts/{account}"
|
33
|
+
};
|
34
|
+
|
35
|
+
// Service for a [LFP
|
36
|
+
// partner](https://support.google.com/merchants/answer/7676652) to submit local
|
37
|
+
// inventories for a merchant.
|
38
|
+
service LfpInventoryService {
|
39
|
+
option (google.api.default_host) = "merchantapi.googleapis.com";
|
40
|
+
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/content";
|
41
|
+
|
42
|
+
// Inserts a `LfpInventory` resource for the given target merchant account. If
|
43
|
+
// the resource already exists, it will be replaced. The inventory
|
44
|
+
// automatically expires after 30 days.
|
45
|
+
rpc InsertLfpInventory(InsertLfpInventoryRequest) returns (LfpInventory) {
|
46
|
+
option (google.api.http) = {
|
47
|
+
post: "/lfp/v1beta/{parent=accounts/*}/lfpInventories:insert"
|
48
|
+
body: "lfp_inventory"
|
49
|
+
};
|
50
|
+
}
|
51
|
+
}
|
52
|
+
|
53
|
+
// Local Inventory for the merchant.
|
54
|
+
message LfpInventory {
|
55
|
+
option (google.api.resource) = {
|
56
|
+
type: "merchantapi.googleapis.com/LfpInventory"
|
57
|
+
pattern: "accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}"
|
58
|
+
plural: "lfpInventories"
|
59
|
+
singular: "lfpInventory"
|
60
|
+
};
|
61
|
+
|
62
|
+
// Output only. Identifier. The name for the `LfpInventory` resource.
|
63
|
+
// Format:
|
64
|
+
// `accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}`
|
65
|
+
string name = 1 [
|
66
|
+
(google.api.field_behavior) = OUTPUT_ONLY,
|
67
|
+
(google.api.field_behavior) = IDENTIFIER
|
68
|
+
];
|
69
|
+
|
70
|
+
// Required. The Merchant Center ID of the merchant to submit the inventory
|
71
|
+
// for.
|
72
|
+
int64 target_account = 2 [(google.api.field_behavior) = REQUIRED];
|
73
|
+
|
74
|
+
// Required. The identifier of the merchant's store. Either the store code
|
75
|
+
// inserted through `InsertLfpStore` or the store code in the Business
|
76
|
+
// Profile.
|
77
|
+
string store_code = 3 [(google.api.field_behavior) = REQUIRED];
|
78
|
+
|
79
|
+
// Required. Immutable. A unique identifier for the product. If both
|
80
|
+
// inventories and sales are submitted for a merchant, this id should match
|
81
|
+
// for the same product.
|
82
|
+
//
|
83
|
+
// **Note**: if the merchant sells the same product new and used, they should
|
84
|
+
// have different IDs.
|
85
|
+
string offer_id = 4 [
|
86
|
+
(google.api.field_behavior) = REQUIRED,
|
87
|
+
(google.api.field_behavior) = IMMUTABLE
|
88
|
+
];
|
89
|
+
|
90
|
+
// Required. The [CLDR territory
|
91
|
+
// code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml)
|
92
|
+
// for the country where the product is sold.
|
93
|
+
string region_code = 5 [(google.api.field_behavior) = REQUIRED];
|
94
|
+
|
95
|
+
// Required. The two-letter ISO 639-1 language code for the item.
|
96
|
+
string content_language = 6 [(google.api.field_behavior) = REQUIRED];
|
97
|
+
|
98
|
+
// Optional. The Global Trade Item Number of the product.
|
99
|
+
optional string gtin = 7 [(google.api.field_behavior) = OPTIONAL];
|
100
|
+
|
101
|
+
// Optional. The current price of the product.
|
102
|
+
google.shopping.type.Price price = 8 [(google.api.field_behavior) = OPTIONAL];
|
103
|
+
|
104
|
+
// Required. Availability of the product at this store.
|
105
|
+
// For accepted attribute values, see the [local product inventory feed
|
106
|
+
// specification](https://support.google.com/merchants/answer/3061342)
|
107
|
+
string availability = 9 [(google.api.field_behavior) = REQUIRED];
|
108
|
+
|
109
|
+
// Optional. Quantity of the product available at this store. Must be greater
|
110
|
+
// than or equal to zero.
|
111
|
+
optional int64 quantity = 10 [(google.api.field_behavior) = OPTIONAL];
|
112
|
+
|
113
|
+
// Optional. The time when the inventory is collected. If not set, it will be
|
114
|
+
// set to the time when the inventory is submitted.
|
115
|
+
google.protobuf.Timestamp collection_time = 11
|
116
|
+
[(google.api.field_behavior) = OPTIONAL];
|
117
|
+
|
118
|
+
// Optional. Supported pickup method for this offer. Unless the value is "not
|
119
|
+
// supported", this field must be submitted together with `pickupSla`. For
|
120
|
+
// accepted attribute values, see the [local product inventory feed
|
121
|
+
// specification](https://support.google.com/merchants/answer/3061342).
|
122
|
+
optional string pickup_method = 12 [(google.api.field_behavior) = OPTIONAL];
|
123
|
+
|
124
|
+
// Optional. Expected date that an order will be ready for pickup relative to
|
125
|
+
// the order date. Must be submitted together with `pickupMethod`. For
|
126
|
+
// accepted attribute values, see the [local product inventory feed
|
127
|
+
// specification](https://support.google.com/merchants/answer/3061342).
|
128
|
+
optional string pickup_sla = 13 [(google.api.field_behavior) = OPTIONAL];
|
129
|
+
|
130
|
+
// Optional. The [feed
|
131
|
+
// label](https://developers.google.com/shopping-content/guides/products/feed-labels)
|
132
|
+
// for the product. If this is not set, it will default to `regionCode`.
|
133
|
+
optional string feed_label = 14 [(google.api.field_behavior) = OPTIONAL];
|
134
|
+
}
|
135
|
+
|
136
|
+
// Request message for the `InsertLfpInventory` method.
|
137
|
+
message InsertLfpInventoryRequest {
|
138
|
+
// Required. The LFP provider account.
|
139
|
+
// Format: `accounts/{account}`
|
140
|
+
string parent = 1 [
|
141
|
+
(google.api.field_behavior) = REQUIRED,
|
142
|
+
(google.api.resource_reference) = {
|
143
|
+
child_type: "merchantapi.googleapis.com/LfpInventory"
|
144
|
+
}
|
145
|
+
];
|
146
|
+
|
147
|
+
// Required. The inventory to insert.
|
148
|
+
LfpInventory lfp_inventory = 2 [(google.api.field_behavior) = REQUIRED];
|
149
|
+
}
|