recsForPlacements

Itens já adicionados ao registo. Um único ID de produto (ou lista de IDs). Se existir mais do que um produto no registo, separe os IDs utilizando o carácter pipe '|'.

Exemplo: aari=33306|909119|305466

Chave única específica de cada implementação da API. Identifica a aplicação ou cliente para efeitos de reporting, permissões e merchandising. Fornecida pelo Algonomy.

Exemplo: apiClientKey=b0126f995ac848159d

Chave única que identifica o site. Cada cliente Algonomy possui uma API key exclusiva para separar dados e tráfego de outros clientes. Fornecida pelo Algonomy.

Exemplo: apiKey=4faeaf752ee40a0f

ID de add to cart. Pode ser um único ID de produto ou uma lista. Se for adicionado mais do que um produto ao carrinho, separe os IDs com o carácter pipe "|".

Exemplo: atcid=uv2345|xt1234

Limita a informação de atributos devolvida no resultado à lista especificada.

attributeList aceita uma lista de nomes de atributos separados por vírgula.

Se estiver vazio ou for utilizado o carácter wildcard '*', devolve todos os atributos do produto.

Exemplo:

Se "attributeList=gender,color", devolve apenas os atributos gender e color.

"attributeList=*" Devolve todos os atributos.

"attributeList=" Devolve todos os atributos.

Note: Se returnMinimalRecItemData estiver definido como true e attributeList também for especificado, a resposta inclui igualmente os atributos indicados.

Lista de IDs de produto que não devem ser recomendados nesta resposta. Utilize o carácter pipe "|" para separar os IDs.

Exemplo: bi=93874|04495|043945

Omite dados de categoria (categoryIds e categories) quando definido como false. O valor predefinido é true.

Exemplo: categoryData=false

Note: excludeAncestor=false pode ser utilizado para incluir dados de categorias ancestrais.

ID da categoria que o comerciante pretende consultar. Deve corresponder ao ID externo fornecido ao Algonomy.

Exemplo: categoryId=902312

Fornece category hint IDs. Os category hints podem ser adicionados a qualquer tipo de página e qualificam a página para regras de merchandising associadas à categoria. É possível adicionar múltiplos hints a uma única página. Separe os IDs com o carácter “|”.

Exemplo com 2 hints: chi=1913000|1903094

Número total de produtos a devolver na resposta. Este valor substitui o número definido no placement ou na configuração de Search and Browse. Valor máximo: 1000.

Exemplo: count=30

Nota: Apenas para Search and Browse. Ao utilizar paginação, este parâmetro deve ser usado em conjunto com st.

Parâmetro de click-through. Permite adicionar parâmetros ao URL de clique. Consulte Click-through Parameters para mais informações.

Exemplo: ctp=|0:origin=CJ|1:campaign=rr

Click-through server. Altera parte do URL de clique quando o shopper clica numa recomendação, definindo o servidor de destino.

Exemplo: cts=http://test.buystuff.com

Note: Se fornecido no pedido, substitui a configuração de site ou o valor enviado no feed.

Código ISO da moeda para cada transação ou pedido de produto.

Exemplo: currency=USD

Note: Se não especificado, o valor predefinido é USD.

Valor do carrinho. Utilizado em campanhas segmentadas por valor. Expresso em cêntimos.

Exemplo: cv=9550 (equivale a 95,50)

True/False. Quando definido como false, a resposta inclui dados de categorias ancestrais no array ancestorCategories dentro do objeto "categories".

Nota: Deve ser utilizado em conjunto com o parâmetro categoryData.

Exemplo: excludeAncestor=false

Exemplo de resposta JSON:

"categories": [
  {
    "hasChildren": false,
    "name": "Solder",
    "childCategories": [],
    "ancestorCategories": [
      {
        "hasChildren": true,
        "name": "Metals",
        "childCategories": [],
        "ancestorCategories": [],
        "id": "4",
        "isActive": false
      }
    ],
    "id": "1572",
    "isActive": false
  }
],

True/false. Se definido como true, omite o HTML devolvido na resposta do servidor Algonomy. Se false, a resposta inclui o HTML do placement definido no campo html do layout. O valor predefinido é false.

