Recurso catálogos

  • Artículo

El recurso Catálogos le permite administrar catálogos en la tienda microsoft Merchant Center (MMC). Para obtener información sobre el uso de los recursos de catálogos, consulte Administración de los catálogos. Para obtener ejemplos que muestran cómo agregar, eliminar y obtener catálogos, vea Ejemplos de código.

Base URI

El siguiente es el URI base al que anexa las plantillas.

https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/

Plantillas

Para crear los puntos de conexión que se usan para administrar los catálogos, anexe la plantilla adecuada al URI base.

Plantilla Verbo HTTP Descripción Recurso
{mmcMerchantId}/catalogs POST Use para agregar un catálogo a la tienda. Para agregar un catálogo, su nombre debe ser único. Puede agregar un máximo de 100 catálogos a una tienda.

Establézcalo {mmcMerchantId} en el identificador de almacén de MMC.		 Solicitud: Catálogo
Respuesta: Catálogo
{mmcMerchantId}/catalogs/{catalogId} PUT Use para actualizar un catálogo en el almacén. Los únicos campos que puede actualizar son los name campos y isPublishingEnabled y debe especificar ambos.

Establézcalo {mmcMerchantId} en el identificador de almacén de MMC.		 Solicitud: Catálogo
Respuesta: Catálogo
{mmcMerchantId}/catalogs/{catalogId} DELETE Use para eliminar un catálogo del almacén.

Establézcalo {mmcMerchantId} en el identificador de almacén de MMC.

Establezca {catalogId} en el identificador del catálogo.		 Solicitud: N/A
Respuesta: N/A
{mmcMerchantId}/catalogs/{catalogId} GET Use para obtener un catálogo de la tienda.

Establézcalo {mmcMerchantId} en el identificador de almacén de MMC.

Establezca {catalogId} en el identificador del catálogo.		 Solicitud: N/A
Respuesta: Catálogo
{mmcMerchantId}/catalogs GET Use para obtener una lista de catálogos de la tienda.

Establézcalo {mmcMerchantId} en el identificador de almacén de MMC.		 Solicitud: N/A
Respuesta: Catálogos

Parámetros de consulta

Los puntos de conexión pueden incluir los siguientes parámetros de consulta.

Parámetro Descripción
alt Opcional. Use para especificar el tipo de contenido que se usa en la solicitud y la respuesta. Los valores posibles son json y xml. El valor predeterminado es json.

Encabezados

A continuación se muestran los encabezados de solicitud y respuesta.

Encabezado Descripción
AuthenticationToken Encabezado de solicitud.

Establezca este encabezado en un token de autenticación de OAuth. Para obtener información sobre cómo obtener un token, consulte Autenticación de las credenciales.
Ubicación del contenido Encabezado de respuesta.

Dirección URL que identifica el almacén en el que se insertó el catálogo. Este encabezado se incluye en la respuesta de una solicitud Insert.
CustomerAccountId Encabezado de solicitud.

Identificador de cuenta de cualquiera de las cuentas que administra en nombre del cliente especificado en el CustomerId encabezado. No importa qué cuenta especifique. Especifique este encabezado solo si administra una cuenta en nombre del cliente.
Customerid Encabezado de solicitud.

El identificador de cliente del cliente cuya tienda administra. Especifique este encabezado solo si administra la tienda en nombre del cliente. Si establece este encabezado, también debe establecer el CustomerAccountId encabezado.
DeveloperToken Encabezado de solicitud.

Token de acceso de desarrollador de la aplicación cliente. Cada solicitud debe incluir este encabezado. Para obtener información sobre cómo obtener un token, consulte ¿Tiene sus credenciales de Microsoft Advertising y el token de desarrollador?
Ubicación Encabezado de respuesta.

Dirección URL que identifica el almacén en el que se insertó el catálogo. Este encabezado se incluye en la respuesta de una solicitud Insert.
WebRequestActivityId Encabezado de respuesta.

Identificador de la entrada de registro que contiene detalles sobre la solicitud. Siempre debe capturar este identificador si se produce un error. Si no puede determinar y resolver el problema, incluya este identificador junto con la otra información que proporcione al equipo de soporte técnico.

