Almacenar recurso

Artículo
11/13/2024

Nota:

El recurso De la Tienda solo está disponible para los participantes de la versión beta cerrada. Para obtener información sobre cómo participar en el programa closed-beta o open-beta, póngase en contacto con el administrador de cuentas.

Todos los elementos de programación y la documentación de la Tienda están sujetos a cambios durante la versión beta.

Use el recurso De la Tienda para administrar los almacenes propiedad del usuario. Puede agregar tiendas, obtener una tienda específica o obtener todas las tiendas propiedad del usuario. Más información.

Base URI

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

https://content.api.ads.microsoft.com/v9.1/bmc

Por ejemplo, para agregar un almacén u obtener una lista de almacenes propiedad del usuario, use el siguiente punto de conexión:

https://content.api.ads.microsoft.com/v9.1/bmc/stores

Plantillas

Estas son las plantillas que anexa al URI base para crear un punto de conexión HTTP.

Plantilla /stores

Verbo HTTP	Descripción	Recurso
POST	Agrega un almacén. Se aplican los límites siguientes y están sujetos a cambios: Un cliente puede agregar un máximo de 14 almacenes que especifiquen la misma dirección URL de almacén. Un cliente puede agregar un máximo de 1024 tiendas.	Solicitud: StoreCreate Respuesta: Almacenar
GET	Obtiene una lista de almacenes propiedad del usuario.	Solicitud: N/A Respuesta: StoreCollection

Plantilla /stores/{merchantId}

Verbo HTTP	Descripción	Recurso
GET	Obtiene el almacén especificado. Establezca `{merchantId}` en el identificador de la tienda que desea obtener.	Solicitud: N/A Respuesta: Almacenar

Parámetros de consulta

La solicitud puede incluir los siguientes parámetros de consulta:

Parámetro	Descripción
dry-run	Opcional. Use para probar o depurar la aplicación. Las llamadas que incluyen este parámetro no afectarán a los datos de producción (no se agregan almacenes); sin embargo, la respuesta contendrá los errores que genere la llamada. Tenga en cuenta las siguientes limitaciones al usar este parámetro. Las operaciones de adición no devuelven identificadores. El servicio no genera ni devuelve mensajes de error secundarios, como la calidad de los datos, los problemas editoriales y las validaciones relacionadas con la base de datos. Para obtener más información sobre cómo probar la aplicación, consulte Espacio aislado.

Parámetro

Descripción

dry-run

Opcional. Use para probar o depurar la aplicación. Las llamadas que incluyen este parámetro no afectarán a los datos de producción (no se agregan almacenes); sin embargo, la respuesta contendrá los errores que genere la llamada.

Tenga en cuenta las siguientes limitaciones al usar este parámetro.

Las operaciones de adición no devuelven identificadores.
El servicio no genera ni devuelve mensajes de error secundarios, como la calidad de los datos, los problemas editoriales y las validaciones relacionadas con la base de datos.

Para obtener más información sobre cómo probar la aplicación, consulte Espacio aislado.

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 acceso de OAuth. Para obtener información sobre cómo obtener un token de acceso, consulte Autenticación de sus credenciales.
Content-Type	Encabezado de solicitud. Todas las solicitudes POST deben especificar este encabezado y debe establecerse en `application/json`.
CustomerAccountId	Encabezado de solicitud. El identificador de cuenta de cualquier cuenta que administre 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 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?
WebRequestActivityId	Encabezado de respuesta. Identificador de la entrada de registro que contiene los detalles de 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.

Objeto	Descripción
Error	Define un error.
ErrorResponse	Define el objeto de error de nivel superior.
Almacén	Define una tienda en Microsoft Merchant Center.
StoreCollection	Define una colección de tiendas en Microsoft Merchant Center.
StoreCreate	Define una tienda que se va a agregar a Microsoft Merchant Center.
StoreStatus	Define el estado del almacén.

Error

Define un error.

Nombre	Valor	Tipo
código	Motivo por el que se produjo un error en la solicitud. Por ejemplo, el código es InvalidStoreNameErr si el `storeName` campo no pudo validarse.	Cadena
mensaje	Una descripción del error.	Cadena

ErrorResponse

Define el objeto de error de nivel superior.

Nombre	Valor	Tipo
errores	Lista de errores que se produjeron al procesar la solicitud.	Error[]

Tienda

Define una tienda en Microsoft Merchant Center.

Nombre	Valor	Tipo
isBlockAggregator	Valor booleano que indica si quieres evitar que los agregadores sirvan anuncios de tu tienda. Los agregadores consolidan las ofertas de productos de varias empresas, a menudo no relacionadas. De forma predeterminada, los agregadores pueden incluir el catálogo en sus anuncios. Es true si quieres evitar que tus productos aparezcan en los anuncios de agregadores en Bing. Si tiene dos almacenes (uno para el Estados Unidos y otro para el Reino Unido) que usan http://www.contoso.com y uno de ellos bloquea los agregadores, ambos almacenes los agregadores de bloques.	Booleano
isSslCheckout	Valor booleano que indica si el almacén está habilitado para SSL. Todos los almacenes deben tener páginas de inicio de sesión y desprotección de SSL. Es true si el sitio web de la tienda está habilitado para SSL.	Booleano
merchantId	El identificador de la tienda.	Unsigned long
notificationEmail	Lista de destinatarios para recibir correos electrónicos de notificación. Los correos electrónicos le notifican cuándo se aprueba el almacén o si hay errores de validación con el almacén.	Cadena[]
notificationLanguage	Idioma usado para escribir los correos electrónicos de notificación. El idioma está en el formato, <país-idioma>< o región>. Por ejemplo, en-US.	String
storeDescription	Descripción que describe el uso del almacén.	String
storeName	Nombre del almacén.	String
storeStatus	Estado de la tienda.	StoreStatus
storeUrl	Dirección URL de destino del almacén. La dirección URL de destino es la página web a la que se dirige a las personas cuando hacen clic en el anuncio.	String

StoreCollection

Define una lista de almacenes.

Nombre	Valor	Tipo
Tiendas	Lista de almacenes propiedad del usuario.	Store[]

StoreCreate

Define una tienda que se va a agregar a Microsoft Merchant Center.

Nombre	Valor	Tipo	Obligatorio
isBlockAggregator	Valor booleano que indica si quieres evitar que los agregadores sirvan anuncios de tu tienda. Los agregadores consolidan las ofertas de productos de varias empresas, a menudo no relacionadas. De forma predeterminada, los agregadores pueden incluir el catálogo en sus anuncios. Establézcalo en true para evitar que los productos se muestren en los anuncios de agregadores en Bing. Si tiene dos almacenes (uno para el Estados Unidos y otro para el Reino Unido) que usan http://www.contoso.com y uno de ellos bloquea los agregadores, ambos almacenes los agregadores de bloques. Valores predeterminados de falso.	Booleano	No
isSslCheckout	Valor booleano que indica si el almacén está habilitado para SSL. Todos los almacenes deben tener páginas de inicio de sesión y desprotección de SSL. Establézcalo en true si el sitio web de la tienda está habilitado para SSL. Si es false , se desaproba el almacén. Valores predeterminados de verdadero.	Booleano	No
notificationEmail	Lista de destinatarios para recibir correos electrónicos de notificación. Los correos electrónicos le notifican cuándo se aprueba el almacén o si hay errores de validación con el almacén. El número máximo de direcciones de correo electrónico que puede especificar es 14.	Cadena[]	Sí
notificationLanguage	Idioma usado para escribir los correos electrónicos de notificación. El idioma está en el formato, <país-idioma>< o región>. A continuación se muestran los posibles valores que no distinguen mayúsculas de minúsculas que puede especificar. en-US (inglés Estados Unidos) en-AU (Inglés-Australia) en-GB (Inglés-Reino Unido) fr-FR (Francés-Francia) de-DE (Alemania-Alemania) ja-JP (Japonés-Japón)	Cadena	Sí
storeDescription	Descripción que describe el uso del almacén. La descripción está limitada a un máximo de 350 caracteres y solo puede contener caracteres alfanuméricos ([a-zA-Z0-9]).	Cadena	No
storeName	Nombre del almacén. Dado que el nombre de la tienda aparece en los anuncios de producto, asegúrate de usar un nombre que represente con precisión tu sitio web. El nombre debe: Ser único en Bing Merchant Center No contener más de 70 caracteres Contener solo caracteres alfanuméricos ([a-zA-Z0-9])	Cadena	Sí
storeUrl	Dirección URL de destino del almacén. La dirección URL de destino es la página web a la que se dirige a las personas cuando hacen clic en el anuncio. La dirección URL no debe redirigirse a otra ubicación. La dirección URL debe tener un formato correcto y tener un máximo de 1024 caracteres. Debe comprobar y reclamar la dirección URL del sitio web. Las tiendas no se aprueban si Microsoft no puede comprobar que el sitio web es compatible con SSL. Los sitios web de comerciantes deben tener páginas de inicio de sesión y de compra de SSL. Compruebe que los certificados SSL son válidos.	Cadena	Sí

