A tradução para Português (Brasil) não foi concluída ainda.
API de Coleção do Conjunto de Produtos
Use essa API para criar coleções usadas em lojas e adicionar metadados a um conjunto de produtos, como uma imagem de capa e uma descrição. Em seguida, os conjuntos estarão prontos para uso como coleções no Gerenciador de Comércio, de modo a personalizar sua loja no Facebook ou no Instagram (caso contrário, será preciso criar as coleções manualmente). Também é possível fornecer as identificações das lojas para publicar os conjuntos de produtos prontos de maneira direta. Use as APIs de comércio para obter identificações de lojas.
Consulte o artigo Criar uma coleção no Gerenciador de Comércio na Central de Ajuda para Empresas para saber mais.
POST (API de Criação/Atualização)
O processo para criar e atualizar conjuntos de produtos continua o mesmo. No entanto, é necessário observar novos campos opcionais:
| Campo | Descrição |
|---|---|
| Opcional. O parâmetro principal do bloco de metadados das coleções. |
| Opcional. Parâmetro que fornece shop_ids para criar/atualizar diretamente o conjunto de produtos e publicar em lojas. |
Campos de metadados
| Campo | Descrição |
|---|---|
| Opcional. A URL da imagem de capa da coleção. |
| Opcional. A descrição do conjunto de produtos exibida ao cliente. |
| Opcional. A URL da coleção. Essa URL não é exibida aos clientes, mas serve como padrão ao criar anúncios que promovem seu conjunto de produtos. |
Campos para publicação em lojas
O campo publish_to_shops aceita uma matriz vazia ou uma matriz com os parâmetros mostrados no exemplo abaixo. Se uma matriz vazia for fornecida, o conjunto de produtos em questão será retirado de todas as lojas (caso tenham sido publicados anteriormente).
| Campo | Descrição |
|---|---|
| shop_id é a identificação da loja, que pode ser obtida por meio das APIs de comércio. |
Exemplo: carga
{
"name": "Best sellers",
"filter": {
"retailer_id": {
"is_any": [
"pid1",
"pid2"
]
}
},
"metadata": {
"cover_image_url": "https://foo.com/image.jpg" (https://foo.com/image.jpg%E2%80%9D),
"external_url": "https://foo.com/best-sellers",
"description":"Our best selling products"
}
"publish_to_shops": [{"shop_id": "shop_id1"}, {"shop_id": "shop_id2"}]
}Criar um conjunto de produtos
Crie um conjunto de produtos com metadados de coleção que correspondam às identificações de produtos específicos:
curl \
-F "name=Best Sellers" \
-F "filter={'retailer_id': {'is_any': ['pid1', 'pid2']}}"
-F "metadata={'cover_image_url':'https://foo.com/image.jpg', 'external_url':'https://foo.com/best-sellers', 'description':'Our best selling products'}" \
-F "access_token=<ACCESS_TOKEN>" \
https://graph.facebook.com/API_VERSION/PRODUCT_CATALOG_ID/product_setsAtualizar um conjunto de produtos
Atualize um conjunto de produtos com metadados de coleção e publique em lojas:
curl \
-F "name=Updated Best Sellers" \
-F "metadata={'cover_image_url':'https://foo.com/image_updated.jpg', 'external_url':'https://foo.com/best-sellers-updated', 'description':'Our updated best selling products'}" \
-F "publish_to_shops=[{'shop_id':'shop_id1'}, {'shop_id':'shop_id2'}]"
-F "access_token=<ACCESS_TOKEN>" \
https://graph.facebook.com/API_VERSION/PRODUCT_SET_IDGET (API de Leitura)
No nó GET, o campo live_metadata retorna os metadados publicados e ativos em um conjunto de produtos. Já o campo latest_metadata retorna os metadados mais recentes enviados à API. Esses campos poderão ser diferentes se, por exemplo, uma imagem alterada na atualização for rejeitada por motivos de integridade.
Todos os campos são do tipo não padrão e devem ser chamados explicitamente na Graph API como parâmetros de campo.
| Campo | Descrição |
|---|---|
| As informações de metadados mais recentes que foram enviadas. Pode não ser igual a |
| Metadados atuais e ativos do conjunto de produtos. |
Campos de metadados
| Campo | Descrição |
|---|---|
| A URL da imagem de capa do conjunto de produtos exibida ao cliente. |
| A descrição do conjunto de produtos exibida ao cliente. |
| A URL da coleção. Essa URL não é exibida aos clientes, mas serve como padrão ao criar anúncios que promovem seu conjunto de produtos. |
| O status da análise de integridade. Pode ser |
Exemplo – leia um conjunto de produtos para ver quais metadados estão ativos:
curl -G \
-d "access_token=<ACCESS_TOKEN>" \
https://graph.facebook.com/<API_VERSION>/<PRODUCT_SET_ID>/?fields=id,name,latest_metadata{cover_image_url, description, review_status},live_metadata{cover_image_url, description, review_status}Resposta:
{
"id": 1234567890,
"name": "Best sellers",
"latest_metadata": {
"cover_image_url": "https://foo.com/some_new_image.jpg" (https://foo.com/image.jpg%E2%80%9D),
"description":"Our best selling products",
"integrity_review_status": "REJECTED"
},
"live_metadata": {
"cover_image_url": "https://foo.com/some_good_image.jpg",
"description":"Our best selling products",
"integrity_review_status": "APPROVED"
}
}Perguntas frequentes
P: Qual é a taxa de proporção mínima aceitável para uma imagem de capa?
R: As imagens precisam ter uma taxa mínima de 600 x 600 (mas o corte de edição está indisponível nessa proporção). Ao carregar uma imagem a partir de 800 x 800, uma taxa de proporção quadrada será selecionada por padrão. Para os melhores resultados possíveis, recomendamos o uso da taxa de proporção 1.080 x 1.080.
P: Qual é o tamanho de arquivo máximo para uma imagem de capa?
R: O arquivo pode ter até 8 MB.
P: Quais formatos de arquivo são compatíveis com as imagens de capa?
R: Os formatos JPG e PNG são aceitos.
P: Existem restrições em relação ao tamanho da descrição?
R: Não há um tamanho mínimo definido para a descrição. O limite máximo é de 200 caracteres.
P: Como faço para tirar do ar uma coleção (conjunto de produtos) em lojas?
R: Use a API de Atualização e remova o campo shop_id da lista publish_to_shop em que a coleção foi publicada anteriormente. Se uma matriz vazia ([]) for fornecida, o conjunto de produtos será retirado de todas as lojas.