Este documento se ha actualizado.
La traducción en Español (España) no está disponible todavía.
Actualización del documento en inglés: 18 oct. 2021

API de colección de conjuntos de productos

Puedes utilizar esta API para crear las colecciones que se usan en las tiendas y añadir metadatos a un conjunto de productos, como una imagen de portada y una descripción. A continuación, los conjuntos de productos están preparados para usarse como colecciones en Commerce Manager a fin de personalizar tu Tienda de Facebook o Instagram (de lo contrario, las colecciones se crean manualmente). Para publicar directamente dichos conjuntos de productos preparados, debes proporcionar los identificadores de las tiendas. Estos identificadores se pueden obtener mediante las API de comercio.

Obtén más información sobre cómo crear una colección en Commerce Manager, servicio de ayuda para empresas.

POST (API de creación o actualización)

La creación y actualización de los conjuntos de productos siguen igual. No obstante, hay algunos campos opcionales nuevos que tener en cuenta:

CampoDescripción

metadata

Opcional.

Parámetro principal del bloque de metadatos de las colecciones.

publish_to_shops

Opcional.

Parámetro para proporcionar valores de shop_id a fin de crear o actualizar directamente un conjunto de productos y publicarlo en las tiendas.

Campos de metadatos


CampoDescripción

cover_image_url

Opcional.

URL de la imagen de portada de la colección.

description

Opcional.

Descripción que puede ver el cliente del conjunto de productos.

external_url

Opcional.

URL de la colección. Esta URL no se muestra a los consumidores, pero sirve de valor predeterminado al crear anuncios que promocionen el conjunto de productos.

Campos Publish to Shops

El campo publish_to_shops acepta una matriz vacía o con los parámetros que se muestran en el ejemplo incluido a continuación. Si se proporciona una matriz vacía, se anulará la publicación del conjunto de productos indicado de todas las tiendas (si se ha publicado con anterioridad).


CampoDescripción

shop_id

Aquí se espera el valor de shop_id, que se puede obtener mediante las API de comercio.

Ejemplo: carga útil

{ 
    "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"}]
}

Crear un conjunto de productos

Crea un conjunto de productos con metadatos de colección que coincidan con identificadores de producto 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_sets

Actualizar un conjunto de productos

Actualiza un conjunto de productos existente con los metadatos de colección y publícalo en las tiendas:

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_ID

GET (API de lectura)

En el nodo GET, el campo live_metadata devuelve los metadatos que están publicados y activos en un conjunto de productos determinado y el campo latest_metadata, los que se enviaron por última vez a la API. Estos campos pueden diferir si, por ejemplo, se cambió una imagen tras la actualización y se rechazó por motivos de integridad.

Todos los campos son no predeterminados y se deben llamar explícitamente en la API Graph como parámetros de campo.

CampoDescripción

latest_metadata

Información de metadatos más reciente que se envió. Puede que no sea la misma que la del campo live_metadata (por ejemplo, si el valor de review_status es REJECTED).

live_metadata

Metadatos actuales y activos de este conjunto de productos.

Campos de metadatos


CampoDescripción

cover_image_url

URL de la imagen de portada del conjunto de productos que puede ver el cliente.

description

Descripción que puede ver el cliente del conjunto de productos.

external_url

URL de la colección. Esta URL no se muestra a los consumidores, pero sirve de valor predeterminado al crear anuncios que promocionen el conjunto de productos.

integrity_review_status

Estado de la revisión de integridad. Puede ser uno de los siguientes valores: APPROVED, REJECTED o PENDING.

Ejemplo: leer un conjunto de productos para ver los metadatos que están activos:

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}

Respuesta:

{ 
    "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"
    }
}

Preguntas frecuentes

P: ¿Cuál es la relación de aspecto mínima aceptable para una imagen de portada?

R: Las imágenes deben ser de al menos 600 × 600 (aunque la edición de recorte no está disponible en esta relación). Si se cargan imágenes de 800 × 800 o mayores, se selecciona una relación de aspecto cuadrada como predeterminada. Para obtener los mejores resultados, se recomienda una relación de aspecto de 1080 × 1080.

P: ¿Cuál es el tamaño de archivo máximo para una imagen de portada?

R: El tamaño de archivo máximo es de 8 MB.

P: ¿Qué formatos de archivo se admiten para las imágenes de portada?

R: Se admiten JPG y PNG.

P: ¿Hay restricciones de longitud en la descripción?

R: No hay una longitud mínima para la descripción. La longitud máxima es de 200 caracteres.

P: ¿Cómo puedo anular la publicación de una colección (conjunto de productos) de las tiendas?

R: Puedes usar la API de actualización y eliminar el campo shop_id de la lista publish_to_shop en la que se publicó previamente. Si se proporciona una matriz vacía ([]), se anula la publicación del conjunto de productos de todas las tiendas.