StoreStatus

Define el estado del almacén.

Nombre	Valor	Tipo
mensaje	La razón por la que la tienda fue desaprobada. El objeto incluye este campo solo si `status` está Desaprobado.	Cadena
status	Estado de la tienda. A continuación se muestran los valores posibles. Aprobado Desaprobó ManualReview Si la tienda no está aprobada, consulte `message` el motivo. Un almacén que se aprobó inicialmente automáticamente puede pasar de Aprobado a ManualReview. No puedes agregar productos a una tienda que esté bajo revisión manual y los productos de la tienda no servirán. En función del motivo de desaprobación, es posible que pueda corregir el problema mediante la aplicación Microsoft Ads. De lo contrario, tendrá que crear un nuevo almacén con los valores adecuados.	Cadena

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	La tienda se agregó correctamente.
400	Solicitud incorrecta. Lo más probable es que el cuerpo de la solicitud POST contenga datos no válidos o tenga un formato incorrecto.
401	No autorizado. Las credenciales del usuario no son válidas.
404	No encontrado. No se encontró el almacén solicitado.
500	Error del servidor.

Códigos de error

Las solicitudes pueden devolver los siguientes códigos de error.

Código de error	Descripción
AdultAdvertiserErr	Es posible que los anunciantes adultos no creen tiendas.
DomainNotOwnedByCustomerErr	El dominio especificado en el campo storeUrl no es propiedad del cliente. Asegúrese de que el cliente ha comprobado que es el propietario del dominio.
DuplicateStoreNameErr	Existe otro almacén con el nombre de almacén especificado; los nombres de tienda deben ser únicos con Microsoft Merchant Center.
ExceededMaxStoresForCustomerErr	El cliente superó el número de tiendas que puede crear. Para conocer los límites, consulte Agregar post de tienda.
ExceededMaxStoresForDestinationUrlErr	El cliente superó el número de almacenes que puede crear con la misma dirección URL de destino. Para conocer los límites, consulte Agregar post de tienda.
InvalidStoreDescriptionErr	La descripción del almacén no es válida. Para conocer los límites, consulte storeDescription.
InvalidStoreDestinationUrlErr	La dirección URL de destino del almacén que especificó en el campo storeUrl no es válida.
InvalidStoreNameErr	El nombre del almacén no es válido. Para conocer los límites, vea storeName.
MarketNotSupportedErr	El mercado especificado en el campo notificationLanguage no es válido.
NoDomainsFoundForCustomerErr	No hay dominios comprobados propiedad del cliente.

Compartir a través de