Merchant API . accounts . omnichannelSettings . lfpProviders

close()

Close httplib2 connections.

find(parent, pageSize=None, pageToken=None, x__xgafv=None)

Find the LFP provider candidates in a given country.

Args:
  parent: string, Required. The name of the parent resource under which the LFP providers are found. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`. (required)
  pageSize: integer, Optional. The maximum number of `LfpProvider` resources to return. The service returns fewer than this value if the number of lfp providers is less that than the `pageSize`. The default value is 50. 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 `FindLfpProviders` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `FindLfpProviders` must match the call that provided the page token.
  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 FindLfpProviders method.
  "lfpProviders": [ # The LFP providers from the specified merchant in the specified country.
    { # Collection of information related to a Local Feed Partnership (LFP) provider.
      "displayName": "A String", # The display name of the LFP provider.
      "name": "A String", # Identifier. The resource name of the LFP provider. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}`
      "regionCode": "A String", # Output only. Region code defined by [CLDR](https://cldr.unicode.org/).
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

find_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.
        

linkLfpProvider(name, body=None, x__xgafv=None)

Link the specified merchant to a LFP provider for the specified country.

Args:
  name: string, Required. The name of the LFP provider resource to link. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}`. The `lfp_provider` is the LFP provider ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the LinkLfpProvider method.
  "externalAccountId": "A String", # Required. The external account ID by which this merchant is known to the LFP provider.
}

  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 LinkLfpProvider method.
  "response": { # 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); } # Empty response.
  },
}