O endpoint buildingInsights oferece insights sobre a localização, as dimensões e o potencial solar de um edifício. Mais especificamente, você pode receber informações sobre:
- Potencial solar, incluindo tamanho do painel solar, quantidade anual de luz solar, fatores de compensação de carbono e muito mais
- Posição, orientação e produção de energia do painel solar
- Fatura mensal estimada de energia do layout solar ideal e custos e benefícios associados
Para saber mais sobre como a API Solar define o potencial solar e a intensidade de luz solar, consulte Conceitos da API Solar.
O API Explorer permite fazer solicitações em tempo real para que você se familiarize com a API e as opções dela:
Sobre a criação de solicitações de insights
Para solicitar insights de construção, envie uma solicitação HTTP GET para:
https://solar.googleapis.com/v1/buildingInsights:findClosest?key=YOUR_API_KEY
Inclua os parâmetros do URL da solicitação que especificam as coordenadas de latitude e longitude do local e o nível mínimo de qualidade permitido nos resultados.
Exemplo de solicitação de insights de construção
O exemplo a seguir solicita informações de insights de construção para o local nas coordenadas de latitude = 37,4450 e longitude = -122,1390:
Chave de API
Para fazer uma solicitação ao URL na resposta, anexe sua chave de API ao URL:
curl -X GET "https://solar.googleapis.com/v1/buildingInsights:findClosest?location.latitude=37.4450 &location.longitude=-122.1390 &requiredQuality=HIGH &key=YOUR_API_KEY"
Também é possível fazer solicitações HTTP colando o URL na solicitação cURL na barra de URL do navegador. A transmissão da chave de API oferece recursos de uso e análise melhores e um controle de acesso melhor aos dados de resposta.
Token OAuth
Observação:esse formato é apenas para um ambiente de teste. Para mais informações, consulte Usar o OAuth.
Para fazer uma solicitação ao URL na resposta, transmita o nome do projeto de faturamento e o token OAuth:
curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_NUMBER_OR_ID" \
"https://solar.googleapis.com/v1/buildingInsights:findClosest?location.latitude=37.4450&location.longitude=-122.1390"
TypeScript
Para fazer uma solicitação ao URL na resposta, inclua a chave de API ou o token OAuth na solicitação. Confira um exemplo que usa uma chave de API:
/**
* Fetches the building insights information from the Solar API.
* https://developers.google.com/maps/documentation/solar/building-insights
*
* @param {LatLng} location Point of interest as latitude longitude.
* @param {string} apiKey Google Cloud API key.
* @return {Promise<DataLayersResponse>} Building Insights response.
*/
export async function findClosestBuilding(
location: google.maps.LatLng,
apiKey: string,
): Promise<BuildingInsightsResponse> {
const args = {
'location.latitude': location.lat().toFixed(5),
'location.longitude': location.lng().toFixed(5),
};
console.log('GET buildingInsights\n', args);
const params = new URLSearchParams({ ...args, key: apiKey });
// https://developers.google.com/maps/documentation/solar/reference/rest/v1/buildingInsights/findClosest
return fetch(`https://solar.googleapis.com/v1/buildingInsights:findClosest?${params}`).then(
async (response) => {
const content = await response.json();
if (response.status != 200) {
console.error('findClosestBuilding\n', content);
throw content;
}
console.log('buildingInsightsResponse', content);
return content;
},
);
}
Definições de tipos de dados
Os seguintes tipos de dados são aceitos:
export interface DataLayersResponse {
imageryDate: Date;
imageryProcessedDate: Date;
dsmUrl: string;
rgbUrl: string;
maskUrl: string;
annualFluxUrl: string;
monthlyFluxUrl: string;
hourlyShadeUrls: string[];
imageryQuality: 'HIGH' | 'MEDIUM' | 'LOW';
}
export interface Bounds {
north: number;
south: number;
east: number;
west: number;
}
// https://developers.google.com/maps/documentation/solar/reference/rest/v1/buildingInsights/findClosest
export interface BuildingInsightsResponse {
name: string;
center: LatLng;
boundingBox: LatLngBox;
imageryDate: Date;
imageryProcessedDate: Date;
postalCode: string;
administrativeArea: string;
statisticalArea: string;
regionCode: string;
solarPotential: SolarPotential;
imageryQuality: 'HIGH' | 'MEDIUM' | 'LOW';
}
export interface SolarPotential {
maxArrayPanelsCount: number;
panelCapacityWatts: number;
panelHeightMeters: number;
panelWidthMeters: number;
panelLifetimeYears: number;
maxArrayAreaMeters2: number;
maxSunshineHoursPerYear: number;
carbonOffsetFactorKgPerMwh: number;
wholeRoofStats: SizeAndSunshineStats;
buildingStats: SizeAndSunshineStats;
roofSegmentStats: RoofSegmentSizeAndSunshineStats[];
solarPanels: SolarPanel[];
solarPanelConfigs: SolarPanelConfig[];
financialAnalyses: object;
}
export interface SizeAndSunshineStats {
areaMeters2: number;
sunshineQuantiles: number[];
groundAreaMeters2: number;
}
export interface RoofSegmentSizeAndSunshineStats {
pitchDegrees: number;
azimuthDegrees: number;
stats: SizeAndSunshineStats;
center: LatLng;
boundingBox: LatLngBox;
planeHeightAtCenterMeters: number;
}
export interface SolarPanel {
center: LatLng;
orientation: 'LANDSCAPE' | 'PORTRAIT';
segmentIndex: number;
yearlyEnergyDcKwh: number;
}
export interface SolarPanelConfig {
panelsCount: number;
yearlyEnergyDcKwh: number;
roofSegmentSummaries: RoofSegmentSummary[];
}
export interface RoofSegmentSummary {
pitchDegrees: number;
azimuthDegrees: number;
panelsCount: number;
yearlyEnergyDcKwh: number;
segmentIndex: number;
}
export interface LatLng {
latitude: number;
longitude: number;
}
export interface LatLngBox {
sw: LatLng;
ne: LatLng;
}
export interface Date {
year: number;
month: number;
day: number;
}
export interface RequestError {
error: {
code: number;
message: string;
status: string;
};
}
Exemplo de objeto de resposta
Essa solicitação produz uma resposta JSON no formato:
{
"name": "buildings/ChIJh0CMPQW7j4ARLrRiVvmg6Vs",
"center": {
"latitude": 37.4449439,
"longitude": -122.13914659999998
},
"imageryDate": {
"year": 2022,
"month": 8,
"day": 14
},
"postalCode": "94303",
"administrativeArea": "CA",
"statisticalArea": "06085511100",
"regionCode": "US",
"solarPotential": {
"maxArrayPanelsCount": 1163,
"maxArrayAreaMeters2": 1903.5983,
"maxSunshineHoursPerYear": 1802,
"carbonOffsetFactorKgPerMwh": 428.9201,
"wholeRoofStats": {
"areaMeters2": 2399.3958,
"sunshineQuantiles": [
351,
1396,
1474,
1527,
1555,
1596,
1621,
1640,
1664,
1759,
1864
],
"groundAreaMeters2": 2279.71
},
"roofSegmentStats": [
{
"pitchDegrees": 11.350553,
"azimuthDegrees": 269.6291,
"stats": {
"areaMeters2": 452.00052,
"sunshineQuantiles": [
408,
1475,
1546,
1575,
1595,
1606,
1616,
1626,
1635,
1643,
1761
],
"groundAreaMeters2": 443.16
},
"center": {
"latitude": 37.444972799999995,
"longitude": -122.13936369999999
},
"boundingBox": {
"sw": {
"latitude": 37.444732099999996,
"longitude": -122.1394224
},
"ne": {
"latitude": 37.4451909,
"longitude": -122.13929279999999
}
},
"planeHeightAtCenterMeters": 10.7835045
},
/.../
],
"solarPanelConfigs": [
{
"panelsCount": 4,
"yearlyEnergyDcKwh": 1819.8662,
"roofSegmentSummaries": [
{
"pitchDegrees": 12.273684,
"azimuthDegrees": 179.12555,
"panelsCount": 4,
"yearlyEnergyDcKwh": 1819.8663,
"segmentIndex": 1
}
]
},
/.../
]
"financialAnalyses": [
{
"monthlyBill": {
"currencyCode": "USD",
"units": "20"
},
"panelConfigIndex": -1
},
{
"monthlyBill": {
"currencyCode": "USD",
"units": "25"
},
"panelConfigIndex": -1
},
{
"monthlyBill": {
"currencyCode": "USD",
"units": "30"
},
"panelConfigIndex": -1
},
{
"monthlyBill": {
"currencyCode": "USD",
"units": "35"
},
"panelConfigIndex": 0,
"financialDetails": {
"initialAcKwhPerYear": 1546.8864,
"remainingLifetimeUtilityBill": {
"currencyCode": "USD",
"units": "2563"
},
"federalIncentive": {
"currencyCode": "USD",
"units": "1483"
},
"stateIncentive": {
"currencyCode": "USD"
},
"utilityIncentive": {
"currencyCode": "USD"
},
"lifetimeSrecTotal": {
"currencyCode": "USD"
},
"costOfElectricityWithoutSolar": {
"currencyCode": "USD",
"units": "10362"
},
"netMeteringAllowed": true,
"solarPercentage": 86.7469,
"percentageExportedToGrid": 52.136684
},
"leasingSavings": {
"leasesAllowed": true,
"leasesSupported": true,
"annualLeasingCost": {
"currencyCode": "USD",
"units": "335",
"nanos": 85540771
},
"savings": {
"savingsYear1": {
"currencyCode": "USD",
"units": "-10"
},
"savingsYear20": {
"currencyCode": "USD",
"units": "1098"
},
"presentValueOfSavingsYear20": {
"currencyCode": "USD",
"units": "568",
"nanos": 380859375
},
"financiallyViable": true,
"savingsLifetime": {
"currencyCode": "USD",
"units": "1098"
},
"presentValueOfSavingsLifetime": {
"currencyCode": "USD",
"units": "568",
"nanos": 380859375
}
}
},
"cashPurchaseSavings": {
"outOfPocketCost": {
"currencyCode": "USD",
"units": "5704"
},
"upfrontCost": {
"currencyCode": "USD",
"units": "4221"
},
"rebateValue": {
"currencyCode": "USD",
"units": "1483",
"nanos": 40039063
},
"paybackYears": 11.5,
"savings": {
"savingsYear1": {
"currencyCode": "USD",
"units": "325"
},
"savingsYear20": {
"currencyCode": "USD",
"units": "7799"
},
"presentValueOfSavingsYear20": {
"currencyCode": "USD",
"units": "1083",
"nanos": 500244141
},
"financiallyViable": true,
"savingsLifetime": {
"currencyCode": "USD",
"units": "7799"
},
"presentValueOfSavingsLifetime": {
"currencyCode": "USD",
"units": "1083",
"nanos": 500244141
}
}
},
"financedPurchaseSavings": {
"annualLoanPayment": {
"currencyCode": "USD",
"units": "335",
"nanos": 85540771
},
"rebateValue": {
"currencyCode": "USD"
},
"loanInterestRate": 0.05,
"savings": {
"savingsYear1": {
"currencyCode": "USD",
"units": "-10"
},
"savingsYear20": {
"currencyCode": "USD",
"units": "1098"
},
"presentValueOfSavingsYear20": {
"currencyCode": "USD",
"units": "568",
"nanos": 380859375
},
"financiallyViable": true,
"savingsLifetime": {
"currencyCode": "USD",
"units": "1098"
},
"presentValueOfSavingsLifetime": {
"currencyCode": "USD",
"units": "568",
"nanos": 380859375
}
}
}
},
],
/.../
"panelCapacityWatts": 400,
"panelHeightMeters": 1.879,
"panelWidthMeters": 1.045,
"panelLifetimeYears": 20,
"buildingStats": {
"areaMeters2": 2533.1233,
"sunshineQuantiles": [
348,
1376,
1460,
1519,
1550,
1590,
1618,
1638,
1662,
1756,
1864
],
"groundAreaMeters2": 2356.03
},
"solarPanels": [
{
"center": {
"latitude": 37.4449659,
"longitude": -122.139089
},
"orientation": "LANDSCAPE",
"yearlyEnergyDcKwh": 455.40714,
"segmentIndex": 1
},
/.../
]
"imageryQuality": "HIGH",
"imageryProcessedDate": {
"year": 2023,
"month": 8,
"day": 4
}
}
Confira!
O API Explorer permite fazer solicitações de amostra para que você se familiarize com a API e as opções dela.
Selecione o ícone da API,
,
no lado direito da página.Edite os parâmetros de solicitação, se quiser.
Selecione o botão Executar. Na caixa de diálogo pop-up, escolha a conta que você quer usar para fazer a solicitação.
No painel do API Explorer, selecione o ícone de expansão,
, para abrir a janela do API Explorer.