Objetos de solicitud y respuesta

A continuación se muestran los objetos de solicitud y respuesta que usa la API.

Cada objeto define el nombre de clave JSON y el nombre del elemento XML que se usan en función del tipo de contenido que especifique para la solicitud.

Objeto Descripción
Catálogo Define un catálogo.
Catálogos Define la lista de catálogos.

Catalog

Define un catálogo.

Nombre Valor Tipo Nombre del elemento XML
Id Identificador que identifica de forma única el catálogo en el almacén.

Este campo es de solo lectura; no establezca este campo.		 Unsigned Long <Id>
isDefault Valor booleano que determina si el catálogo es el catálogo predeterminado del almacén. Es true si el catálogo es el catálogo predeterminado de la tienda; De lo contrario, false.

Al crear una tienda, obtiene un catálogo predeterminado en el que se escriben los productos si no especifica otro catálogo.

Este campo es de solo lectura; no establezca este campo.		 Booleano <is_default>
isPublishingEnabled Valor booleano que determina si Microsoft puede publicar productos del catálogo. Establézcalo en true si Microsoft puede publicar productos del catálogo; De lo contrario, establézcalo en false.

Puede actualizar este campo.

También puede usar este campo para probar la aplicación antes de implementarla en producción. Al establecer este campo en false, puede realizar llamadas a recursos de productos sin cambiar ni publicar los datos de producción.		 Booleano <is_publishing_enabled>
Mercado Mercado en el que se publican los productos del catálogo.

NOTA: Todavía no todos tienen esta característica. Si no lo haces, no te preocupes, ¡próximamente!.

