Partilhar via


Notion (Editora Independente)

O conector de noção usa a API para acessar páginas, bancos de dados e usuários do Notion.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Chandra Sekhar & Harshini Varma
URL https://github.com/sekharmalla
Email chandra.malla@msftcommunity.com
Metadados do conector
Editora Chandra Sekhar & Harshini Varma
Sítio Web https://www.notion.so/
Política de privacidade https://www.notion.so/Privacy-Policy-3468d120cf614d4c9014c09f6adc9091
Categorias Produtividade; Colaboração

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave de API securestring A chave de API para esta api Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Anexar bloco filhos

Cria e acrescenta novos blocos filhos ao block_id pai especificado.

Atualizar um bloco

Atualiza o conteúdo do block_id especificado com base no tipo de bloco. Campos suportados com base no tipo de objeto de bloco

Consultar uma base de dados

Obtém uma lista de Páginas contidas no banco de dados, filtradas e ordenadas de acordo com as condições de filtro e critérios de classificação fornecidos na solicitação.

Criar comentário

Cria um comentário em uma página ou thread de discussão existente.

Criar uma página

Cria uma nova página no banco de dados especificado. página existente.

Excluir um bloco

Define um objeto Block, incluindo blocos de página, como archived: true usando a ID especificada. Nota: no aplicativo Notion UI, isso move o bloco para a "Lixeira", onde ainda pode ser acessado e restaurado.

Lista de todos os utilizadores

Retorna uma lista paginada de Usuários para o espaço de trabalho

Pesquisa

Pesquisa todas as páginas e páginas filhas que são compartilhadas com a integração. Os resultados podem incluir bases de dados.

Recuperar comentários

Recupera uma lista de objetos Comment não resolvidos de uma página ou bloco.

Recuperar crianças do bloco

Retorna uma matriz paginada de objetos de bloco filho contidos no bloco usando a ID especificada

Recuperar o usuário do bot do seu token

Recupera o usuário do bot associado ao token de API fornecido no cabeçalho de autorização. O bot terá um campo proprietário com informações sobre a pessoa que autorizou a integração.

Recuperar um banco de dados

Recupera um objeto Database usando a ID especificada.

Recuperar um bloco

Recupera um objeto Block usando a ID especificada.

Recuperar um item de propriedade de página

Recuperar um item de propriedade de página

Recuperar uma página

Recupera um objeto Page usando a ID especificada.

Recuperar usuário

Recupera um usuário usando a ID especificada.

Anexar bloco filhos

Cria e acrescenta novos blocos filhos ao block_id pai especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do bloco
block_id True string

Identificador de um bloco

objecto
object string

objecto

tipo
type string

tipo

tipo
type string

tipo

conteúdo
content string

conteúdo

tipo
type string

tipo

conteúdo
content string

conteúdo

URL
url string

URL

Atualizar um bloco

Atualiza o conteúdo do block_id especificado com base no tipo de bloco. Campos suportados com base no tipo de objeto de bloco

Parâmetros

Name Chave Necessário Tipo Description
ID do bloco
blockId True string

Identificador de um bloco Notion

Content
content string

Conteúdo do texto. Este campo contém o conteúdo real do seu texto e é provavelmente o campo que você usará com mais frequência.

Cor
color string

Cor do bloco.

Content
content string

Conteúdo do texto. Este campo contém o conteúdo real do seu texto e é provavelmente o campo que você usará com mais frequência.

Cor
color string

Cor do bloco.

Content
content string

Conteúdo do texto2. Este campo contém o conteúdo real do seu texto e é provavelmente o campo que você usará com mais frequência.

Cor
color string

Cor do bloco.

Content
content string

Conteúdo do texto. Este campo contém o conteúdo real do seu texto e é provavelmente o campo que você usará com mais frequência.

Cor
color string

cores

Índice1
content string

Conteúdo do texto. Este campo contém o conteúdo real do seu texto e é provavelmente o campo que você usará com mais frequência.

Cor
color string

Cor do bloco.

Índice1
content string

Conteúdo do texto. Este campo contém o conteúdo real do seu texto e é provavelmente o campo que você usará com mais frequência.

Cor
color string

Cor do bloco.

Índice1
content string

Conteúdo do texto. Este campo contém o conteúdo real do seu texto e é provavelmente o campo que você usará com mais frequência.

Verificado
checked boolean

Se o to_do é verificado ou não.

Cor
color string

Cor do bloco.

Consultar uma base de dados

Obtém uma lista de Páginas contidas no banco de dados, filtradas e ordenadas de acordo com as condições de filtro e critérios de classificação fornecidos na solicitação.

Parâmetros

Name Chave Necessário Tipo Description
ID da Base de Dados
database_id True string

Identificador de um banco de dados Notion .

Devoluções

Criar comentário

Cria um comentário em uma página ou thread de discussão existente.

Parâmetros

Name Chave Necessário Tipo Description
ID da página
page_id string

Identificador de uma página

ID da discussão
discussion_id string

Identificador de um bloco Notion

Content
content string

Conteúdo do texto. Este campo contém o conteúdo real do seu texto e é provavelmente o campo que você usará com mais frequência.

Devoluções

Criar uma página

Cria uma nova página no banco de dados especificado. página existente.

Parâmetros

Name Chave Necessário Tipo Description
ID da Base de Dados
database_id True string

Identificador exclusivo do banco de dados.

Emoji
emoji string

emoji

URL da capa
url string

URL da imagem de capa da página.

Propriedades
properties object

Esquema de propriedades para o banco de dados como aparecem em Notion.

Devoluções

Name Caminho Tipo Description
Id
id string

Identificador exclusivo da página.

Tempo criado
created_time string

Data e hora em que esta página foi criada. Formatado como uma cadeia de caracteres de data e hora ISO 8601.

Última edição
last_edited_time string

Data e hora em que esta página foi atualizada. Formatado como uma cadeia de caracteres de data e hora ISO 8601.

Id
created_by.id string

Identificador exclusivo para este usuário.

Id
last_edited_by.id string

Identificador exclusivo para este usuário.

URL
cover.url string

Link para a imagem hospedada externamente.

emoji
icon.emoji string

Personagem Emoji.

database_id
parent.database_id string

database_id

arquivado
archived boolean

O status arquivado da página.

URL
url string

O URL da página Noção.

Excluir um bloco

Define um objeto Block, incluindo blocos de página, como archived: true usando a ID especificada. Nota: no aplicativo Notion UI, isso move o bloco para a "Lixeira", onde ainda pode ser acessado e restaurado.

Parâmetros

Name Chave Necessário Tipo Description
ID do bloco
blockId True string

Identificador de um bloco Notion

Devoluções

Name Caminho Tipo Description
id
id string

Identificador do bloco.

Tempo criado
created_time date-time

Data e hora em que este bloco foi criado.

Última edição
last_edited_time date-time

Data e hora em que este bloco foi atualizado pela última vez.

Objeto
created_by.object string

Sempre "utilizador"

Id
created_by.id string

Identificador exclusivo para este usuário.

Objeto
last_edited_by.object string

Último utilizador editado

Id
last_edited_by.id string

Identificador exclusivo para este usuário.

Tem filhos
has_children boolean

Se o bloco tem ou não filhos blocos aninhados dentro dele.

Arquivado
archived boolean

O status arquivado do bloco.

Tipo
type string

Um objeto que contém informações de bloco específicas do tipo

Lista de todos os utilizadores

Retorna uma lista paginada de Usuários para o espaço de trabalho

Parâmetros

Name Chave Necessário Tipo Description
Tamanho da página
page_size integer

O número de itens da lista completa desejado na resposta. Máximo: 100

Devoluções

Name Caminho Tipo Description
Id
id string

Identificador de um bloco Notion

Nome de exibição
name string

Nome do usuário exibido em Notion.

Avatar URL
avatar_url string

Imagem de avatar escolhida.

Tipo
type string

Tipo de utilizador. Os valores possíveis são "pessoa" e "bot".

Email
email string

Endereço de e-mail da pessoa.

Cursor seguinte
next_cursor string

Um cursor retornado usado para solicitar a próxima página de resultados. Trate isto como um valor opaco

Tem mais
has_more boolean

Quando a resposta inclui o fim da lista

Pesquisa

Pesquisa todas as páginas e páginas filhas que são compartilhadas com a integração. Os resultados podem incluir bases de dados.

Parâmetros

Name Chave Necessário Tipo Description
Query
query True string

Quando fornecido, limita quais páginas são retornadas comparando a consulta com o título da página.

Direction
direction string

A direção para classificar. Os valores possíveis incluem ascendente e descendente.

Data e Hora
timestamp string

O nome do carimbo de data/hora contra o qual classificar. Os valores possíveis incluem last_edited_time.

Devoluções

Name Caminho Tipo Description
id
id string

Identificador do bloco.

Tempo criado
created_time string

Data e hora em que esta página foi criada.

Última edição
last_edited_time string

Data e hora em que esta página foi atualizada.

Texto simples
plain_text string

O texto simples sem anotações.

Etiquetas
Tags object

O objeto tags contém a lista de tags.

URL
url string

A URL do objeto.

Cursor seguinte
next_cursor string

Um cursor retornado usado para solicitar a próxima página de resultados. Trate isto como um valor opaco

Tem mais
has_more boolean

Se o bloco tem ou não mais blocos

Recuperar comentários

Recupera uma lista de objetos Comment não resolvidos de uma página ou bloco.

Parâmetros

Name Chave Necessário Tipo Description
ID do bloco
block_id True string

Identificador de um bloco ou página Notion

Devoluções

Recuperar crianças do bloco

Retorna uma matriz paginada de objetos de bloco filho contidos no bloco usando a ID especificada

Parâmetros

Name Chave Necessário Tipo Description
ID do bloco
block_id True string

Identificador de um bloco

Tamanho da página
page_size integer

O número de itens da lista completa desejado na resposta. Máximo: 100

Devoluções

Name Caminho Tipo Description
id
items.id string

Identificador do bloco.

Tempo criado
items.created_time date-time

Data e hora em que este bloco foi criado.

Última edição
items.last_edited_time date-time

Data e hora em que este bloco foi atualizado pela última vez.

Tem filhos
items.has_children boolean

Se o bloco tem ou não filhos blocos aninhados dentro dele.

Arquivado
items.archived boolean

O status arquivado do bloco.

Tipo
items.type string

Tipo de bloco. Valores possíveis

Texto simples
plain_text string

Texto simples no bloco de parágrafos plain_text

Cursor seguinte
next_cursor string

Um cursor retornado usado para solicitar a próxima página de resultados. Trate isto como um valor opaco

Tem mais
has_more boolean

Se o bloco tem ou não mais blocos

Recuperar o usuário do bot do seu token

Recupera o usuário do bot associado ao token de API fornecido no cabeçalho de autorização. O bot terá um campo proprietário com informações sobre a pessoa que autorizou a integração.

Devoluções

Name Caminho Tipo Description
Id
id string

Identificador exclusivo para este usuário.

Nome
name string

Nome do usuário conforme exibido em Notion.

URL do avatar
avatar_url string

Imagem de avatar escolhida.

Tipo
type string

Tipo de utilizador. Os valores possíveis são "pessoa" e "bot".

Tipo de proprietário
bot.owner.type string

O tipo de proprietário - "espaço de trabalho" ou "usuário".

Recuperar um banco de dados

Recupera um objeto Database usando a ID especificada.

Parâmetros

Name Chave Necessário Tipo Description
ID do banco de dados
database_id True string

Identificador de um banco de dados Notion

Devoluções

Recuperar um bloco

Recupera um objeto Block usando a ID especificada.

Parâmetros

Name Chave Necessário Tipo Description
ID do bloco
blockId True string

Identificador do bloco.

Devoluções

Name Caminho Tipo Description
objecto
object string

objecto

id
id string

Identificador do bloco.

Tempo criado
created_time date-time

Data e hora em que este bloco foi criado.

Última edição
last_edited_time date-time

Data e hora em que este bloco foi atualizado pela última vez.

Objeto
created_by.object string

Sempre "utilizador"

Id
created_by.id string

Identificador exclusivo para este usuário.

Objeto
last_edited_by.object string

Último utilizador editado

Id
last_edited_by.id string

Identificador exclusivo para este usuário.

Tem filhos
has_children boolean

Se o bloco tem ou não filhos blocos aninhados dentro dele.

Arquivado
archived boolean

O status arquivado do bloco.

Tipo
type string

Um objeto que contém informações de bloco específicas do tipo

Recuperar um item de propriedade de página

Recuperar um item de propriedade de página

Parâmetros

Name Chave Necessário Tipo Description
ID da página
page_id True string

Identificador de uma página Noção

ID da Propriedade
property_id True string

Identificador de uma propriedade de página

Devoluções

Name Caminho Tipo Description
Objeto
object string

Liste sempre.

Tem mais
has_more boolean

Quando a resposta incluir o final da lista, false. Caso contrário, é verdade.

Recuperar uma página

Recupera um objeto Page usando a ID especificada.

Parâmetros

Name Chave Necessário Tipo Description
ID da página
page_id True string

Identificador de uma página Noção

Devoluções

Name Caminho Tipo Description
Id
id string

Identificador exclusivo da página.

Tempo criado
created_time string

Data e hora em que esta página foi criada. Formatado como uma cadeia de caracteres de data e hora ISO 8601.

Última edição
last_edited_time string

Data e hora em que esta página foi atualizada. Formatado como uma cadeia de caracteres de data e hora ISO 8601.

Id
created_by.id string

Identificador exclusivo para este usuário.

Id
last_edited_by.id string

Identificador exclusivo para este usuário.

URL
cover.url string

Link para a imagem hospedada externamente.

emoji
icon.emoji string

Personagem Emoji.

database_id
parent.database_id string

database_id

arquivado
archived boolean

O status arquivado da página.

URL
url string

O URL da página Noção.

Recuperar usuário

Recupera um usuário usando a ID especificada.

Parâmetros

Name Chave Necessário Tipo Description
ID de utilizador
user_id True string

Identificador exclusivo para este usuário.

Devoluções

Name Caminho Tipo Description
Id
id string

Identificador para um usuário do Notion

Nome de Utilizador
name string

Nome do Utilizador

Avatar URL
avatar_url string

Imagem de avatar escolhida

Email
email string

Endereço de e-mail da pessoa.

Definições

ComentárioResposta

Name Caminho Tipo Description
Id
id string

Identificador exclusivo do comentário.

ID da página
parent.page_id string

O ID da página a que esta página pertence.

ID da discussão
discussion_id string

Identificador exclusivo do thread de discussão ao qual o comentário está associado.

Tempo criado
created_time string

Data e hora em que este comentário foi criado.

Última edição
last_edited_time string

Data e hora em que este comentário foi atualizado.

objecto
created_by.object string

objecto

id
created_by.id string

id

Texto formatado
rich_text array of object

Conteúdo do comentário, que suporta formatação rich text, links e menções.

tipo
rich_text.type string

tipo

Content
rich_text.text.content string

Conteúdo do texto.

Link
rich_text.text.link string

Qualquer link embutido neste texto.

Texto simples
rich_text.plain_text string

O texto simples sem anotações.

HREF
rich_text.href string

(facultativo) A URL de qualquer link ou noção interna mencionada neste texto, se houver.

DatabaseResponse

Name Caminho Tipo Description
results
results array of object
Objeto
results.object string

Página ou 'base de dados'

Id
results.id string

Identificador exclusivo do banco de dados.

Tempo criado
results.created_time string

Data e hora em que esta base de dados foi criada. Formatado como uma cadeia de caracteres de data e hora ISO 8601.

Última edição
results.last_edited_time string

Data e hora em que esta base de dados foi atualizada. Formatado como uma cadeia de caracteres de data e hora ISO 8601.

Objeto
results.created_by.object string

Usuário que criou o banco de dados.

Id
results.created_by.id string

Identificador exclusivo do utilizador

Objeto
results.last_edited_by.object string

Usuário que criou o banco de dados.

Id
results.last_edited_by.id string

Identificador exclusivo do utilizador

Arquivado
results.archived boolean

O status arquivado do banco de dados.

URL
results.url string

A URL do banco de dados Notion