Listing
Listing
Listing ID
O elemento ListingID
é utilizado como um código de identificação para o corretor/imobiliária encontrar com maior precisão seus anúncios em nosso sistema Canal Pro na aba de relatórios. Também é utilizado para identificação de seus anúncios dentro dos nossos portais.
Exemplo
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<ListingID>29080</ListingID>
</Listing>
</Listings>
</ListingDataFeed>
Importante
O elemento
ListingID
deve conter entre 1 e 50 caracteres.O elemento
ListingID
deve ser único.ListingID
duplicados, somente umListingID
será processado.
Title
O título do anúncio deverá ser enviado no elemento Title
, como a chamada principal para o anúncio, ele é exibido logo acima da descrição. Para este elemento são esperados entre 10 e 100 caracteres em todos os imóveis e não deve conter tags HTML
.
Exemplo
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<Title><![CDATA[Lindo Apartamento a venda em São Paulo]]></Title>
</Listing>
</Listings>
</ListingDataFeed>
Importante
A fim de evitarmos erros na importação pelo envio de caracteres especiais no elemento, o ideal é que o conteúdo seja envolvido em uma seção CDATA.
Transaction Type
Atualmente estão disponíveis três tipos de transações para a divulgação dos imóveis:
- Venda
- Aluguel
- Venda/Aluguel
Para informar o tipo de transação deverá ser utilizado o elemento TransactionType
.
Valores a serem enviados no elemento TransactionType
Valor no elemento | Tradução |
---|---|
For Sale | Venda |
For Rent | Aluguel |
Sale/Rent | Venda e Aluguel |
Exemplo Venda:
- Se TransactionType, For Sale (Venda) informar somente ListPrice.
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<TransactionType>For Sale</TransactionType>
</Listing>
</Listings>
</ListingDataFeed>
Exemplo Aluguel:
- Se TransactionType, For Rent (Aluguel) informar somente RentalPrice.
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<TransactionType>For Rent</TransactionType>
</Listing>
</Listings>
</ListingDataFeed>
Exemplo Venda e Aluguel:
- Se TransactionType, Sale/Rent (Venda e Aluguel) informar ListPrice e RentalPrice.
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<TransactionType>Sale/Rent</TransactionType>
</Listing>
</Listings>
</ListingDataFeed>
Importante
Caso o imóvel esteja disponível para locação diária, ou outro período que não seja o padrão mensal, deverá informar For Rent em TransactionType, e o período é informado no valor de transação.
Location
Temos três opções para divulgação de endereço
Divulgação do endereço completo (Logradouro e Número);
Divulgação somente do nome do Logradouro;
Divulgação somente do bairro;
Independente da escolha do cliente, o ideal é que o endereço completo seja sempre enviado. A informação completa é fundamental para que o imóvel fique bem posicionado nas pesquisas, e também disponível nas buscas realizadas por mapa.
Abaixo serão listadas as regras para a divulgação do endereço. Note que o único item que sofre alteração é o atributo displayAddress, que será configurado como: Neighborhood, Street ou All.
Caso o cliente opte por divulgar o endereço completo dos imóveis, o atributo displayAddress, deverá ser configurado como "All".
Importante
- O elemento PostalCode é obrigatório em todos os anúncios enviados.
- Para cidades com CEP único é obrigatório o envio do elemento State.
- Em breve, a informação de número e complemento do imóvel se tornarão obrigatórios para alguns tipos de imóveis.
Exemplo displayAddress="All"
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<Location displayAddress="All">
<Country abbreviation="BR">Brasil</Country>
<State abbreviation="SP">Sao Paulo</State>
<City>São Paulo</City>
<Zone>Zona Sul</Zone>
<Neighborhood>Consolação</Neighborhood>
<Address>Rua Bela Cintra</Address>
<StreetNumber>539</StreetNumber>
<Complement>APT 12</Complement>
<PostalCode>01415-003</PostalCode>
<Latitude>-23.5531131</Latitude>
<Longitude>-46.659864</Longitude>
</Location>
</Listing>
</Listings>
</ListingDataFeed>
Caso o cliente opte por divulgar as informações de endereço até o nome do logradouro, sem a exibição do numero, o atributo displayAddress, deverá ser configurado como "Street".
Exemplo displayAddress="Street"
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<Location displayAddress="Street">
<Country abbreviation="BR">Brasil</Country>
<State abbreviation="SP">Sao Paulo</State>
<City>São Paulo</City>
<Zone>Zona Sul</Zone>
<Neighborhood>Consolação</Neighborhood>
<Address>Rua Bela Cintra</Address>
<StreetNumber>539</StreetNumber>
<Complement>APT 12</Complement>
<PostalCode>01415-003</PostalCode>
<Latitude>-23.5531131</Latitude>
<Longitude>-46.659864</Longitude>
</Location>
</Listing>
</Listings>
</ListingDataFeed>
Caso o cliente opte por divulgar as informações de endereço somente a nível de bairro, o atributo displayAddress, deverá ser setado como "Neighborhood".
Exemplo displayAddress="Neighborhood"
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<Location displayAddress="Neighborhood">
<Country abbreviation="BR">Brasil</Country>
<State abbreviation="SP">Sao Paulo</State>
<City>São Paulo</City>
<Zone>Zona Sul</Zone>
<Neighborhood>Consolação</Neighborhood>
<Address>Rua Bela Cintra</Address>
<StreetNumber>539</StreetNumber>
<Complement>APT 12</Complement>
<PostalCode>01415-003</PostalCode>
<Latitude>-23.5531131</Latitude>
<Longitude>-46.659864</Longitude>
</Location>
</Listing>
</Listings>
</ListingDataFeed>
Atenção
O formato mínimo deverá ser informado em todos os imóveis, fazem parte os elementos: Location, Country, State, City e Neighborhood. Sem elas ocorrerão erros de processamento do arquivo XML.
Exemplo do formato mínimo
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<Location displayAddress="Neighborhood">
<Country abbreviation="BR">Brasil</Country>
<State abbreviation="SP">Sao Paulo</State>
<City>São Paulo</City>
<Neighborhood>Itaquera</Neighborhood>
</Location>
</Listing>
</Listings>
</ListingDataFeed>
Elemento Zone
Se você trabalha com imóveis em cidades que existe divisão por zona(Zona Sul, Zona Norte, Zona Leste, Zona Oeste, etc.).
Em alguns casos, existem mais de um bairro com o mesmo nome, para essa situação, o elemento Zone ajuda na identificação do endereço exato.
Recomendamos que seja inserido o elemento Zone em Location para discriminar esse bairro.
Por exemplo o bairro, Vila Califórnia, em São Paulo, temos na Zona Sul e Zona Leste.
Exemplo
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<Location displayAddress="Neighborhood">
<Country abbreviation="BR">Brasil</Country>
<State abbreviation="SP">São Paulo</State>
<City>São Paulo</City>
<Zone>Zona Sul</Zone>
<Neighborhood>Vila Califória</Neighborhood>
</Location>
</Listing>
</Listings>
</ListingDataFeed>
Dessa forma a integração irá considerar corretamente o bairro e o imóvel estará disponível para visualização.
Erros de codificação podem ocorrer
<State abbreviation="SP">EspÃrito Santo</State>
<City>Vitória</City>
Para contornar esse tipo de erro, informe com todos os acentos, e envolva o conteúdo dos elementos em CDATA
<State abbreviation="SP"><![CDATA[Espírito Santo]]></State>
<City><![CDATA[Vitória]]></City>
Localização Distrito Federal
O Grupo OLX criou uma regra para conseguir reconhecer uma cidade satélite - solicitação realizada por nossos anunciantes de Brasília.
Todo o conteúdo cadastrado nos correios no campo "Bairro/Distrito" que estiver envolvido em parênteses será reconhecido no Grupo OLX como uma cidade.
Exemplo
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<Location displayAddress="All">
<Country abbreviation="BR">Brasil</Country>
<State abbreviation="DF">Brasília</State>
<City>Águas Claras</City>
<Neighborhood>Sul</Neighborhood>
<Address>Q. 207</Address>
<StreetNumber>6</StreetNumber>
<PostalCode>71926-250</PostalCode>
<Latitude>-15.844255</Latitude>
<Longitude>-48.025930</Longitude>
</Location>
</Listing>
</Listings>
</ListingDataFeed>
Complemento (Endereço)
O complemento é o campo que indica a localização exata do imóvel.
Para alguns tipos de imóveis, é recomendável informar o complemento. São eles:
- Apartamento
- Flat
- Cobertura
- Kitnet
- Loft
- Casa de condomínio
Informe o número/letra do imóvel em um condomínio ou vila. Ex: apto 22, bl A.
Essa informação não vai aparecer nos portais
Media
Dentro do elemento Media
devem ser enviadas algumas informações de imagens e vídeo dos imóveis.
Regras para envio da informação
- O elemento
<Media>
é obrigatório e exige o envio dos elementos filhos; - O elemento
<Item>
precisa estar sempre dentro de<Media>
; - O atributo medium é obrigatório para especificar o tipo de arquivo(Foto ou Vídeo);
- Para incluir as fotos deverá informar medium="image";
- Para incluir o vídeo deverá informar medium="video";
- primary="true" é utilizado para informar a foto de destaque do imóvel, as demais serão exibidas na mesma ordem que forem enviadas no xml;
- O tamanho máximo de uma imagem deve ser de 7Mb;
- Serão importados somente imagens no formato jpg;
- Todos os anúncios devem conter no mínimo 1 imagem;
- Somente uma imagem deverá ser enviada como destaque;
Atenção
- Somente serão processados os vídeos armazenados no Youtube;
- Somente será recebido um vídeo por imóvel;
Na primeira vez que o link da imagem é enviado no xml ele é guardado em nossa base e usado como identificador desta imagem. Nossos servidores fazem o download das fotos para nossa base e um tratamento para adequação conforme nossos padrões. Adotamos este padrão para evitarmos um novo download sempre que o arquivo fosse baixado pelo Grupo OLX. Por isto, sempre que alguma imagem for alterada, o link também deverá ser alterado.
Imagens fora destes padrões não serão importadas
Exemplo de envio de dados
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<Media>
<Item medium="video">https://www.youtube.com/watch?v=MukVADdjQD8</Item>
<Item medium="image" caption="img1" primary="true">http://grupozap.com.br/foto01.jpg</Item>
<Item medium="image" caption="img2">http://grupozap.com.br/foto02.jpg</Item>
<Item medium="image" caption="img3">http://grupozap.com.br/foto03.jpg</Item>
<Item medium="image" caption="img4">http://grupozap.com.br/foto04.jpg</Item>
<Item medium="image" caption="img5">http://grupozap.com.br/foto05.jpg</Item>
</Media>
</Listing>
</Listings>
</ListingDataFeed>
Contact Info
O elemento ContactInfo
é responsável por conter os dados de contato da imobiliária. Este elemento deve ser informado no mesmo nível do elemento Listing
.
ContactInfo
Elemento | Mandatório | Tipo | Descrição |
---|---|---|---|
Name | x | string | Nome da imobiliária |
Email | x | string | E-mail da imobiliária |
Website | string | URL do website da imobiliária | |
Logo | string | URL da imagem com o logo da imobiliária | |
OfficeName | string | ? | |
Telephone | string | Telefone | |
Location | Elemento | verifique estrutura abaixo |
Location
Elemento | Mandatório | Tipo | Descrição | Atributos |
---|---|---|---|---|
Country | string | País | abbreviation="BR" | |
State | string | Estado | abbreviation="SP" , onde SP deve ser a sigla do estado | |
City | string | Cidade | ||
Neighborhood | string | Bairro | ||
Address | string | Logradouro | ||
PostalCode | string | CEP - Código postal |
Importante
Não existindo as informações mínimas de contato ocorrerão erros de importação.
Exemplos
Exemplo do elemento ContactInfo
com dados mandatórios (mínimo):
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<ContactInfo>
<Name>Imobiliaria Feliz</Name>
<Email>contato@imobiliariafeliz.com.br</Email>
</ContactInfo>
</Listing>
</Listings>
</ListingDataFeed>
Exemplo do elemento ContactInfo
preenchido com todos os dados:
<ContactInfo>
<Name>Imobiliaria Feliz</Name>
<Email>contato@imobiliariafeliz.com.br</Email>
<Website>http://www.imobiliariafeliz.com.br</Website>
<Logo>http://www.imobiliariafeliz.com.br/logo.jpg</Logo>
<OfficeName>Imobiliária Feliz - Agencia Principal</OfficeName>
<Telephone>(11) 3150-4646</Telephone>
<Location>
<Country abbreviation="BR">Brasil</Country>
<State abbreviation="SP">Sao Paulo</State>
<City>São Paulo</City>
<Neighborhood>Alto da Mooca</Neighborhood>
<Address>Rua Joá, 1890</Address>
<PostalCode>03178-200</PostalCode>
</Location>
</ContactInfo>
Publication Type
Para informar o tipo de publicação (destaques) deverá ser utilizado o elemento PublicationType
.
Valores a serem enviados no elemento PublicationType
Valor no elemento | Tradução |
---|---|
STANDARD | Padrão |
PREMIUM | Destaque |
SUPER_PREMIUM | Super destaque |
PREMIERE_1 | Destaque Premium* |
PREMIERE_2 | Destaque Especial* |
TRIPLE | Destaque Triplo* |
IMPORTANTE: Para que funcione corretamente o envio de ofertas como Destaque, Super Destaque ou dos planos Premieres certifique-se que:
- As ofertas estejam sendo enviadas conforme o plano (destaques, super destaques ou premieres) respeitando a grade contratada;
- As ofertas não estejam com erros no Relatório de Integração;
- *
Destaques Especial/Premium
estão disponíveis apenas para os contratosZap+
.
Exemplo
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<PublicationType>STANDARD</PublicationType>
</Listing>
</Listings>
</ListingDataFeed>
Virtual Tour
Você pode informar o link para Virtual Tour
utilizando a tag VirtualTourLink
.
IMPORTANTE: Para inserir o link de tour virtual no anúncio certifique-se que:
- a página contenha apenas o conteúdo do tour virtual;
- a página não seja um link encurtado;
- a página esteja em um ambiente seguro (https) e com certificado válido;
Exemplo
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
<VirtualTourLink>
https://www.grupozap.com/virtualtourlinkexample
</VirtualTourLink>
</Listing>
</Listings>
</ListingDataFeed>
Incorporadoras e Lançamentos
Para os anúncios de lançamento as plantas podem ser informadas na tag Units
utilizando a tag Listing
para cada unidade.
IMPORTANTE: Para os lançamentos:
- os
ConstructionStatus
eDevelopmentLevel
devem ser informados; - enviar o valor
true
no atributoshowPrice
da tagListPrice
para exibir o preço do imóvel; - para as unidades (plantas) somente a primeira imagem será processada;
Exemplo
<?xml version="1.0" encoding="UTF-8"?>
<ListingDataFeed xmlns="http://www.vivareal.com/schemas/1.0/VRSync"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vivareal.com/schemas/1.0/VRSync http://xml.vivareal.com/vrsync.xsd">
<Listings>
<Listing>
....
<Units>
<Listing>
</Listing>
<Listing>
</Listing>
....
</Units>
</Listing>
</Listings>
</ListingDataFeed>
ConstructionStatus
Para informar o status da construção deverá ser utilizado o elemento ConstructionStatus
.
DevelopmentLevel
A tag Development Level
deve conter o mesmo valor que o elemento ConstructionStatus
.
Valores a serem enviados no elemento ConstructionStatus e DevelopmentLevel
Valor no elemento | Tradução |
---|---|
BUILT | Prontos para morar |
PLAN_ONLY | Na planta |
UNDER_CONSTRUCTION | Em construção |