A continuación se muestran los posibles mercados que puede especificar.
  • Albania, Albanés (sq-AL)
  • Andorra, francés (fr-AD)
  • Argentina, español (es-AR)
  • Aruba, inglés (en-AW)
  • Australia, Inglés (en-AU)
  • Austria, Alemán (de-AT)
  • Bahamas, Inglés (en-BS)
  • Bangladesh, inglés (en-BD)
  • Bélgica, Neerlandés (nl-BE)
  • Bélgica, francés (fr-BE)
  • Bolivia, español (es-BO)
  • Bosnia y Herzegovina, Bosnia (bs-BA)
  • Brasil, Portugués (pt-BR)
  • Brunei, Inglés (en-BN)
  • Bulgaria, búlgara (bg-BG)
  • Canadá, inglés (en-CA)
  • Canadá, francés (fr-CA)
  • Islas Caimán, Inglés (en-KY)
  • Chile, español (es-CL)
  • Colombia, español (es-CO)
  • Costa Rica, Español (es-CR)
  • Croacia, Croata (hr-HR)
  • Chipre, inglés (en-CY)
  • Chipre, Griego (el-CY)
  • República Checa, Checo (cs-CZ)
  • Dinamarca, Danés (da-DK)
  • Dominica, Inglés (en-DM)
  • República Dominicana, Español (es-DO)
  • Ecuador, español (es-CE)
  • El Salvador, Español (es-SV)
  • Estonia, Estonia (et-EE)
  • Fiji, Inglés(en-FJ)
  • Finlandia, Finlandia (fi-FI)
  • Francia, inglés (en-FR)
  • Francia, francés (fr-FR)
  • Guayana Francesa, Francés (fr-GF)
  • Polinesia Francesa, Francés (fr-PF)
  • Alemania, inglés (en-DE)
  • Alemania, Alemán (de-DE)
  • Grecia, Inglés (en-GR)
  • Grecia, Griego (el-GR)
  • Guam, inglés (en-GU)
  • Guatemala, español (es-GT)
  • Guyana, Inglés (en-GY)
  • Haití, Francés (fr-HT)
  • Honduras, Español (es-HN)
  • RAE de Hong Kong, Chino tradicional (zh-HK)
  • Hungría, inglés (en-HU)
  • Hungría, Hungría (hu-HU)
  • Islandia, Islandia (is-IS)
  • India, inglés (en-IN)
  • Indonesia, inglés (en-ID)
  • Irlanda, inglés (en-IE)
  • Italia, inglés (en-IT)
  • Italia, italiano (it-IT)
  • Japón, Japonés (ja-JP)
  • Letonia, Letonia (lv-LV)
  • Liechtenstein, Alemán (de-LI)
  • Lituania, Lituania (lt-LT)
  • Luxemburgo, francés (fr-LU)
  • Luxemburgo, alemán (de-LU)
  • Malasia, inglés (en-MY)
  • Maldivas, Inglés (en-MV)
  • Malta, Maltés (mt-MT)
  • Martinica, francés (fr-MQ)
  • México, español (es-MX)
  • Mónaco, francés (fr-MC)
  • Mongolia, inglés (en-MN)
  • Montenegro, inglés (en-ME)
  • Montenegro, Serbio (sr-ME)
  • Montserrat, Inglés (en-MS)
  • Nepal, inglés (en-NP)
  • Países Bajos, Neerlandés (nl-NL)
  • Países Bajos, Inglés (el-NL)
  • Nueva Caledonia, Francés (fr-NC)
  • Nueva Zelanda, Inglés (en-NZ)
  • Macedonia del Norte, Macedonia (mk-MK)
  • Noruega, Noruega (nb-NO)
  • Panamá, español (es-PA)
  • Papúa Nueva Guinea, Inglés (en-PG)
  • Paraguay, Español (es-PY)
  • Perú, español (es-PE)
  • Phillippines, Inglés (en-PH)
  • Polonia, Polonia (pl-PL)
  • Portugal, portugués (pt-PT)
  • Puerto Rico, Español (es-PR)
  • Rumania, Rumanía (ro-RO)
  • San Marino, Inglés (en-SM)
  • San Marino, italiano (it-SM)
  • Serbia, inglés (en-RS)
  • Serbia, serbia (sr-RS)
  • Singapur, inglés (en-SG)
  • Eslovaquia, inglés (en-SK)
  • Eslovaquia, Eslovaquia (sk-SK)
  • Eslovenia, Eslovenia (sl-SI)
  • Sudáfrica, inglés (en-ZA)
  • España, inglés (en-ES)
  • España, español (es-ES)
  • Sri Lanka, Inglés (en-LK)
  • Suecia, inglés (en-SE)
  • Suecia, Sueco (sv-SE)
  • Suiza, alemán (de-CH)
  • Suiza, francés (fr-CH)
  • Taiwán, chino tradicional (zh-TW)
  • Tailandia, inglés (en-TH)
  • Trinidad y Tobago, inglés (en-TT)
  • Türkiye, turco (tr-TR)
  • Reino Unido, Inglés (en-GB)
  • Estados Unidos, inglés (en-US)
  • Estados Unidos, español (es-US)
  • Uruguay, Español (es-UY)
  • Ciudad del Vaticano, Italiano (it-VA)
  • Venezuela, español (es-VE)
  • Vietnam, inglés (en-VN)
Todos los productos que agregue al catálogo deben especificar el mismo mercado (vea contentLanguage y targetCountry).

Es posible que no actualice este campo después de agregar el catálogo al almacén.

En la lista anterior, de-DE es el valor de mercado que especifique; no incluya (Alemania-Alemania) en su cadena de mercado.		 Cadena <Mercado>
Nombre Nombre del catálogo. El nombre puede contener un máximo de 70 caracteres.

Puede actualizar este campo.		 Cadena <Nombre>

Catálogos

Define una lista de catálogos.

Nombre Valor Tipo Nombre del elemento XML
Catálogos Lista de catálogos de la tienda. Catalog[] <Catálogos>

Códigos de estado HTTP

Las solicitudes pueden devolver los siguientes códigos de estado HTTP.

Código de estado Descripción
200 Correcto.
201 Se agregó correctamente el catálogo.
204 Eliminó correctamente el catálogo.
400 Solicitud incorrecta. Un valor de parámetro de consulta no es válido o algo en el cuerpo de la solicitud no es válido.
401 No autorizado. Las credenciales del usuario no son válidas.
404 No encontrado.
500 Error del servidor.