GeocodeParsedQueryAddressComponents ¶

class GeocodeParsedQueryAddressComponents(TypedDict, closed=True):
    country: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>The alpha-2 or alpha-3 character code for the country that the results will be present in.</p>"""
    region: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>The region or state results should be present in. </p> <p>Example: <code>North Rhine-Westphalia</code>.</p>"""
    sub_region: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>The sub-region or county for which results should be present in. </p>"""
    locality: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>The city or locality of the address.</p> <p>Example: <code>Vancouver</code>.</p>"""
    district: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>The district or division of a city the results should be present in.</p>"""
    sub_district: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>A subdivision of a district. </p> <p>Example: <code>Minden-Lübbecke</code>.</p>"""
    postal_code: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess. </p>"""
    block: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>Name of the block. </p> <p>Example: <code>Sunny Mansion 203 block: 2 Chome</code> </p>"""
    sub_block: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>Name of sub-block. </p> <p>Example: <code>Sunny Mansion 203 sub-block: 4</code> </p>"""
    street: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>The name of the street results should be present in.</p>"""
    address_number: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>The number that identifies an address within a street.</p>"""
    building: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>The name of the building at the address.</p>"""
    secondary_address_components: NotRequired[
        "capo_geo_places.types.parsed_query_secondary_address_component_list.ParsedQuerySecondaryAddressComponentList"
    ]
    """<p>Parsed secondary address components from the provided query text.</p> <note> <p>Coverage for <code>ParsedQuery.Address.SecondaryAddressComponents</code> is available in the following countries:</p> <p>AUS, AUT, BRA, CAN, ESP, FRA, GBR, HKG, IDN, IND, NZL, TUR, TWN, USA</p> </note>"""
    other_components: NotRequired[
        "capo_geo_places.types.parsed_query_component_list.ParsedQueryComponentList"
    ]
    """<p>Additional information extracted from the query that does not correspond to standard address components.</p>"""