Exemplo: excludeHtml=true

True/false. Se definido como true, remove os atributos do item dos dados dos produtos recomendados. O valor predefinido é false.

Exemplo: excludeItemAttributes=true

True/false. Se definido como true, remove completamente a estrutura de itens recomendados. É útil quando o HTML é suficiente na resposta. O valor predefinido é false.

Exemplo: excludeRecItems=true

Force Display Mode. True/false. Se definido como true, força a exibição. Por exemplo, em modo listen, devolve produtos ignorando o registo.

Valores válidos:

Para true: "t", "on", "yes", "true", "1", "y"

Para false: "f", "off", "no", "false", "0", "n"

Filtrar por nome da marca. Por predefinição, exclui da recomendação os produtos da marca especificada. Consulte includeBrandFilteredProducts para alterar o comportamento predefinido. Para filtrar múltiplas marcas, utilize o carácter pipe "|".

Exemplo: filbr=Microsoft|Logitech|Apple

Especifica a categoria a filtrar.

filcat=<categoryId>

Para filtrar com base numa categoria específica, deve ser indicado: "filcat=<categoryId>&filcatinc=true>"

Podem ser enviados múltiplos category ids numa string delimitada por pipe. Cada categoria na string é avaliada com operador OR.

Filtra dentro da categoria (requer a especificação da categoria com 'filcat').

filcatinc=true: filtra os resultados para mostrar apenas produtos da categoria especificada.

filcatinc=false: exclui dos resultados os produtos da categoria especificada.

Tipos e valores de filtros selecionados pelo shopper. Coloque aspas em todos os atributos, separe os tipos com o carácter pipe "|" e separe os valores com ponto e vírgula. É obrigatório incluir aspas em todos os atributos.

Exemplo: filterAtr=color:"Red"|size:"M";"L"

Note: filterAtr aplica-se apenas a atributos personalizados. Utilize filbr e includeBrandFilteredProducts para filtrar por marca. Disponível apenas para Search and Browse e requer configuração prévia pelo Algonomy.

Versão Flash do browser. Utilizado apenas quando o conteúdo apresentado é em Flash.

Exemplo: flv=20.0.0.306

Marca em destaque na página. Utilizada para definir o seed em estratégias baseadas em marca, como Brand Top Sellers.

Exemplo: fpb=Microsoft

True/false. Altera a função de filbr de excluir para incluir. Se não especificado, o valor predefinido é false, o que exclui a marca indicada. Se true, o filtro de marca exclui todos os produtos exceto os da marca especificada.

Exemplo: includeBrandFilteredProducts=true

True/false. O valor predefinido é false. Se definido como true, inclui detalhes sobre qualquer teste multivariado (MVT) em execução.

Exemplo: includeMVTData=true

Exemplo de resposta JSON:

"mvt":
[
{ "testId":12953, "control":false, "treatmentId":15707, "treatmentName":"T2 - recs OFF” }
], 

True/false. O valor predefinido é false. Se definido como true, inclui detalhes sobre qualquer teste multivariado (MVT) em execução. O parâmetro string “eligible” indica se o utilizador é elegível para o teste MVT.

Exemplo: includeMVTDetailedData=true

Exemplo de resposta JSON:

"mvtDetailed":
[
{ "eligible":true, "testId":12953, "control":false, "treatmentId":15707, "treatmentName":"T2 - recs OFF” }
]

Quando definido como true, para testes do tipo Placement, a resposta inclui uma nova secção "mvtTreatments" com os detalhes do MVT associado ao placement.

Exemplo de resposta JSON:

"placements":[
{
"mvtTreatments": [
{
"testType": "Placement”,
"testId": 55564,
"control": true,
"treatmentId": 60129,
"treatmentName": "swap_each_other"
}
]

Note: Apenas os tratamentos em que o placement participa são incluídos na resposta. Se o teste de Placement incluir múltiplos placements, todos incluirão “mvtTreatments” na resposta. Se existirem múltiplos testes de Placement para o mesmo placement, serão devolvidos múltiplos tratamentos.

True/False. O valor predefinido é false. Se definido como true, quaisquer dados de SKU disponíveis no SKU Feed são incluídos nos produtos devolvidos.

Exemplo: includeSkuData=true

Exemplo de resposta JSON:

"skuData": [{
  "color": "White",
  "size": "12",
  "image_url": "http://demandware.edgesuite.net/9400.jpg",
  "sku_id": "9400"
}, {
  "color": "White",
  "size": "13",
  "image_url": "http://demandware.edgesuite.net/9401.jpg",
  "sku_id": "9401"
}]

True/false. Altera a função de minPriceFilter e maxPriceFilter de excluir para incluir. Se não especificado, o valor predefinido é false, excluindo produtos cujo preço corresponda ao intervalo definido. Se true, exclui todos os produtos fora do intervalo de preços.

Exemplo: includePriceFilteredProducts=true

True/false. O valor predefinido é false. Se definido como true, cada placement na resposta inclui o nome da estratégia.

Exemplo: includeStrategyData=true

Endereço IP do shopper. Utilize apenas se o pedido à API não for proveniente do dispositivo do shopper (por exemplo, integração server-side).

Exemplo: ipor=255.255.255.255

Nome da função JavaScript para a qual os dados JSON são enviados. Deve ser especificado se jsonp estiver definido como true.

Exemplo: jcb=processData

Flag booleana. O único valor válido é true. Se definido como true, o parâmetro jcb também deve ser fornecido.

Exemplo: jsonp=true

Identifica o idioma solicitado através do respetivo código de idioma.

Exemplo: &lang=sv-SE

Valor máximo do filtro de intervalo de preço. Este filtro corresponde ao preço promocional do produto ou ao preço base, caso não exista preço promocional. O valor deve ser indicado em cêntimos.

Note: Este parâmetro não funciona corretamente sem o uso de includePriceFilteredProducts.

Exemplo: maxPriceFilter=10099 (equivalente a 100,99)

Valor mínimo do filtro de intervalo de preço. Este filtro corresponde ao preço promocional do produto ou ao preço base caso não exista preço promocional. O valor deve ser indicado em cêntimos.

Note: Este parâmetro não funciona corretamente sem o uso de includePriceFilteredProducts.

Exemplo: minPriceFilter=579 (equivalente a 5,79)

ID do pedido. Parte da definição do pedido.

Exemplo: o=902312

Número total de páginas a devolver na resposta. O total de produtos devolvidos é (count * pageCount), até ao número total de produtos na categoria. O valor predefinido de pageCount é 1. Esta funcionalidade permite incorporar respostas paginadas do Discover em sistemas de pesquisa e navegação facetada.

Para valores elevados de pageCount, recomenda-se devolver quantidades reduzidas de dados por produto, utilizando parâmetros adicionais como: "&excludeHtml=true&excludeItemAttributes=true&returnMinimalRecItemData=true"

Exemplo: pageCount=50

Note: Aplicável apenas ao Discover.

Lista de identificadores de placement. Cada identificador é composto por um tipo de página e um nome de placement. Os identificadores devem ser separados pelo carácter pipe "|".

Recebe um conjunto de recomendações por placement.

Todos os placements devem pertencer ao mesmo tipo de página.

O primeiro placement é considerado o "melhor" placement e receberá a melhor estratégia de recomendação.

Quando são solicitados múltiplos placements, cada um recebe uma estratégia distinta e produtos únicos.

Exemplo: placements=item_page.horizontal|item_page.vertical

Preços dos produtos. Lista que define os preços dos produtos comprados. O índice dos preços na lista corresponde aos produtos enviados em productId. Faz parte da definição do pedido.

Utilize pp ou ppc para definir o preço dos itens comprados. Se utilizar pp, aplica-se o multiplicador de moeda do site. Os valores devem ser separados pelo carácter pipe "|".

Exemplo: pp=29.99|32.97

Preços dos produtos em cêntimos. Lista que define os preços dos produtos comprados. O índice dos preços corresponde aos produtos enviados em productId. Faz parte da definição do pedido.

Utilize pp ou ppc. Se utilizar ppc, o multiplicador de moeda do site não é aplicado.

O valor enviado é aceite tal como está e convertido de string para inteiro. Certifique-se de que contém apenas números, sem símbolos ou separadores. Separe os valores com o carácter pipe "|".

Exemplo: ppc=2999|3297 (equivalente a 29,99 e 32,97)

URL da página de referência. Pode existir em qualquer página. Indica o referer do shopper antes de visualizar a página. Utilizado para reporting e merchandising. Altamente recomendado.

Exemplo: pref=http://www.google.com

Filtro baseado nos intervalos de preço aos quais os produtos devem pertencer. Não aplicável a clientes com preços localizados. Os valores devem ser indicados em cêntimos e os intervalos separados pelo carácter pipe "|".

Exemplo: priceRanges=0;100|500;1000

Note: Aplicável apenas a Search and Browse.

True/false. Quando definido como true, ativa o modo de privacidade para o pedido. Em modo de privacidade, os dados de afinidade do utilizador são ignorados e as recomendações são geradas sem personalização baseada em dados comportamentais. Isto garante que as recomendações respeitam as preferências de consentimento do utilizador e não utilizam dados comportamentais para utilizadores que recusam o rastreio.

Exemplo: privm=true

Um único ID de produto ou uma lista de IDs de produto. Faz parte da definição de encomenda na página de conclusão de compra. Utilize o carácter pipe "|" para separar os IDs de produto.

Exemplo: productId=uv2345|xt1234

Note: Para o pedido add_to_cart_page, o ID do produto é enviado como Add to Cart ID através do parâmetro 'atcid'. Assim, este campo productId não é obrigatório.

Note: Também é possível enviar IDs de SKU nas chamadas à API. Ao especificar um PRODUCT ID, o ID de SKU deve ser acrescentado com um separador til "~". Exemplo: ...&productId=[product_id]~[sku_id]

Quantidades dos itens. Lista que define as quantidades dos produtos comprados. O índice das quantidades na lista corresponde ao índice dos produtos enviados em productId. Faz parte da definição da encomenda e deve ser um número inteiro; valores decimais não são aceites. Separe múltiplas entradas com o carácter pipe "|".

Exemplo: q=2|1

Algonomy Cookie String. Trata-se do cookie Algonomy encriptado do utilizador associado ao pedido da API. Deve ser enviado exatamente como foi recebido numa resposta anterior da API.

Os clientes devem garantir que preservam o valor de 'rcs' exatamente como foi fornecido. O parâmetro 'rcs' é sempre alfanumérico e sensível a maiúsculas/minúsculas, incluindo uma combinação de letras maiúsculas, letras minúsculas e números.

Note: O parâmetro 'rcs' permite aos comerciantes fornecer à plataforma Algonomy acesso ao cookie de navegador do utilizador, funcionando como um proxy de cookie. Este processo envolve a leitura e escrita do cookie Algonomy do utilizador pelo comerciante e a sua transmissão de e para a Algonomy através da API server-side.

Limita o objeto JSON recommendedProducts a 4 atributos: id, productURL, clickURL e clickTrackingURL.

Utilizado para identificar um registo específico.

Exemplo: rg=Registry123454321

ID do tipo de registo. Contacte a Algonomy para obter a lista de IDs de tipos de registo disponíveis para o seu site.

Exemplo: rgt=wedding

ID da região. Deve ser consistente com o ID utilizado no product region feed.

Exemplo: rid=Switzerland-France

Termo de pesquisa introduzido pelo utilizador. Também pode utilizar o parâmetro productId para fornecer os IDs dos produtos presentes nos resultados da pesquisa.

Exemplo: searchTerm=adriana lima

Identifica uma única visita do utilizador. As sessões são utilizadas pelos modelos comportamentais para delimitar o comportamento do utilizador durante uma sessão de compra, bem como para métricas de reporting.

Exemplo: sessionId=93484

Fornece segmentos de utilizador. Utilizado para campanhas direcionadas por segmento. Liste cada segmento no formato segment_number:segment_name e utilize o carácter pipe "|" para separar segmentos. Deve enviar tanto o ID do segmento como o nome do segmento para cada entrada.

Exemplo: sgs=101:NewUser|202:Male

Número inicial dos produtos que pretende devolver. Por exemplo, se quiser devolver os produtos 30 a 60, defina o valor como 30.

Note: Aplicável apenas a Search and Browse. Ao utilizar paginação, este parâmetro é obrigatório juntamente com count.

Exemplo: st=30

Lista priorizada de conjuntos de estratégias que pretende devolver com base no caso de uso da campanha. Consulte os detalhes adicionais na secção Strategy Families abaixo. Se não for fornecido, o motor de recomendação executa King of the Hill (KOTH) para apresentar as melhores recomendações com base na informação disponível.

Exemplo: strategySet=SiteWideBestSellers ou strategySet=ProductBoughtBought|ProductViewedViewed

Timestamp. Utilizado para evitar cache do browser e altamente recomendado. Se não for incluído, poderão ser apresentadas respostas em cache.

Exemplo: ts=1376676943

Use Dummy Data. True/false. Se definido como true, devolve produtos aleatórios para fins de teste.

Exemplo: udd=t

Chaves e valores personalizados que descrevem o utilizador atual. Separe a informação utilizando ponto e vírgula e o carácter pipe "|".

Exemplo: userAttribute=eye_color:blue;green|hair_color:brown

A utilização é igual a userAttribute, com a diferença de que os atributos enviados em userAttributeReplace substituem todos os valores anteriormente enviados para esse atributo.

Exemplo: userAttributeReplace=eye_color:black

No exemplo acima, todos os valores anteriores de eye_color serão removidos e substituídos por black.

Se o mesmo atributo for enviado no mesmo pedido em userAttribute e em userAttributeReplace, o valor enviado em userAttributeReplace terá prioridade.

Este atributo também suporta atualização de eliminação de valores. Exemplo: userAttribute=eye_color:|hair_color:

ID do utilizador. String única para identificar cada utilizador. Todo o comportamento do utilizador é armazenado com base nesta chave. É sensível a maiúsculas/minúsculas e deve corresponder ao mesmo user ID enviado à Algonomy noutras aplicações.

Exemplo: userId=0982347

Refinements são utilizados para garantir que os produtos recomendados possuem um valor específico de atributo. Cada refinement é especificado como um par nome/valor separado por dois pontos.

Exemplo: rfm=name:value

Para indicar apenas a existência do atributo, pode omitir o valor.

Exemplo: rfm=name

Para especificar múltiplos refinements, utilize uma lista delimitada pelo carácter pipe "|".

Exemplo: rfm=attributeName|attributeName1:value1|attributeName2:value2

Para mais informações, consulte a secção Refinements.

Refina as recomendações com base em múltiplos valores utilizando os operadores lógicos 'and' e 'or', com o carácter pipe ('|') como delimitador para separar os valores.

Note: rfm_cond só será aplicado se rfm estiver a ser utilizado. Se o parâmetro 'rfm_cond' não estiver presente no pedido, será considerado o comportamento predefinido (ou seja, lógica 'and').

Exemplo: rfm=attributeName:value1|attributeName2:value2&rfb=false&rfm_cond=or

Refinement Fall-Back. Controla o comportamento de fallback quando os refinements não produzem resultados suficientes.

Exemplo: rfb=false

O valor predefinido é true, o que significa que valores de refinement que reduzam as recomendações abaixo do limite mínimo do placement serão descartados.

Para mais informações, consulte a secção Refinements.

Corresponde ao link URL do produto recomendado. É definido pelo cliente no catalog feed ou na Streaming Catalog API. Este parâmetro aplica-se apenas a clickURL.

Exemplo:

ct=http%3A%2F%2Flabs.richrelevance.com%2Fstorre%2Fcatalog%2Fproduct%2Fview%2Fsku%2F22127002.

View guid – utilizado para analytics. Exemplo:

vg=4b121136-3366-452f-092f-3d590a46665c.

ID da estratégia (qual estratégia de recomendação gerou o resultado). Exemplo: stid=126.