REST Resource: chains

    • A Chain represents a brand with multiple business locations, containing information like name, websites, and location count.

    • Chain data includes ChainName for display purposes and ChainUrl for website links.

    • You can programmatically access chain data using the get and search methods provided.

    • The Chain resource uses JSON for data representation and includes fields for identifying the chain and related information.

    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 (  ChainUrl 
 
) 
 } 
 ] 
 , 
 "locationCount" 
 : 
 integer 
 }
    Fields
    name

    string

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

    object ( ChainName )

    Names of the chain.
    websites[]

    object ( ChainUrl )

    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.

    ChainUrl

    Url to be used when displaying the chain.

    JSON representation 
     { 
 "url" 
 : 
 string 
 }
    Fields
    url

    string

    The url 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: