Merchant API . accounts . lfpStores

Instance Methods

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

Deletes a store for a target merchant.

get(name, x__xgafv=None)

Retrieves information about a store.

insert(parent, body=None, x__xgafv=None)

Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.

list(parent, pageSize=None, pageToken=None, targetAccount=None, x__xgafv=None)

Lists the stores of the target merchant, specified by the filter in `ListLfpStoresRequest`.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
delete(name, x__xgafv=None)
Deletes a store for a target merchant.

Args:
  name: string, Required. The name of the store to delete for the target merchant account. Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Retrieves information about a store.

Args:
  name: string, Required. The name of the store to retrieve. Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used.
  "gcidCategory": [ # Optional. [Google My Business category id](https://gcid-explorer.corp.google.com/static/gcid.html).
    "A String",
  ],
  "matchingState": "A String", # Optional. Output only. The state of matching to a Google Business Profile. See matchingStateHint for further details if no match is found.
  "matchingStateHint": "A String", # Optional. Output only. The hint of why the matching has failed. This is only set when matchingState=`STORE_MATCHING_STATE_FAILED`. Possible values are: - "`linked-store-not-found`": There aren't any Google Business Profile stores available for matching. - "`store-match-not-found`": The provided `LfpStore` couldn't be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but the `LfpStore` location address does not match with Google Business Profile stores' addresses. Update the `LfpStore` address or Google Business Profile store address to match correctly. - "`store-match-unverified`": The provided `LfpStore` couldn't be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.
  "name": "A String", # Output only. Identifier. The name of the `LfpStore` resource. Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
  "phoneNumber": "A String", # Optional. The store phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. Example: `+15556767888`
  "placeId": "A String", # Optional. The [Google Place Id](https://developers.google.com/maps/documentation/places/web-service/place-id#id-overview) of the store location.
  "storeAddress": "A String", # Required. The street address of the store. Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.
  "storeCode": "A String", # Required. Immutable. A store identifier that is unique for the target merchant.
  "storeName": "A String", # Optional. The merchant or store name.
  "targetAccount": "A String", # Required. The Merchant Center id of the merchant to submit the store for.
  "websiteUri": "A String", # Optional. The website URL for the store or merchant.
}
insert(parent, body=None, x__xgafv=None)
Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.

Args:
  parent: string, Required. The LFP provider account Format: `accounts/{account}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used.
  "gcidCategory": [ # Optional. [Google My Business category id](https://gcid-explorer.corp.google.com/static/gcid.html).
    "A String",
  ],
  "matchingState": "A String", # Optional. Output only. The state of matching to a Google Business Profile. See matchingStateHint for further details if no match is found.
  "matchingStateHint": "A String", # Optional. Output only. The hint of why the matching has failed. This is only set when matchingState=`STORE_MATCHING_STATE_FAILED`. Possible values are: - "`linked-store-not-found`": There aren't any Google Business Profile stores available for matching. - "`store-match-not-found`": The provided `LfpStore` couldn't be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but the `LfpStore` location address does not match with Google Business Profile stores' addresses. Update the `LfpStore` address or Google Business Profile store address to match correctly. - "`store-match-unverified`": The provided `LfpStore` couldn't be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.
  "name": "A String", # Output only. Identifier. The name of the `LfpStore` resource. Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
  "phoneNumber": "A String", # Optional. The store phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. Example: `+15556767888`
  "placeId": "A String", # Optional. The [Google Place Id](https://developers.google.com/maps/documentation/places/web-service/place-id#id-overview) of the store location.
  "storeAddress": "A String", # Required. The street address of the store. Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.
  "storeCode": "A String", # Required. Immutable. A store identifier that is unique for the target merchant.
  "storeName": "A String", # Optional. The merchant or store name.
  "targetAccount": "A String", # Required. The Merchant Center id of the merchant to submit the store for.
  "websiteUri": "A String", # Optional. The website URL for the store or merchant.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used.
  "gcidCategory": [ # Optional. [Google My Business category id](https://gcid-explorer.corp.google.com/static/gcid.html).
    "A String",
  ],
  "matchingState": "A String", # Optional. Output only. The state of matching to a Google Business Profile. See matchingStateHint for further details if no match is found.
  "matchingStateHint": "A String", # Optional. Output only. The hint of why the matching has failed. This is only set when matchingState=`STORE_MATCHING_STATE_FAILED`. Possible values are: - "`linked-store-not-found`": There aren't any Google Business Profile stores available for matching. - "`store-match-not-found`": The provided `LfpStore` couldn't be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but the `LfpStore` location address does not match with Google Business Profile stores' addresses. Update the `LfpStore` address or Google Business Profile store address to match correctly. - "`store-match-unverified`": The provided `LfpStore` couldn't be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.
  "name": "A String", # Output only. Identifier. The name of the `LfpStore` resource. Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
  "phoneNumber": "A String", # Optional. The store phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. Example: `+15556767888`
  "placeId": "A String", # Optional. The [Google Place Id](https://developers.google.com/maps/documentation/places/web-service/place-id#id-overview) of the store location.
  "storeAddress": "A String", # Required. The street address of the store. Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.
  "storeCode": "A String", # Required. Immutable. A store identifier that is unique for the target merchant.
  "storeName": "A String", # Optional. The merchant or store name.
  "targetAccount": "A String", # Required. The Merchant Center id of the merchant to submit the store for.
  "websiteUri": "A String", # Optional. The website URL for the store or merchant.
}
list(parent, pageSize=None, pageToken=None, targetAccount=None, x__xgafv=None)
Lists the stores of the target merchant, specified by the filter in `ListLfpStoresRequest`.

Args:
  parent: string, Required. The LFP partner. Format: `accounts/{account}` (required)
  pageSize: integer, Optional. The maximum number of `LfpStore` resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the `pageSize`. The default value is 250. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
  pageToken: string, Optional. A page token, received from a previous `ListLfpStoresRequest` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListLfpStoresRequest` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
  targetAccount: string, Required. The Merchant Center id of the merchant to list stores for.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the ListLfpStores method.
  "lfpStores": [ # The stores from the specified merchant.
    { # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used.
      "gcidCategory": [ # Optional. [Google My Business category id](https://gcid-explorer.corp.google.com/static/gcid.html).
        "A String",
      ],
      "matchingState": "A String", # Optional. Output only. The state of matching to a Google Business Profile. See matchingStateHint for further details if no match is found.
      "matchingStateHint": "A String", # Optional. Output only. The hint of why the matching has failed. This is only set when matchingState=`STORE_MATCHING_STATE_FAILED`. Possible values are: - "`linked-store-not-found`": There aren't any Google Business Profile stores available for matching. - "`store-match-not-found`": The provided `LfpStore` couldn't be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but the `LfpStore` location address does not match with Google Business Profile stores' addresses. Update the `LfpStore` address or Google Business Profile store address to match correctly. - "`store-match-unverified`": The provided `LfpStore` couldn't be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.
      "name": "A String", # Output only. Identifier. The name of the `LfpStore` resource. Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
      "phoneNumber": "A String", # Optional. The store phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. Example: `+15556767888`
      "placeId": "A String", # Optional. The [Google Place Id](https://developers.google.com/maps/documentation/places/web-service/place-id#id-overview) of the store location.
      "storeAddress": "A String", # Required. The street address of the store. Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.
      "storeCode": "A String", # Required. Immutable. A store identifier that is unique for the target merchant.
      "storeName": "A String", # Optional. The merchant or store name.
      "targetAccount": "A String", # Required. The Merchant Center id of the merchant to submit the store for.
      "websiteUri": "A String", # Optional. The website URL for the store or merchant.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.