@google-shopping/lfp 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.5.0](https://github.com/googleapis/google-cloud-node/compare/lfp-v0.4.1...lfp-v0.5.0) (2025-05-09)
+
+
+### Features
+
+* [merchantapi] Add GetLfpMerchantState method ([#6259](https://github.com/googleapis/google-cloud-node/issues/6259)) ([31d2647](https://github.com/googleapis/google-cloud-node/commit/31d264703dc99125aae56551999d86cdedfc1b81))
+* Multiple ai-platform updates ([0b8b1a7](https://github.com/googleapis/google-cloud-node/commit/0b8b1a75f33bdf94000321d239834b9b10757862))
+
 ## [0.4.1](https://github.com/googleapis/google-cloud-node/compare/lfp-v0.4.0...lfp-v0.4.1) (2025-03-21)
 
 

package/README.md

@@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 1.  [Select or create a Cloud Platform project][projects].
 1.  [Enable billing for your project][billing].
 1.  [Enable the Merchant API API][enable_api].
-1.  [Set up authentication with a service account][auth] so you can access the
+1.  [Set up authentication][auth] so you can access the
     API from your local workstation.
 
 ### Installing the client library
@@ -122,13 +122,14 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 
 | Sample                      | Source Code                       | Try it |
 | --------------------------- | --------------------------------- | ------ |
-| 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) |
-| 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) |
-| 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) |
-| 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) |
-| 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) |
-| 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) |
-| 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) |
+| Lfp_inventory_service.insert_lfp_inventory | [source code](https://github.com/googleapis/google-cloud-node/blob/master/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) |
+| Lfp_merchant_state_service.get_lfp_merchant_state | [source code](https://github.com/googleapis/google-cloud-node/blob/master/packages/google-shopping-merchant-lfp/samples/generated/v1beta/lfp_merchant_state_service.get_lfp_merchant_state.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_merchant_state_service.get_lfp_merchant_state.js,packages/google-shopping-merchant-lfp/samples/README.md) |
+| Lfp_sale_service.insert_lfp_sale | [source code](https://github.com/googleapis/google-cloud-node/blob/master/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) |
+| Lfp_store_service.delete_lfp_store | [source code](https://github.com/googleapis/google-cloud-node/blob/master/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) |
+| Lfp_store_service.get_lfp_store | [source code](https://github.com/googleapis/google-cloud-node/blob/master/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) |
+| Lfp_store_service.insert_lfp_store | [source code](https://github.com/googleapis/google-cloud-node/blob/master/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) |
+| Lfp_store_service.list_lfp_stores | [source code](https://github.com/googleapis/google-cloud-node/blob/master/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) |
+| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/master/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) |
 
 
 
@@ -177,7 +178,7 @@ More Information: [Google Cloud Platform Launch Stages][launch_stages]
 
 ## Contributing
 
-Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
+Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/master/CONTRIBUTING.md).
 
 Please note that this `README.md`, the `samples/README.md`,
 and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
@@ -189,7 +190,7 @@ to its templates in
 
 Apache Version 2.0
 
-See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
+See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/master/LICENSE)
 
 [client-docs]: https://cloud.google.com/nodejs/docs/reference/merchantapi/latest
 [product-docs]: https://developers.google.com/merchant/api
@@ -197,4 +198,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
 [projects]: https://console.cloud.google.com/project
 [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
 [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=merchantapi.googleapis.com
-[auth]: https://cloud.google.com/docs/authentication/getting-started
+[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local

package/build/protos/google/shopping/merchant/lfp/v1beta/lfpmerchantstate.proto

@@ -0,0 +1,201 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.shopping.merchant.lfp.v1beta;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option go_package = "cloud.google.com/go/shopping/merchant/lfp/apiv1beta/lfppb;lfppb";
+option java_multiple_files = true;
+option java_outer_classname = "LfpMerchantStateProto";
+option java_package = "com.google.shopping.merchant.lfp.v1beta";
+
+// Service for a [LFP
+// partner](https://support.google.com/merchants/answer/7676652) to get the
+// state of a merchant.
+service LfpMerchantStateService {
+  option (google.api.default_host) = "merchantapi.googleapis.com";
+  option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/content";
+
+  // Gets the LFP state of a merchant
+  rpc GetLfpMerchantState(GetLfpMerchantStateRequest)
+      returns (LfpMerchantState) {
+    option (google.api.http) = {
+      get: "/lfp/v1beta/{name=accounts/*/lfpMerchantStates/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+}
+
+// The LFP state of a merchant.
+message LfpMerchantState {
+  option (google.api.resource) = {
+    type: "merchantapi.googleapis.com/LfpMerchantState"
+    pattern: "accounts/{account}/lfpMerchantStates/{lfp_merchant_state}"
+    plural: "lfpMerchantStates"
+    singular: "lfpMerchantState"
+  };
+
+  // The state of a specific merchant's store.
+  message LfpStoreState {
+    // The state of matching `LfpStore` to a Google Business Profile listing.
+    enum StoreMatchingState {
+      // Store matching state unspecified.
+      STORE_MATCHING_STATE_UNSPECIFIED = 0;
+
+      // The `LfpStore` is successfully matched with a Google Business Profile
+      // store.
+      STORE_MATCHING_STATE_MATCHED = 1;
+
+      // The `LfpStore` is not matched with a Google Business Profile store.
+      STORE_MATCHING_STATE_FAILED = 2;
+    }
+
+    // Required. Immutable. The identifier of this store.
+    string store_code = 1 [
+      (google.api.field_behavior) = REQUIRED,
+      (google.api.field_behavior) = IMMUTABLE
+    ];
+
+    // Output only. The store matching state.
+    StoreMatchingState matching_state = 2
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // The hint of why the matching has failed (only set if matching_state is
+    // FAILED).
+    string matching_state_hint = 3;
+  }
+
+  // The inventory statistics for a merchant.
+  message InventoryStats {
+    // Number of entries (understanding entry as a pair of product and store)
+    // that were built based on provided inventories/sales and submitted to
+    // Google.
+    int64 submitted_entries = 1;
+
+    // Number of submitted in stock entries.
+    int64 submitted_in_stock_entries = 2;
+
+    // Number of entries that were built based on provided
+    // inventories/sales and couldn't be submitted to Google due to errors like
+    // missing product.
+    int64 unsubmitted_entries = 3;
+
+    // Number of products from provided inventories/sales that were created from
+    // matches to existing online products provided by the merchant or to the
+    // Google catalog.
+    int64 submitted_products = 4;
+  }
+
+  // Country-specific settings for the merchant.
+  message CountrySettings {
+    // The possible verification states for different merchant programs.
+    enum VerificationState {
+      // Verification state unspecified.
+      VERIFICATION_STATE_UNSPECIFIED = 0;
+
+      // Verification state not approved.
+      VERIFICATION_STATE_NOT_APPROVED = 1;
+
+      // Verification state in progress.
+      VERIFICATION_STATE_IN_PROGRESS = 2;
+
+      // Verification state approved.
+      VERIFICATION_STATE_APPROVED = 3;
+    }
+
+    // The possible [product page
+    // types](https://support.google.com/merchants/topic/15148370) for a
+    // merchant.
+    enum ProductPageType {
+      // Product page type unspecified.
+      PRODUCT_PAGE_TYPE_UNSPECIFIED = 0;
+
+      // Google hosted product page.
+      GOOGLE_HOSTED = 1;
+
+      // Merchant hosted product page.
+      MERCHANT_HOSTED = 2;
+
+      // Merchant hosted store specific product page.
+      MERCHANT_HOSTED_STORE_SPECIFIC = 3;
+    }
+
+    // Required. The [CLDR territory
+    // code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml)
+    // for the country for which these settings are defined.
+    string region_code = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // True if this merchant has enabled free local listings in MC.
+    bool free_local_listings_enabled = 2;
+
+    // True if this merchant has enabled local inventory ads in MC.
+    bool local_inventory_ads_enabled = 3;
+
+    // Output only. The verification state of this merchant's inventory check.
+    VerificationState inventory_verification_state = 4
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The product page type selected by this merchant.
+    ProductPageType product_page_type = 5
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The verification state of this merchant's instock serving
+    // feature.
+    VerificationState instock_serving_verification_state = 6
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The verification state of this merchant's pickup serving
+    // feature.
+    VerificationState pickup_serving_verification_state = 7
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // Identifier. The name of the `LfpMerchantState` resource. Format:
+  // `accounts/{account}/lfpMerchantStates/{target_merchant}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Number of [GBPs](https://www.google.com/business/) this merchant has access
+  // to.
+  int64 linked_gbps = 2;
+
+  // Output only. The state per store from the specified merchant. The field
+  // will be absent if the merchant has no stores submitted through LFP.
+  repeated LfpStoreState store_states = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // The inventory statistics for the merchant. The field will be absent if the
+  // merchant has no inventory submitted through LFP.
+  InventoryStats inventory_stats = 4;
+
+  // Country-specific settings for the merchant.
+  repeated CountrySettings country_settings = 5;
+}
+
+// Request message for the GetLfpMerchantState method.
+message GetLfpMerchantStateRequest {
+  // Required. The name of the state to retrieve.
+  // Format: `accounts/{account}/lfpMerchantStates/{target_merchant}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "merchantapi.googleapis.com/LfpMerchantState"
+    }
+  ];
+}