Referencia

Utiliza esta referencia para consultar los campos admitidos y los ejemplos correspondientes de los extremos POST /{catalog_id}/items_batch y POST /{catalog_id}/batch.

Los nombres de parámetro de /{catalog_id}/batch y /{catalog_id}/items_batch pueden parecerse, pero son diferentes.

Recomendamos usar la API /{catalog_id}/items_batch, que admite más casos de uso y tiene un mantenimiento activo.

Campos admitidos: Enviar actualizaciones de artículos (/{catalog_id}/batch)

Estos campos son compatibles con los métodos CREATE y UPDATE.

Anular campos

Al actualizar artículos, proporciona una cadena vacía como valor para anular un campo opcional. Si estableces el valor como null, el campo no se anulará.

Campo Descripción

additional_image_urls

Tipo:

matriz<string>

Opcional.

URL de un máximo de nueve o diez imágenes diferentes.

additional_variant_attributes

Tipo:

lista<KeyValue:string,string>

Opcional.

Atributos adicionales para distinguir el producto en el grupo de variantes correspondiente.

Ejemplo: {"Scent" : "Fruity", "Style" : "Classic"}.

availability

Tipo: cadena

Obligatorio.

Identifica el estado de disponibilidad:

  • in stock: el artículo se envía de inmediato.
  • out of stock: no hay planes de reposición.
  • available for order: se envía en una o dos semanas.
  • discontinued

age_group

Tipo: cadena

Opcional.

Grupo de personas que tienen la misma edad o una edad similar. Los valores aceptados son newborn, infant, toddler, kids y adult.

applinks

Tipo:

objeto<>

Opcional.

Enlaces a aplicaciones para móviles.

category

Tipo: cadena

Opcional pero recomendado en el caso de los anuncios de catálogo de Advantage+ (puede contribuir a que el rendimiento de los anuncios sea mejor). Opcional en el caso de las compras en Instagram y las tiendas de páginas, pero obligatorio para activar la finalización de compra en el sitio en estos canales (solo en EE. UU.). Obligatorio en el caso de Marketplace (solo en EE. UU.).

Categoría de producto de Google (GPC) del artículo. Utiliza la ruta de la taxonomía de la categoría o el número de identificación correspondiente, que se indican aquí.

Si utilizas la finalización de compra en Facebook e Instagram (solo en EE. UU.), la GPC del artículo afecta a los impuestos y la política de devolución correspondientes. Obtén más información sobre la categoría de producto de Google para artículos del catálogo en el Servicio de ayuda para publicidad.

Ejemplo: Apparel & Accessories > Clothing > Shirts & Tops o 212.

color

Tipo: cadena

Opcional.

Tamaño máximo: 100.

Color del artículo.

condition

Tipo: cadena

Obligatorio.

Estado del artículo: new, refurbished o used.

currency

Tipo: cadena

Obligatorio.

Divisa del valor especificado. La API de marketing admite todas las divisas compatibles con las cuentas publicitarias. Utiliza los estándares de divisas de la norma ISO 4217.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Tipo: cadena

Opcional.

Límite máximo de caracteres: 100.

Información adicional sobre el artículo. Proporciona una cadena vacía para anularlo.

description

Tipo: cadena

Obligatorio.

Tamaño máximo: 5000.

Descripción breve del artículo.

gender

Tipo: cadena

Opcional.

Género para las tallas. Los valores son male, female y unisex.

gtin

Tipo: cadena

Opcional.

Tamaño máximo: 70.

El número mundial de artículo comercial puede incluir UPC,EAN, JAN y ISBN.

image_url

Tipo: cadena

Obligatorio.

Enlace a la imagen del artículo que se usa en el anuncio. Proporciona tamaños de imagen adecuados.

En el caso de los anuncios de catálogo de Advantage+ de una sola imagen:

  • La resolución de imagen mínima necesaria es de 500 píxeles * 500 píxeles.
  • La relación de aspecto mínima necesaria es de 4:5.
  • La relación de aspecto máxima necesaria es de 1:91:1.

Si la imagen está fuera de esta relación de aspecto, Facebook la recorta para que esté lo más cerca posible de la relación de aspecto mínima o máxima, en función de la relación de aspecto original.

En el caso de los anuncios de catálogo de Advantage+ de imágenes por secuencia, la resolución de imagen mínima necesaria es de 500 píxeles * 500 píxeles y Facebook las recorta a una relación de aspecto de 1:1.

Recomendación: Evita cambios frecuentes de image url. Las URL de imágenes no deben contener parámetros, como price o timestamp, ya que estos tienden a cambiar con frecuencia.

inventory

Tipo: número

Opcional.

Entero que los anunciantes pueden utilizar para almacenar información sobre el nivel de inventario.

marked_for_product_launch

Tipo: cadena

No se aplica en el caso de los anuncios de catálogo de Advantage+. Es opcional en el caso del comercio.

Indica si un artículo se utilizará en el lanzamiento de un producto. Valores admitidos:

  • marked: el artículo se ocultará a los compradores hasta que se cree el lanzamiento de un producto. De este modo se evita que el artículo esté disponible para ver y comprar antes de la hora de lanzamiento deseada.
  • not_marked (valor predeterminado): el artículo no formará parte del lanzamiento de un producto.

name

Tipo: cadena

Obligatorio.

Tamaño máximo: 100.

Título del artículo.

pattern

Tipo: cadena

Opcional.

Tamaño máximo: 100.

Patrón o estampado de un artículo.

price

Tipo: entero

Obligatorio.

Precio multiplicado por 100, en todas las divisas. Ejemplo: 490, cuando se utiliza con USD, indica 4,90 USD y 49 000, cuando se utiliza con JPY, indica 490 JPY.

product_type

Tipo: cadena

Opcional.

Tamaño máximo: 750.

Categoría definida por el minorista para el artículo.

Ejemplo: en el archivo TSV Casa y jardín > Cocina y comedor > Electrodomésticos > Neveras.

Ejemplo: en el archivo XML product_type > Casa y jardín > Cocina y comedor > Electrodomésticos > Neveras > product_type.

retailer_product_group_id

Tipo: cadena

Opcional.

Acepta cadenas. Los anunciantes pueden utilizarlo para agrupar productos.

sale_price

Tipo: entero

Opcional.

Precio con descuento si el artículo está de oferta. Es el precio de oferta multiplicado por 100, en todas las divisas. Ejemplo: 490, cuando se utiliza con USD, indica 4,90 USD y 49 000, cuando se utiliza con JPY, indica 490 JPY.

sale_price_start_date

Tipo: cadena

Opcional.

Fecha y hora de fin de la oferta.

Ejemplo: 2014-12-01T00:00-0300.

sale_price_end_date

Tipo: cadena

Opcional.

Fecha y hora de inicio de la oferta.

Ejemplo: 2014-11-01T12:00-0300.

shipping

Tipo:

matriz<object>

Opcional.

Información de envío.

size

Tipo: cadena

Opcional.

Talla del artículo. Ejemplo: Small o XL.

url

Tipo: cadena

Obligatorio.

Enlace al sitio del comerciante en el que se puede comprar el artículo.

vendor_id

Tipo: cadena

Opcional.

Identificador del proveedor o vendedor que vende el artículo.

Ejemplo de solicitud: /{catalog_id}/batch

{
  "access_token": "<ACCESS_TOKEN>",
  "requests": [
    {
      "method": "DELETE",
      "retailer_id": "retailer-1"
    },
    {
      "method": "CREATE",
      "retailer_id": "retailer-2",
      "data": {
        "availability": "in stock",
        "brand": "Nike",
        "category": "t-shirts",
        "description": "product description",
        "image_url": "http://www.images.example.com/t-shirts/1.png",
        "name": "product name",
        "price": 1000,
        "currency": "USD",
        "shipping": [
           {
              "country": "US",
              "region": "CA",
              "service": "service",
              "price_value": "10",
              "price_currency": "USD"
           }
        ],
        "condition": "new",
        "url":"http://www.images.example.com/t-shirts/1.png",
        "retailer_product_group_id": "product-group-1"
      },
      "applinks": {
          "android": [{
              "app_name": "Electronic Example Android",
              "package": "com.electronic",
              "url": "example-android://electronic"
              }],
          "ios": [{
              "app_name": "Electronic Example iOS",
              "app_store_id": 2222,
              "url": "example-ios://electronic"
              }]
      },
    },
    {
      "method": "UPDATE",
      "retailer_id": "retailer-3",
      "data": {
        "availability": "out of stock",
      }
    }
  ]
}

Ejemplo de respuesta: /{catalog_id}/batch

Se devolverán uno o varios identificadores.

"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/batch

Campos admitidos: Enviar actualizaciones de productos (/{catalog_id}/items_batch)

Para los catálogos comerciales: usa esta API si necesitas actualizar la información sobre los productos más de una vez cada hora (de lo contrario, usa la API de listas). Puedes actualizar varios artículos en una sola solicitud HTTP.

PRODUCT_ITEM

Estos campos de productos son compatibles con los métodos CREATE y UPDATE, en las versiones 3.3 y 3.2:

CampoDescripción

additional_image_link

Tipo:

matriz<string>

Opcional.

Enlace de un máximo de nueve o diez imágenes diferentes.

additional_variant_attribute

Tipo:

lista<KeyValue:string,string>

Opcional.

Atributos adicionales para distinguir el producto en el grupo de variantes correspondiente.

Ejemplo: "Scent:Fruity,Flavor:Apple".

age_group

Tipo: cadena

Opcional.

Grupo de personas que tienen la misma edad o una edad similar. Los valores aceptados son newborn, infant, toddler, kids y adult.

applink

Tipo:

objeto<string>

Opcional.

Enlaces a aplicaciones para móviles.

Ejemplo:

"applink" : {
  "ios_url": "example-ios://electronic",
  "ios_app_store_id": "42",
  "ios_app_name": "Electronic Example iOS",
  "iphone_url": "example-iphone://electronic",
  "iphone_app_store_id": "43",
  "iphone_app_name": "Electronic Example iPhone",
  "ipad_url": "example-ipad://electronic",
  "ipad_app_store_id": "44",
  "ipad_app_name": "Electronic Example iPad",
  "android_url": "example-android://electronic",
  "android_package": "com.electronic",
  "android_class": "com.electronic.Example",
  "android_app_name": "Electronic Example Android",
  "windows_phone_url": "example-windows://electronic",
  "windows_phone_app_id": "64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
  "windows_phone_app_name": "Electronic Example Windows",
}

availability

Tipo: cadena

Obligatorio.

Identifica el estado de disponibilidad:

  • in stock: el artículo se envía de inmediato.
  • out of stock: no hay planes de reposición.
  • available for order: se envía en una o dos semanas.
  • discontinued

brand

Tipo: cadena

Opcional.

Marca del artículo.

color

Tipo: cadena

Opcional.

Tamaño máximo: 100.

Color del artículo.

condition

Tipo: cadena

Obligatorio.

Estado del producto: new, refurbished o used.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Tipo: cadena

Opcional.

Límite máximo de caracteres: 100.

Información adicional sobre el artículo.

description

Tipo: cadena

Obligatorio.

Tamaño máximo: 5000.

Texto breve que describe el producto.

disabled_capabilities

Tipo:

matriz<string>

Opcional.

Lista de funciones que se desactivarán. Los posibles valores son marketplace, b2c_marketplace, buy_on_facebook, cpas_parent_catalog, marketplace_shops, shops, daily_deals, ig_onsite_shopping, ig_product_tagging, c2c_marketplace, groups, profile, da, whatsapp, ldp, mini_shops, business_inbox_in_messenger, neighborhoods y test_capability.

gender

Tipo: cadena

Opcional.

Género para las tallas. Los valores son male, female y unisex.

google_product_category

Tipo: cadena

Opcional.

Tamaño máximo: 250.

Valores predefinidos (cadena o identificador de la categoría) de la taxonomía de productos de Google.

Ejemplo: Ropa y accesorios > Prendas de vestir > Vestidos o 2271.

gtin

Tipo: cadena

Opcional.

Tamaño máximo: 70.

El número mundial de artículo comercial (GTIN) puede incluir UPC, EAN, JAN, y ISBN.

id

Tipo: cadena

Obligatorio.

Identificador del minorista.

image

Tipo: matriz<object>

URL y etiquetas de las imágenes que se utilizarán en los anuncios o en las tiendas. Admite un máximo de 20 imágenes diferentes. Las etiquetas son opcionales y, si se utilizan, deben describir lo que hay en la imagen.


Ejemplo:

"image": [
      {
        "url":"http://example.com/image_1.jpg",
        "tag": ['Swimming pool','Gym'],
      }
]

image_link

Tipo: cadena

No es obligatorio si se proporciona image.

En su lugar, recomendamos usar image. Cuando se proporciona image, se ignoran image_link y additional_image_link.

Enlace a la imagen del artículo que se usa en el anuncio. Proporciona tamaños de imagen adecuados.

En el caso de los anuncios de catálogo de Advantage+ de una sola imagen:

  • La resolución de imagen mínima necesaria es de 500 píxeles * 500 píxeles.
  • La relación de aspecto mínima necesaria es de 4:5.
  • La relación de aspecto máxima necesaria es de 1:91:1. Si la imagen está fuera de esta relación de aspecto, Facebook la recorta para que esté lo más cerca posible de la relación de aspecto mínima o máxima, en función de la relación de aspecto original.

En el caso de los anuncios de catálogo de Advantage+ de imágenes por secuencia, la resolución de imagen mínima necesaria es de 500 píxeles * 500 píxeles y Facebook las recorta a una relación de aspecto de 1:1.

internal_label

Tipo: cadena

Añade etiquetas internas para ayudar a filtrar los artículos al crear conjuntos de productos. Por ejemplo, puedes añadir una etiqueta de “verano” para especificar todos los artículos que forman parte de una promoción de verano y, después, incluir esos artículos en un conjunto. Solo tú podrás ver las etiquetas.

Delimita cada etiqueta con comillas simples (') y separa las distintas etiquetas con comas (,). No incluyas espacios en blanco al principio ni al final de una etiqueta. Límite de caracteres: 5000 etiquetas por producto y 110 caracteres por etiqueta como máximo.

Ejemplo (TSV, XLSX, Hojas de cálculo de Google): ['verano','tendencia']

Ejemplo (CSV): “['verano','tendencia']”

Nota: Si estás utilizando etiquetas personalizadas (de custom_label_0 a custom_label_4) para filtrar conjuntos de productos, te recomendamos empezar a usar las etiquetas internas (internal_label) en su lugar. A diferencia de las etiquetas personalizadas, puedes añadir o actualizar etiquetas internas tan a menudo como quieras sin tener que enviar los artículos a revisión de acuerdo con las políticas cada vez (lo cual puede afectar la entrega de anuncios).

Anteriormente, este campo se llamaba product_tags. Aunque todavía admitimos el nombre antiguo, te recomendamos que utilices el nuevo.

inventory

Tipo: objeto

Opcional.

Entero que los anunciantes pueden utilizar para almacenar información sobre el nivel de inventario.

item_group_id

Tipo: cadena

Opcional.

Identificador proporcionado por el anunciante de un grupo de productos; no es el identificador de Facebook. Acepta cadenas. Los anunciantes lo pueden utilizar para agrupar una variedad de objetos diferentes (productos, vehículos, hoteles, vuelos, etc.).

link

Tipo: cadena

Obligatorio.

Enlace al sitio del comerciante en el que se puede comprar el artículo.

manufacturer_part_number

Tipo: cadena

Opcional.

Identificador único del fabricante del producto.

pattern

Tipo: cadena

Opcional.

Tamaño máximo: 100.

Patrón o impresión gráfica de un producto.

price

Tipo: cadena

Obligatorio.

Precio del artículo. Asigna al precio el mismo formato que al coste, seguido del código de divisa ISO de tres dígitos, con un espacio entre el coste y la divisa.

Ejemplo: 9.99 USD.

rating_count

Tipo: número

Opcional.

La cantidad de calificaciones que los compradores han proporcionado para este producto. Debe ser mayor que 0. Se debe usar junto con user_rating.

Ejemplo: 100.

sale_price

Tipo: cadena

Opcional, pero obligatorio para utilizar la función de superposición en el caso de los anuncios de catálogo de Advantage+.

Precio con descuento si el artículo está de oferta. Asigna al precio el mismo formato que al coste, seguido del código de divisa ISO de tres dígitos, con un espacio entre el coste y la divisa.

Ejemplo: 9.99 USD, 25.00 EUR.

sale_price_effective_date

Tipo: cadena

Opcional.

Fecha y hora de inicio y fin de la oferta, separadas por una barra inclinada. Escribe las fechas de inicio y fin en el formato AAAA-MM-DD. Añade una “T” después de cada una e incluye la hora. Escribe la hora en un formato de 24 horas (de 0:00 a 23:59).

Ejemplo: 2014-11-01T12:00-0300/2014-12-01T00:00-0300.

shipping

Tipo: cadena

Opcional.

Blob con precios diferentes para cada país y región. Las diferentes regiones se separan por comas. El formato debe ser COUNTRY:STATE:SHIPPING_TYPE:PRICE.

Ejemplo: US:CA:Ground:9.99 USD, US:NY:Air:15.99 USD.

size

Tipo: cadena

Opcional.

Talla del artículo. Ejemplo: Small o XL.

title

Tipo: cadena

Obligatorio.

Tamaño máximo: 100.

Título del artículo.

user_rating

Tipo: número

Opcional.

La media de calificación que los compradores han proporcionado para este producto. El intervalo va de 1,0 a 5,0. Se permite un decimal. Se debe usar junto con rating_count.

Ejemplo: 4,5.

video

Tipo: matriz<object>

URL y etiquetas de los vídeos que se utilizarán en los anuncios o en las tiendas. Admite un máximo de 30 000 vídeos en el nivel de catálogo. Las etiquetas son opcionales y, si se utilizan, deben describir lo que hay en el vídeo.


El tamaño máximo de archivo de vídeo es de 200 MB. Los formatos admitidos son .3g2, .3gp, .3gpp, .asf, .avi, .dat, .divx, .dv, .f4v, .flv, .gif, .m2ts, .m4v, .mkv, .mod, .mov, .mp4, .mpe, .mpeg, .mpeg4, .mpg, .mts, .nsv, .ogm, .ogv, .qt, .tod, .ts, .vob y .wmv.


Ejemplo:

"video": [
      {
        "url":"http://example.com/video_1.mp4",
        "tag": ['Swimming pool','Gym'],
      }
]

NOTA: Para eliminar el vídeo 1 si el producto tiene el vídeo 1, 2, elimina el vídeo 1 de la matriz:

[
  {
    "method": "UPDATE",
    "data": {
      "video": [
        {
          "url": "https://google.com/video_2.mp4",
          "tag": ["video_2"]
        }
      ]
    }
  }
]

Para eliminar todos los vídeos, envía una matriz vacía:

[
  {
    "method": "UPDATE",
    "data": {
      "video": []
    }
  }
]

El método UPDATE también puede utilizarse para crear artículos si no existen previamente.

Obtén más información sobre los campos de productos en la referencia de la API.

Ejemplo de solicitud: PRODUCT_ITEM

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "PRODUCT_ITEM",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "id": "retailer-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "id": "retailer-2",
            "applink" : {
            "ios_url":"example-ios://electronic",
            "ios_app_store_id":"42",
            "ios_app_name":"Electronic Example iOS",
            "iphone_url":"example-iphone://electronic",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Electronic Example iPhone",
            "ipad_url":"example-ipad://electronic",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Electronic Example iPad",
            "android_url":"example-android://electronic",
            "android_package":"com.electronic",
            "android_class":"com.electronic.Example",
            "android_app_name":"Electronic Example Android",
            "windows_phone_url":"example-windows://electronic",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Electronic Example Windows",
          },
          "availability": "in stock",
          "brand": "Nike",
          "google_product_category": "t-shirts",
          "description": "product description",
          "image_link": "http://www.images.example.com/t-shirts/1.png",
          "title": "product name",
          "price": "10.00 USD",
          "shipping": [
               {
                  "shipping_country": "US",
                  "shipping_region": "CA",
                  "shipping_service": "service",
                  "shipping_price_value": "10",
                  "shipping_price_currency": "USD"
               }
          ],
          "condition": "new",
          "link":"http://www.images.example.com/t-shirts/1.png",
          "item_group_id": "product-group-1"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "availability": "out of stock",
          "id": "retailer-3",
        }
      }
    ]
  }

