Temos o prazer de anunciar que a API Looker 4.0 está disponível no Looker 22.4. A API 4.0 (GA 4.0 GA) com disponibilidade geral tem várias alterações interruptivas e aditivas e promove vários endpoints da versão Beta para a Stable. As APIs 3.1 e 3.0 não são afetadas. Confira nossa referência da API para ver especificações detalhadas da API 4.0. Atualizamos nossos SDKs compatíveis com o Looker e a comunidade para que sejam compatíveis com os endpoints de disponibilidade geral da API Looker 4.0. Para mais informações, confira as políticas de suporte de SDK e API e como versão das APIs. O restante deste artigo descreve as alterações interruptivas, as mitigações e os recursos que você pode esperar ao migrar para a API do Google Analytics 4.0.
Quem deve ler isto?
Este documento é útil se você usa a API Looker por meio de SDKs compatíveis com o Looker, SDKs com suporte da comunidade ou a própria API. Leia a seção a seguir que mapeia para a versão da API Looker que você usa atualmente.
Usuários da API pré-GA 4.0
Se você usa a API 4.0, leia esta seção. Ele aborda as mudanças interruptivas e as mitigações disponíveis ao migrar para a API 4.0 GA no Looker 22.4.
A API 4.0 inclui a alteração de todos os campos de ID de entidade do tipo numérico integer
para string
. Por exemplo, GET /groups/{group_id}
endpoint retorna id
como tipo string
em vez de int64
.
Leia a tabela a seguir para ver o impacto e as mitigações específicas do uso de endpoints da API 4.0:
Uso | Possível impacto1 | Prevenção |
Apps Looker para dispositivos móveis | Instalações desatualizadas de apps para dispositivos móveis do Looker deixam de funcionar | Pedir para os usuários atualizarem a versão mais recente dos apps para dispositivos móveis do Looker |
SDKs compatíveis com o Looker2 SDKs | ||
SDK do TypeScript (API 4.0) | Sem impacto | Nenhuma ação é necessária |
SDK do Python (API 4.0) | Sem impacto | Nenhuma ação é necessária |
SDK do Ruby (API 4.0) | Sem impacto | Nenhuma ação é necessária |
2SDKs com suporte da comunidade | ||
SDK do Swift | Exceções de ambiente de execução | Atualize o SDK para a v22.0 e, em seguida, resolva os erros de tipo resultantes, se houver |
SDK do Kotlin (link em inglês) | Sem impacto | Nenhuma ação é necessária |
SDK do Looker | Sem impacto | Nenhuma ação é necessária |
SDK do C# | Sem impacto | Nenhuma ação é necessária |
SDK para Go | Exceções de ambiente de execução | Atualize o SDK para a v22.0 e, em seguida, resolva os erros de tipo resultantes, se houver |
Outro | ||
Usar a API 4.0 sem um SDK (ou com bibliotecas externas) | Possíveis erros de tempo de execução, dependendo da confidencialidade do tipo de linguagem | Revise o código das dependências no tipo de qualquer campo de ID e adicione suporte para campos de ID do tipo string. Leia também esta orientação adicional. |
1: pressupomos padrões de uso comuns que possam incluir o uso dos campos de ID do Looker, mas não padrões de uso incomuns, como a aplicação de operações numéricas a IDs.
2: Suporte à API Looker e ao SDK. O Looker não oferece suporte oficial a bibliotecas com suporte da comunidade.
Usuários da API 3.1
Se você usa a API 3.1, leia esta seção. Ela aborda os recursos e alterações adicionais que a API 4.0 disponibiliza. Todos os SDKs compatíveis com o Looker e a comunidade são compatíveis principalmente com a API 4.0. Confira nossas políticas de suporte de SDK e API para mais informações.
Recursos adicionais da API 4.0
Para facilitar, listamos as mudanças mais importantes e úteis na API 4.0 para você:
- Criação e gerenciamento de seções, painéis e itens de placa. A documentação do conselho está aqui.
- Consulte informações de conexão adicionais, como bancos de dados, esquemas, colunas e tabelas. Defina e atualize campos de conexão adicionais.
- Criação e gerenciamento de apps OAuth e usuários. A documentação do OAuth está aqui.
- Grupos de pesquisa com hierarquia e funções.
- Pesquise funções com a contagem de usuários.
- Receba e defina as configurações da instância do Looker. A documentação das configurações está aqui.
- Criação e gerenciamento de alertas. A documentação do alerta está aqui.
- Criação, gerenciamento e teste de túneis e servidores SSH A documentação do SSH está aqui.
- Mover e copiar painéis.
- Receber URLs relativos para novos painéis.
- Mover e copiar aparências.
- SSO e outros recursos de incorporação de SSO, URL e criação e gerenciamento de usuários.
- Receber token de atualização para atualizar o token de acesso de login.
- Limite e desvie os resultados do recebimento de todos os modelos LookML e todos os usuários.
- Limite e desvie os resultados da pesquisa de usuários.
- Receba as especificações da API da instância do Looker no Swagger 2.x JSON.
Alterações de suspensão de uso do GA 4.0 na API
A API 4.0 GA substitui vários endpoints da API 3.1 obsoletos por recursos aprimorados. Veja abaixo os endpoints afetados:
- Os endpoints da página inicial obsoletos foram removidos. Use endpoints de placa em vez de páginas iniciais. A documentação do recurso do Board está aqui.
- Os endpoints obsoletos do espaço foram removidos. Use os endpoints de pasta em vez de espaço. A documentação do recurso de pasta está aqui.
Usuários da API 3.0
Se você usa a API 3.0, leia esta seção. Lembre-se de que a API 3.0 é considerada legada e obsoleta. Portanto, não recomendamos usá-la. Recomendamos que você migre para a API 4.0.
- Somente a API 4.0 é compatível com todos os SDKs compatíveis com o Looker e a comunidade para facilitar o desenvolvimento. Confira nosso repositório do SDK.
- A API 4.0 apresenta vários novos recursos e aprimoramentos, conforme listado acima.
Encerramento
Você pode esperar novos recursos e alterações adicionais à API 4.0 e sempre encontrar as alterações mais recentes em nossa referência da API. Para mais informações, leia nossas políticas de suporte de SDK e API e como versões das nossas APIs. Sabemos que alterações interruptivas não são ideais. A menos que surja um problema extremo, não faremos alterações interruptivas em nossa API de disponibilidade geral 4.0. Esperamos que nossa API Looker 4.0 com disponibilidade geral ajude você a desenvolver de forma mais produtiva e fácil na plataforma Looker.