REST Resource: chains

    • A Chain represents a brand with which your business locations can be affiliated, containing information like name, websites, and location count.

    • Chains can be identified by a unique resource name and have multiple display names in different languages.

    • You can programmatically access chain information using the provided methods: get to retrieve a specific chain and search to find chains based on name.

    • Chain information includes websites represented as URIs for online presence and chainNames for display purposes with language specifications.

    Resource: Chain

    A chain is a brand that your business's locations can be affiliated with.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "chainNames" 
 : 
 [ 
 { 
 object (  ChainName 
 
) 
 } 
 ] 
 , 
 "websites" 
 : 
 [ 
 { 
 object (  ChainUri 
 
) 
 } 
 ] 
 , 
 "locationCount" 
 : 
 integer 
 }
    Fields
    name

    string

    Required. The chain's resource name, in the format chains/{chain_id} .
    chainNames[]

    object ( ChainName )

    Names of the chain.
    websites[]

    object ( ChainUri )

    Websites of the chain.
    locationCount

    integer

    Number of locations that are part of this chain.

    ChainName

    Name to be used when displaying the chain.

    JSON representation 
     { 
 "displayName" 
 : 
 string 
 , 
 "languageCode" 
 : 
 string 
 }
    Fields
    displayName

    string

    The display name for this chain.
    languageCode

    string

    The BCP 47 code of language of the name.

    ChainUri

    Url to be used when displaying the chain.

    JSON representation 
     { 
 "uri" 
 : 
 string 
 }
    Fields
    uri

    string

    The uri for this chain.

    Methods

    get

    		Gets the specified chain.
    Searches the chain based on chain name.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: