Tipos de dados

Atualizada mais de uma semana atras

Os resultados retornados para pesquisas de tipo de data na API retornarão informações em um dos formatos descritos abaixo.

Carga útil do resultado

Atributos

A estrutura raiz da carga útil JSON de dados possui os seguintes atributos.

nome	tipo	descrição
`data`	lista de objetos de dados	Os dados recuperados da fonte.
`metadata`	objeto de metadados	Metadados relacionados aos `data` .

Metadados

Atributos

nome	tipo	descrição
`count`	int	O número de objetos nos `data` .

Arquivo

O tipo de dados do file é visto em toda a API, pois é uma referência a um arquivo que pode ser baixado da API por meio de uma pesquisa de tipo de files .

Atributos

nome	tipo	descrição
`id`	corda	Identificador usado para solicitar o arquivo da API. O valor só é garantido como único no escopo da fonte atual.
`data_type`	string, sempre `file`	Especificador de tipo de dados.
`name`	corda	O nome do arquivo, excluindo a extensão.
`extension`	string, opcional	A extensão do arquivo, se disponível.
`mime_type`	string, opcional	O tipo MIME do arquivo, se disponível.
`size`	int, opcional	O tamanho do arquivo, se disponível.
`checksum`	string, opcional	A soma de verificação md5, se disponível.

Exemplo

{
  "id": "abc123",
  "data_type": "file",
  "name": "IMG_0003",
  "extension": "jpg",
  "mime_type": "image/jpeg",
  "size": 2505426,
}

Imagem

Estende o arquivo .

nome	tipo	descrição
`filename`	corda	O nome do arquivo original do arquivo. A extensão neste nome de arquivo precisa corresponder à extensão do arquivo.
`filepath`	corda	O caminho do arquivo em relação a outros arquivos em seu serviço. Por exemplo, o caminho dentro de um backup.
`width`	int, opcional	A largura do arquivo, se disponível.
`height`	int, opcional	A altura do arquivo, se disponível.

Exemplo

{
  "id": "abc123",
  "data_type": "image",
  "filename": "IMG_0003.JPG",
  "filepath": "Media/DCIM/100APPLE/IMG_0003.JPG",
  "name": "IMG_0003",
  "extension": "jpg",
  "mime_type": "image/jpeg",
  "width": 3000,
  "height": 2002,
  "size": 2505426,
}

Vídeo

Estende o arquivo .

nome	tipo	descrição
`filename`	corda	O nome do arquivo original do arquivo. A extensão neste nome de arquivo precisa corresponder à extensão do arquivo.
`filepath`	corda	O caminho do arquivo em relação a outros arquivos em seu serviço. Por exemplo, o caminho dentro de um backup.
`width`	int, opcional	A largura do arquivo, se disponível.
`height`	int, opcional	A altura do arquivo, se disponível.
`duration`	int, opcional	A duração do vídeo, se disponível.

Exemplo

{
  "id": "abc123",
  "data_type": "video",
  "filename": "IMG_0009.MOV",
  "filepath": "Media/DCIM/100APPLE/IMG_0009.MOV",
  "name": "IMG_0009",
  "extension": "mov",
  "mime_type": "video/quicktime",
  "width": 1920,
  "height": 1080,
  "size": 5421796,
  "duration": 9.135623
}

mensagem

Atributos

nome	tipo	descrição
`id`	corda	Um identificador exclusivo para a mensagem. Use isso para desduplicar os dados retornados, se necessário.
`data_type`	string, sempre `message`	Especificador de tipo de dados.
`conversation_id`	corda	Identificador agrupando mensagens por conversa.
`handle`	corda	A segunda parte da conversa.
`type`	string, opcional	Usado quando um serviço de mensagens lida com vários tipos de mensagens. Por exemplo, `SMS` e `iMessage` no caso de mensagens do iOS.
`text`	corda	O corpo da mensagem.
`from_me`	bool	Se a mensagem foi enviada ou recebida.
`attachments`	lista de arquivos, opcional	Uma matriz de valores de `file_id` que podem ser usados com o método `download_file` . Se a mensagem não incluir nenhum anexo, será retornada uma matriz vazia.
`group_handles`	lista de strings, opcional	Esse valor é `null` para mensagens de pessoa para pessoa e, em conversas de grupo, é uma matriz de cadeias que representa números de telefone ou endereços de e-mail do iMessage.
`group`	string, opcional	O nome do grupo no momento em que a mensagem foi enviada .
`group_id`	string, opcional	O identificador exclusivo do grupo no contexto desse aplicativo. Isso pode não ser um número inteiro e, se presente, fornece apenas informações além de `conversation_id` .
`group_contacts`	string, opcional	Uma matriz de objetos que fazem referência aos contatos do iOS no grupo.
`user`	string, opcional	O usuário do aplicativo de mensagens no caso de vários usuários / contas poderem estar usando um aplicativo de mensagens do dispositivo.
`deleted`	bool, opcional	Um valor booleano para indicar se a mensagem foi excluída.
`date`	data hora	Quando a mensagem foi enviada ou recebida.
`contact`	contato aninhado, opcional	Um objeto que faz referência a um contato do iOS da segunda parte da conversa.

Exemplo

{
  "id": "a1b2c3d4",
  "data_type": "message",
  "conversation_id": "w6x7y8z9",
  "handle": "vodafone",
  "type": "SMS",
  "text": "Hi from Vodafone!",
  "attachments": [],
  "group_handles": [
    "+441234567890",
    "renate@reincubate.com"
  ],
  "from_me": false,
  "deleted": false,
  "date": "2020-01-01T00:00:00.000000Z"
}

Conversação

Uma conversa.

nome	tipo	descrição
`id`	corda	ID do item.
`data_type`	sempre `conversation`	ID do tipo de dados do item.
`group`	sequência opcional	Nome do grupo
`members`	lista de itens de `contact`	Participantes da conversa.

Contato

atributos de contact

nome	tipo	descrição
`id`	corda	ID do item.
`data_type`	string, sempre `contact`	ID do tipo de dados do item.
`name`	sequência opcional	O nome completo do contato.
`first_name`	sequência opcional	O primeiro nome do contato.
`middle_name`	sequência opcional	O nome do meio do contato.
`last_name`	sequência opcional	O sobrenome do contato.
`prefix`	sequência opcional	O prefixo do nome do contato.
`suffix`	sequência opcional	O sufixo do nome do contato.
`nickname`	sequência opcional	O apelido do contato.
`records`	lista de itens `contact.record`	Registros de contato associados ao contato.
`organisation`	sequência opcional	O nome da organização do contato.
`department`	sequência opcional	O departamento do contato dentro da organização.
`jobtitle`	sequência opcional	O cargo do contato na organização.
`birthday`	data opcional	O aniversário do contato.

atributo contact.record

Existem 5 tipos de itens de registro de contato: Phone , Email , URL , Social e Address . Eles correspondem a um número de telefone, endereço de email, URL do site, identificador de conta de mídia social e endereço, respectivamente.

Os quatro primeiros têm os mesmos atributos:

nome	tipo	descrição
`type`	corda	Um dos: `Phone` , `Email` , `URL` , `Social` .
`name`	sequência opcional	O rótulo associado ao registro.
`value`	corda	O valor do registro.

O tipo de registro de contato do Address possui campos de endereço adicionais:

nome	tipo	descrição
`type`	string, sempre `Address`	Um registro de número de telefone.
`name`	sequência opcional	O rótulo associado ao número.
`CountryCode`	sequência opcional	Um código de país.
`Country`	sequência opcional	Um nome de país.
`ZIP`	sequência opcional	Um CEP ou código postal.
`State`	sequência opcional	Um nome ou abreviação de estado.
`City`	sequência opcional	Um nome de cidade.
`Municipality`	sequência opcional	Um nome de município.
`SubLocality`	sequência opcional	Um nome de bairro ou área.
`Street`	sequência opcional	Um nome de endereço.

Dados de amostra

{
  "id": "2cf6a837304d6614",
  "data_type": "contact",
  "first_name": "John",
  "middle_name": "'Gala'",
  "last_name": "Appleseed",
  "prefix": "Mr.",
  "suffix": "Jr.",
  "nickname": "John'o",
  "records": [
    {
      "type": "Phone",
      "name": "MAIN",
      "value": "1-800-MY-APPLE"
    },
    {
      "type": "Phone",
      "name": "UK",
      "value": "0800 039 1010"
    },
    {
      "type": "URL",
      "name": "HOMEPAGE",
      "value": "http://www.apple.com"
    },
    {
      "type": "URL",
      "name": "HOMEPAGE",
      "value": "http://www.apple.com/uk/"
    },
    {
      "City": "Cupertino",
      "State": "CA",
      "ZIP": "95014",
      "name": "WORK",
      "CountryCode": "US",
      "Country": "United States",
      "Street": "1 Infinite Loop",
      "type": "Address",
      "SubLocality": null,
      "Municipality": null
    }
  ],
  "organisation": "Apple Inc.",
  "department": "Marketing",
  "jobtitle": "VP Juicing",
  "birthday": "1976-04-01"
}

Ligar

Atributos

nome	tipo	descrição
`id`	corda	ID do item.
`data_type`	string, sempre `call`	ID do tipo de dados do item.
`call_type`	corda	Um dos: `Phone` , `FaceTime Video` `FaceTime Audio` , `FaceTime Audio` .
`address`	corda	O alvo da chamada. Pode ser um número de telefone, ID da Apple ou outro identificador.
`duration`	flutuador	A duração da chamada.
`answered`	bool	Se a chamada foi atendida.
`from_me`	bool	Se a chamada foi efetuada ou recebida.
`date`	data hora	Quando a ligação foi feita.

Dados de amostra

{
  "id": "24116c5b16b85217",
  "data_type": "call",
  "call_type": "Phone",
  "address": "07123456789",
  "duration": 5.131359,
  "answered": false,
  "from_me": true,
  "date": "2015-07-20 10:23:27.538011"
}

Evento

atributos de event

nome	tipo	descrição
`id`	corda	ID do item.
`data_type`	string, sempre `event`	ID do tipo de dados do item.
`unique_identifier`	sequência opcional	UID do item para desduplicar em várias fontes de dados de eventos.
`calendar`	sequência opcional	Nome do calendário.
`calendar_uid`	sequência opcional	UID do calendário.
`calendar_store`	sequência opcional	Tipo de armazenamento de calendário, ou seja, `iCloud` , `Default` .
`summary`	sequência opcional	O resumo ou título do evento.
`description`	sequência opcional	A descrição do evento.
`start_date`	data e hora opcional	Quando o evento começa.
`end_date`	data e hora opcional	Quando o evento terminar.
`start_time_zone`	sequência opcional	O fuso horário de `start_date` .
`end_time_zone`	sequência opcional	O timeone de `end_date` .
`all_day`	boleano	Se o evento dura um dia inteiro.
`travel_time`	duração opcional	A duração do tempo de viagem do evento.
`recurrence`	`event.recurrence` aninhado opcional	As configurações de recorrência do evento.
`location`	sequência opcional	Onde o evento está ocorrendo.
`start_location`	sequência opcional	De onde o evento está começando.
`attendees`	lista opcional de strings	Nomes dos participantes do evento.
`attached_url`	sequência opcional	Um URL associado ao evento.
`creation_date`	data e hora opcional	Quando o evento foi criado. Não definido se a entrada de calendário padrão, como feriados.

Atributos event.recurrence

nome	tipo	descrição
`interval`	inteiro	A contagem de `repeat` para `repeat` às, ie 1 ano (uma vez a cada 1 ano).
`repeat`	corda	Um dos: `OneTime` , `Daily` , `Weekly` , `Monthly` , `Yearly` .
`repeat_end_date`	data e hora opcional	Quando parar de recorrente.

Dados de amostra

{
  "id": "3",
  "unique_identifier": "f5fcf872-34f6-3f60-ba03-74d5a7a3bbbb",
  "calendar": "Home",
  "calendar_id": "477a2001537fe178d6b77cdceb8bac2e",
  "calendar_store": "Default",
  "summary": "Christmas Day",
  "description": "Bank holiday in the UK",
  "start_date": "2017-12-25T00:00:00.000000",
  "end_date": "2017-12-25T23:59:59.000000",
  "start_time_zone": None,
  "end_time_zone": None,
  "all_day": True,
  "travel_time": None,
  "recurrence": {
    "interval": 1,
    "repeat": "Yearly",
    "repeat_end_date": None,
    "specifier": ""
  },
  "location": None,
  "start_location": None,
  "attendees": ["John Appleseed"],
  "attached_url": None,
  "creation_date": None
}

Nota

{
  "title": "Monday meeting:",
  "note": "Monday meeting:\n Discuss X,\n discuss Y.",
  "summary": null,
  "folder": "icloud",
  "sub_folder": "work",
  "attachments": [
    {
      "type": "image",
      "file_id": "8e22cf6e524357b4eb3da775d193072ebba9543f",
      "file_path": "Media/80DDDEAD-B33F-37B2-7219432C0359/Image.jpeg"
    }
  ],
  "creation_date": "2016-06-06 13:23:20.000000",
  "last_modified": "2016-06-07 15:21:25.000000"
}

Visita

Um registro de uma visita à página do site.

Atributos

nome	tipo	descrição
`data_type`	string, sempre `visit`	ID do tipo de dados do item.
`url`	corda	O URL da página visitada.
`title`	corda	O título da página visitada.
`date_created`	data hora	Quando a visita ocorreu.

{
  "data_type": "visit",
  "url": "https://reincubate.com/",
  "title": "Reincubate: the app data company",
  "date_created": "2020-01-01T00:00:00.000000Z"
}

'name': self.name, 'creation_date': creation_date, 'expiry_date': expiry_date, 'domain': self.domain, 'flags': self.flags, 'path': self.path, 'value': self. valor,

Bolacha

Um cookie HTTP.

Atributos

nome	tipo	descrição
`data_type`	string, sempre `cookie`	ID do tipo de dados do item.
`name`	corda	O nome do cookie.
`value`	corda	O valor do cookie.
`domain`	corda	O especificador de domínio do cookie.
`path`	corda	O especificador de caminho do cookie.
`flags`	corda	Qualquer sinalizador definido no cookie.
`creation_date`	data hora	Quando o cookie foi criado.
`expiry_date`	data hora	Quando o cookie expirar.

{
  "data_type": "cookie",
  "name": "sample_cookies",
  "value": "sample_value",
  "domain": "reincubate.com",
  "path": "/",
  "flags": "",
  "creation_date": "2020-01-01T00:00:00.000000Z",
  "expiry_date": "2020-01-01T00:00:00.000000Z"
}

Localização

Atributos de dados

nome	tipo	descrição
`data_type`	string, sempre `location`	Um identificador de tipo de dados.
`latitude`	flutuador	A coordenada de latitude do local.
`longitude`	flutuador	A coordenada de longitude do local.
`altitude`	flutuador	A coordenada de altitude do local.
`horizontal_accuracy`	flutuador	A precisão horizontal para a medição.
`vertical_accuracy`	flutuador	A precisão vertical para a medição.
`position_type`	corda	Identificador para o método de medição usado.
`date_created`	data hora	Quando a medição foi feita.

Dados de amostra

{
  "data_type": "location",
  "latitude": 51.507452392689146,
  "longitude": -0.07398372304584414,
  "altitude": 0.0,
  "horizontal_accuracy": 65.0,
  "vertical_accuracy": 0.0,
  "positioning_type": "Wifi",
  "date_created": "2020-01-01T00:00:00.000000Z"
}

Carga útil do resultado

Metadados

Arquivo

Imagem

Vídeo

mensagem

Conversação

Contato

Ligar

Evento

Nota

Visita

Bolacha

Localização

Como podemos ajudar?