Ejemplo de respuesta: PRODUCT_ITEM

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

Obtén más información sobre cómo añadir artículos de catálogo con una lista de datos.


HOTEL

Campos de productos compatibles con los métodos CREATE y UPDATE para el tipo HOTEL, en la versión 3.2:

CampoDescripción

address

Tipo:

objeto<string>

Obligatorio.

Dirección del hotel.

applink

Tipo:

Opcional.

Enlaces a aplicaciones para móviles.

base_price

Tipo: cadena

Obligatorio.

Precio base de la habitación de hotel por noche. Añade el tipo de divisa al precio. Asigna al precio el mismo formato que al coste, seguido del código de divisa ISO, con un espacio entre el coste y la divisa. Ejemplo: USD para dólares estadounidenses.

brand

Tipo: cadena

Opcional.

Marca de la cadena de hoteles.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Tipo: cadena

Límite máximo de caracteres: 100.

Hasta cinco campos personalizados de cualquier información adicional por la que quieras filtrar los artículos cuando creas conjuntos. Por ejemplo, puedes utilizar un campo personalizado para especificar todas las habitaciones que forman parte de una oferta de temporada y, después, filtrar esas habitaciones en un conjunto. Este campo admite cualquier valor de texto, incluidos números.


Ejemplo: Summer Sale

Este campo se admite en las listas complementarias.

custom_number_0
custom_number_1
custom_number_2
custom_number_3
custom_number_4

Tipo: entero

Hasta cinco campos personalizados de cualquier información adicional relacionada con números por la que quieras filtrar los artículos cuando creas conjuntos. Este campo permite filtrar por intervalos de números (es mayor que y es menor que) cuando creas un conjunto. Por ejemplo, puedes utilizar este campo para especificar el año en el que se abrió un hotel y, a continuación, filtrar un determinado intervalo de años en un conjunto.


Este campo admite números enteros entre el 0 y el 4294967295. No admite números negativos, decimales ni comas, como -2, 5,5 o 10 000.


Ejemplo: 2022.

description

Tipo: cadena

Obligatorio.

Límite de caracteres máximo: 5000.

Descripción breve del hotel.

guest_rating

Tipo:

matriz<object>

Opcional.

Calificaciones de los huéspedes del hotel.

hotel_id

Tipo: cadena

Obligatorio.

Identificador único del hotel.

image

Tipo:

matriz<object>

Obligatorio.

Las URL y etiquetas de las imágenes que se utilizarán en los anuncios. Admite hasta 20 imágenes múltiples. La etiqueta es opcional, cuando se utiliza. Debe describir lo que hay en la imagen. Ejemplo: "reception".

latitude

Tipo: cadena

Obligatorio.

Latitud de la ubicación del hotel.

longitude

Tipo: cadena

Obligatorio.

Longitud de la ubicación del hotel.

loyalty_program

Tipo: cadena

Opcional.

Programa de fidelidad que se usa para el hotel.

margin_level

Tipo: cadena

Opcional.

Indicador de la rentabilidad del hotel; valor de 1 a 10.

name

Tipo: cadena

Obligatorio.

Nombre del hotel.

neighborhood

Tipo:

matriz<string>

Opcional.

Una o varias comunidades locales para el hotel. Ejemplo: Soho o Las Vegas Strip. Número máximo de comunidades locales permitidas: 20.

phone

Tipo: cadena

Opcional.

Número de teléfono con el código de país.

sale_price

Tipo: cadena

Opcional.

Precio de oferta por noche del hotel. Utilízalo para publicitar descuentos con respecto al precio habitual del hotel. Obligatorio: añade el tipo de divisa al precio. Asigna al precio el mismo formato que al coste, seguido del código de divisa ISO, con un espacio entre el coste y la divisa. Ejemplo: USD para dólares estadounidenses.

star_rating

Tipo: cadena

Opcional.

Calificación de estrellas del hotel. El número debe estar entre 1 y 5.

url

Tipo: cadena

Obligatorio.

Enlace al sitio web externo en el que reservas la habitación del hotel.

El método UPDATE también puede utilizarse para crear artículos si no existen previamente.

Ejemplo de solicitud: HOTEL

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "HOTEL",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "hotel_id": "hotel-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "hotel_id": "1234",
          "brand": "Premium_brand",
          "description": "A very nice hotel",
          "name": "The best hotel",
          "base_price": "100.00 USD",
          "longitude":"42.10",
          "latitude":"42.10",
          "address": {
              "addr1":"100 Main Street",
              "city":"North Pole",
              "region":"ABC",
              "country":"US",
              "postal_code":"11111"
          },
          "guest_rating" : [
            {
                "rating_system":"tripAdvisor",
                "score":"7.8",
                "number_of_reviewers":"300",
                "max_score":"10",
            },
            {
                "rating_system":"Yelp",
                "score":"5.1",
                "number_of_reviewers":"123",
                "max_score":"10",
            },
          ],
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['Swimming pool','Gym'],
            }
          ],
          "applink" : {
            "ios_url":"example-ios://electronic",
            "ios_app_store_id":"42",
            "ios_app_name":"Electronic Example iOS",
            "iphone_url":"example-iphone://electronic",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Electronic Example iPhone",
            "ipad_url":"example-ipad://electronic",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Electronic Example iPad",
            "android_url":"example-android://electronic",
            "android_package":"com.electronic",
            "android_class":"com.electronic.Example",
            "android_app_name":"Electronic Example Android",
            "windows_phone_url":"example-windows://electronic",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Electronic Example Windows",
          },
          "loyalty_program":"Premium_program",
          "margin_level": "8",
          "phone":"+61 2-96027455",
          "star_rating":"4",
          "url":"http://www.images.example.com/t-shirts/1.png"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "base_price": "90.00 USD",
          "hotel_id": "hotel-3",
        }
      }
    ]
  }

