get(name, x__xgafv=None)

Gets the specified chain. Returns `NOT_FOUND` if the chain does not exist.

Args:
  name: string, Required. The chain's resource name, in the format `chains/{chain_place_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A chain is a brand that your business's locations can be affiliated with.
  "chainNames": [ # Names of the chain.
    { # Name to be used when displaying the chain.
      "displayName": "A String", # The display name for this chain.
      "languageCode": "A String", # The BCP 47 code of language of the name.
    },
  ],
  "locationCount": 42, # Number of locations that are part of this chain.
  "name": "A String", # Required. The chain's resource name, in the format `chains/{chain_id}`.
  "websites": [ # Websites of the chain.
    { # Url to be used when displaying the chain.
      "uri": "A String", # The uri for this chain.
    },
  ],
}

search(chainName=None, pageSize=None, x__xgafv=None)

Searches the chain based on chain name.

Args:
  chainName: string, Required. Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"
  pageSize: integer, The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500.
  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 Locations.SearchChains.
  "chains": [ # Chains that match the queried chain_display_name in SearchChainsRequest. If there are no matches, this field will be empty. Results are listed in order of relevance.
    { # A chain is a brand that your business's locations can be affiliated with.
      "chainNames": [ # Names of the chain.
        { # Name to be used when displaying the chain.
          "displayName": "A String", # The display name for this chain.
          "languageCode": "A String", # The BCP 47 code of language of the name.
        },
      ],
      "locationCount": 42, # Number of locations that are part of this chain.
      "name": "A String", # Required. The chain's resource name, in the format `chains/{chain_id}`.
      "websites": [ # Websites of the chain.
        { # Url to be used when displaying the chain.
          "uri": "A String", # The uri for this chain.
        },
      ],
    },
  ],
}

My Business Business Information API . chains

Instance Methods

Method Details