Ejemplo de respuesta: HOTEL

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

HOTEL_ROOM

Estos campos de productos son compatibles con los métodos CREATE y UPDATE para el tipo HOTEL_ROOM, en la versión 3.2.

CampoDescripción

base_price

Tipo: cadena

Obligatorio.

Precio base para una noche. La divisa debe seguir los códigos de divisa de la norma ISO 4217.

Ejemplo: 9.99 USD.

description

Tipo: cadena

Obligatorio.

Tamaño máximo: 5000.

Texto breve que describe la habitación.

hotel_retailer_id

Tipo: cadena

Obligatorio.

Identificador único del minorista del hotel.

hotel_room_id

Tipo: cadena

Obligatorio.

Identificador único del hotel.

image

Tipo:

matriz<object>

Obligatorio.

Imágenes de la habitación.

name

Tipo: cadena

Obligatorio.

Tamaño máximo: 100.

Nombre de la habitación.

url

Tipo: cadena

Obligatorio.

Enlace al sitio del anunciante en el que se puede reservar la estancia.

El método UPDATE también puede utilizarse para crear artículos si no existen previamente.

Ejemplo de solicitud: HOTEL_ROOM

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "HOTEL_ROOM",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-1",
        }
      },
      {
        "method": "CREATE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-2",
          "description": "product description",
          "name": "product name",
          "base_price": "100 USD",
          "url": "http://www.example.com/t-shirts/1.html",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['Swimming pool','Gym'],
            }
          ]
      },
      {
        "method": "UPDATE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-3",
          "base_price": "120 USD",
        }
      }
    ]
  }

Ejemplo de respuesta: HOTEL_ROOM

{
    // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
  }

FLIGHT

Estos campos de producto son compatibles con los métodos CREATE y UPDATE para el tipo FLIGHT, en la versión 3.2.

CampoDescripción

description

Tipo: cadena

Opcional.

Límite de caracteres máximo: 5000.

Descripción del vuelo.

destination_airport

Tipo: cadena

Obligatorio.

Aeropuerto de destino del vuelo. Debe escribirse como un código IATA.

Ejemplo: SFO.

destination_city

Tipo: cadena

Opcional.

Nombre de la ciudad de destino del vuelo.

image

Tipo:

matriz<object>

Obligatorio.

Las URL y etiquetas de las imágenes que se utilizarán en los anuncios. Admite hasta 20 imágenes múltiples. La etiqueta es opcional y, cuando se utiliza, debe describir lo que hay en la imagen.

Ejemplo: seat.

origin_airport

Tipo: cadena

Obligatorio.

Aeropuerto de origen del vuelo. Debe escribirse como un código IATA.

Ejemplo: SFO.

origin_city

Tipo: cadena

Opcional.

Nombre de la ciudad de origen del vuelo.

price

Tipo: cadena

Opcional.

Coste y divisa del vuelo. El precio es un número seguido del código de divisa; utiliza los estándares de la norma ISO 4217. Utiliza “.” como decimal para el precio.

url

Tipo: cadena

Opcional.

Enlace al sitio web en el que puedes reservar el vuelo.

El método UPDATE también puede utilizarse para crear artículos si no existen previamente.

Ejemplo de solicitud: FLIGHT

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "FLIGHT",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "origin_airport": "BOS",
          "destination_airport": "JFK",
        }
      },
      {
        "method": "CREATE",
        "data": {
          "origin_airport": "BOS",
          "destination_airport": "SFO",
          "description": "Best Flight to SFO",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['City'],
            },
            {
                "url":"http://example.com/some.image_2.jpg",
                "tag": ['Food'],
            }
          ],
          "price":"100.00 USD",
        }
      },
      {
        "method": "UPDATE",
        "data": {

Ejemplo de respuesta: FLIGHT

{
    // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
  }

DESTINATION

Estos campos de productos son compatibles con los métodos CREATE y UPDATE para el tipo DESTINATION, en la versión 3.2.

CampoDescripción

applink

Tipo:

objeto<string>

Opcional.

Enlaces a aplicaciones para móviles.

address

Tipo:

objeto<string>

Obligatorio.

Dirección del hotel.

description

Tipo: cadena

Opcional.

Límite de caracteres máximo: 5000.

Párrafo corto que describe el destino.

destination_id

Tipo: cadena

Obligatorio.

Límite máximo de caracteres: 100.

Identificador único del destino.

image

Tipo:

matriz<object>

Obligatorio.

Las URL y etiquetas de las imágenes que se utilizarán en los anuncios. Admite hasta 20 imágenes múltiples. La etiqueta es opcional y, cuando se utiliza, debe describir lo que hay en la imagen.

Ejemplo: seat.

latitude

Tipo: cadena

Obligatorio.

Latitud de la ubicación del destino.

longitude

Tipo: cadena

Obligatorio.

Longitud de la ubicación del destino.

name

Tipo: cadena

Obligatorio.

Nombre del destino.

neighborhood

Tipo:

matriz<string>

Opcional.

Número máximo de comunidades locales permitidas: 20. Una o varias comunidades locales para el destino.

Ejemplo: Soho o Las Vegas Strip.

price

Tipo: cadena

Opcional.

Coste medio más bajo y divisa del destino. El precio es un número seguido del código de divisa; utiliza los estándares de la norma ISO 4217. Utiliza “.” como decimal para el precio.

price_change

Tipo: cadena

Opcional.

Cambio de precio. Se puede utilizar para crear conjuntos de productos y en el contenido del anuncio:

  • 0: sin cambios de precio.
  • -10: reducción de un 10 % del precio.
  • 20: aumento de un 20 % del precio.

Ejemplo: “el precio medio de Nueva York disminuyó un X” o “el precio medio de Nueva York disminuyó”.

type

Tipo:

matriz<string>

Obligatorio.

Número máximo de tipos de destino: 20. Tipos de destino. Un destino puede tener varios tipos.

Ejemplo: park o beach.

url

Tipo: cadena

Obligatorio.

Enlace al sitio web en el que puedes reservar el destino.

El método UPDATE también puede utilizarse para crear artículos si no existen previamente.

Ejemplo de solicitud: DESTINATION

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "DESTINATION",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "destination_id": "destination-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "destination_id": "123456789",
          "description": "My destination is the best.",
          "name": "The best destination",
          "price": "199.00 USD",
          "price_change": "-20",
          "longitude":"-122.4424",
          "latitude":"37.7712",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['City','Package'],
            },
            {
                "url":"http://example.com/some.image_2.jpg",
                "tag": ['Tour','Landmark'],
            }
          ],
          "address": {
              "addr1":"1 Market Street",
              "city":"San Francisco",
              "region":"California",
              "country":"United States",
              "postal_code":"94117"
          },
          "applink" : {
            "ios_url":"example-ios://travelapp",
            "ios_app_store_id":"42",
            "ios_app_name":"Travel App iOS",
            "iphone_url":"example-iphone://travelapp",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Travel App iPhone",
            "ipad_url":"example-ipad://travelapp",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Travel App iPad",
            "android_url":"example-android://travelapp",
            "android_package":"com.travelapp",
            "android_class":"com.travelapp.Example",
            "android_app_name":"Travel App Android",
            "windows_phone_url":"example-windows://travelapp",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Travel App Windows",
          },
          "type":["city","culture"],
          "neighborhood":["Mission","SoMa"],
          "url":"http://www.thebestdestination.com"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "price": "159.99",
          "destination_id": "destination-3",
        }
      }
    ]
  }

Ejemplo de respuesta: DESTINATION

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

HOME_LISTING

Estos campos de productos son compatibles con los métodos CREATE y UPDATE para el tipo HOME_LISTING, en las versiones 3.3 y 3.2.

CampoDescripción

applink

Tipo:

objeto<string>

Opcional.

Enlaces a aplicaciones para móviles.

address

Tipo:

objeto<string>

Obligatorio.

Dirección postal del anuncio de vivienda.

availability

Tipo: cadena

Obligatorio.

Disponibilidad actual del anuncio de vivienda. Valores admitidos: for_sale, for_rent, sale_pending, recently_sold, off_market y available_soon.

available_dates_price_config

Tipo:

matriz<object>

Opcional.

Configuraciones de precios.

description

Tipo: cadena

Opcional.

Límite de caracteres máximo: 5000.

Párrafo corto que describe el anuncio de vivienda.

image

Tipo:

matriz<object>

Obligatorio.

Las URL y etiquetas de las imágenes que se utilizarán en los anuncios. Admite hasta 20 imágenes múltiples. La etiqueta es opcional y, cuando se utiliza, debe describir lo que hay en la imagen.

Ejemplo: pool.

latitude

Tipo: cadena

Opcional.

Latitud de la ubicación del anuncio de vivienda.

longitude

Tipo: cadena

Opcional.

Longitud de la ubicación del anuncio de vivienda.

listing_type

Tipo: cadena

Opcional.

Tipo de anuncio. Valores admitidos: for_rent_by_agent, for_rent_by_owner, for_sale_by_agent, for_sale_by_owner, foreclosed, new_construction y new_listing.

name

Tipo: cadena

Obligatorio.

Nombre del anuncio de vivienda.

neighborhood

Tipo:

matriz<object>

Opcional.

Comunidad local del anuncio de vivienda. Número máximo de comunidades locales permitidas: 20.

num_baths

Tipo: cadena

Opcional.

Número de baños.

num_beds

Tipo: cadena

Opcional.

Número de habitaciones.

num_units

Tipo: cadena

Opcional.

Número de unidades disponibles. Utilízalo solo para apartamentos o bloques disponibles para alquilar.

price

Tipo: cadena

Obligatorio.

Coste y divisa del anuncio de vivienda. El precio es un número seguido del código de divisa; utiliza los estándares de la norma ISO 4217. Utiliza “.” como decimal para el precio.

price_change

Tipo: cadena

Opcional.

Cambio de precio. Se puede utilizar para crear conjuntos de productos y en el contenido del anuncio:

  • 0: sin cambios de precio.
  • -10: reducción de un 10 % del precio.
  • 20: aumento de un 20 % del precio.

Ejemplo: “el precio medio de Nueva York disminuyó un X” o “el precio medio de Nueva York disminuyó”.

property_type

Tipo: cadena

Opcional.

Tipo de propiedad. Valores admitidos: apartment, condo, house, land, manufactured, other y townhouse.

url

Tipo: cadena

Obligatorio.

Enlace al sitio web en el que puedes ver el anuncio.

year_built

Tipo: cadena

Opcional.

Año de construcción de la vivienda.

El método UPDATE también puede utilizarse para crear artículos si no existen previamente.

Ejemplo de solicitud: HOME_LISTING

{
  "access_token": "<ACCESS_TOKEN>",
  "item_type": "HOME_LISTING",
  "requests": [
    {
      "method": "DELETE",
      "data": {
        "home_listing_id": "home-listing-1"
      }
    },
    {
      "method": "CREATE",
      "data": {
        "home_listing_id": "12345678",
        "availability": "for_sale",
        "description": "An amazing listing",
        "name": "1 Hacker Way, Menlo Park, CA 94025",
        "price": "110000 USD",
        "longitude":"1.11414",
        "latitude":"-1.835003",
        "address": {
            "addr1":"1 Hacker Way",
            "city":"Menlo Park",
            "region":"California",
            "country":"United States",
            "postal_code":"94025"
        },
        "neighborhood":["Menlo Oaks"],
        "image": [
          {
              "url":"http://img10.naventcdn.com/avisos/18/00/52/30/31/52/1200x1200/63590918.jpg",
          },
        ],
        "listing_type": "for_sale_by_agent",
        "num_baths":"6",
        "num_beds":"5",
        "num_units":"1",
        "property_type":"house",
        "year_built":"2007",
        "available_dates_price_config" : [
          {
              "start_date":"2020-11-15",
              "end_date":"2020-12-15",
              "rate":"10000",
              "currency":"USD",
              "interval":"nightly",
          },
          {
              "start_date":"2020-11-15",
              "end_date":"2020-12-15",
              "rate":"50000",
              "currency":"USD",
              "interval":"weekly",
          },
        ],
        "applink" : {
          "ios_url":"example-ios://travelapp",
          "ios_app_store_id":"42",
          "ios_app_name":"Travel App iOS",
          "android_url":"example-android://travelapp",
          "android_package":"com.travelapp",
          "android_class":"com.travelapp.Example",
          "android_app_name":"Travel App Android",
        },
        "url":"http://www.example.com/link_to_listing"
      }
    },
    {
      "method": "UPDATE",
      "data": {
        "price": "100000 USD",
        "home_listing_id": "home-listing-3",
      }
    }
  ]
}

Ejemplo de respuesta: HOME_LISTING

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

VEHICLE

Consulta los campos compatibles con los métodos CREATE y UPDATE para el tipo VEHICLE en Campos del catálogo de inventario de automóviles: Vehículo.

Los campos admitidos están disponible para los vehículos y los concesionarios.

El método UPDATE también puede utilizarse para crear artículos si no existen previamente.

Ejemplo de solicitud: VEHICLE

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "VEHICLE",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "vehicle_id": "vehicle-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "vehicle_id": "i2 2017 Ford Fusion",
          "availability": "AVAILABLE",
          "make": "Ford",
          "model": "Fusion",
          "year": "2017",
          "mileage": {
            "value": "1500",
            "unit": "KM",
          },
          "image": [
            {
                "url":"http://www.facebook.com/teapic.jpg",
                "tag":["Car"],
            },
          ],
          "fuel_type":"gasoline",
          "body_style":"sedan",
          "drivetrain":"FWD",
          "vin":"1FADP5AU6DL536022",
          "condition":"EXCELLENT",
          "description": "Turbocharged! Gasoline!",
          "title": "SE Ford Certified and 6-Speed Automatic.",
          "price": "18000 USD",
          "exterior_color":"white",
          "sale_price":"16000 USD",
          "state_of_vehicle":"new",
          "longitude":"52.35",
          "latitude":"42.1",
          "address": {
              "addr1":"550 Auto Center Dr",
              "city":"Watsonville",
              "region":"CA",
              "country":"US",
              "postal_code":"96075"
          },
          "url":"http://www.example.com/test"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "price": "16000 USD",
          "vehicle_id": "vehicle-3",
        }
      }
    ]
  }

Ejemplo de respuesta: VEHICLE

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

Campos admitidos: Enviar un lote de artículos localizados (/{catalog_id}/localized_items_batch)

Consulta la lista de campos admitidos y sus descripciones correspondientes del extremo /{catalog_id}/localized_items_batch:

Consulta la lista completa de los campos admitidos por el catálogo.

Más información