Recurso ProductStatuses

Article
12/21/2023

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 ProductStatuses para obtener el estado de las ofertas de productos en una tienda.

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 obtener una vista de resumen del estado de las ofertas de productos en una tienda, use el siguiente punto de conexión:

https://content.api.ads.microsoft.com/v9.1/bmc/stores/{merchantId}/productstatusessummary

Plantillas

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

/stores/{merchantId}/productstatusessummary

Verbo HTTP	Descripción	Recurso
Obtener	Obtiene una vista de resumen del estado de las ofertas de productos en una tienda. El servicio devuelve el número de ofertas aprobadas, desaprobadas y que expiran en el almacén. Establézcalo `{merchantId}` en el identificador del almacén desde el que obtener los estados. Puede tardar hasta dos horas desde el momento en que el estado de una oferta cambia al momento en que se refleja en la vista de resumen.	Solicitud: N/A Respuesta: ProductStatusesSummary

/stores/{merchantId}/productstatuses

Verbo HTTP	Descripción	Recurso
Obtener	Obtiene una vista detallada del estado de las ofertas de productos en una tienda. Los detalles solo se devuelven para los productos con un estado Desaprobado o Advertencia. Establezca `{merchantId}` en el identificador del almacén del que desea obtener los estados. El parámetro de consulta max-results determina el número de ofertas que devuelve el servicio. Para paginar todas las ofertas, use el parámetro de consulta continuation-token .	Solicitud: N/A Respuesta: ProductStatuses

Parámetros de consulta

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

Parámetro Descripción

max-results Opcional. Use para especificar el número máximo de elementos que se devolverán en una solicitud List, como /stores/{merchantId}/productstatuses. El valor máximo que puede especificar es 250. El valor predeterminado es 25.

continuation-token Opcional. Use para paginar la lista de estados de producto de una tienda. El token identifica la siguiente página de estados de producto que se van a devolver. No especifique este parámetro en la primera solicitud List. Si el almacén contiene más del número solicitado de productos (consulte el parámetro de consulta max-results ), la respuesta incluye el nextPageToken campo . En la siguiente solicitud, establezca continuation-token en el valor del token en nextPageToken.

Parámetro	Descripción
max-results	Opcional. Use para especificar el número máximo de elementos que se devolverán en una solicitud List, como `/stores/{merchantId}/productstatuses`. El valor máximo que puede especificar es 250. El valor predeterminado es 25.
continuation-token	Opcional. Use para paginar la lista de estados de producto de una tienda. El token identifica la siguiente página de estados de producto que se van a devolver. No especifique este parámetro en la primera solicitud List. Si el almacén contiene más del número solicitado de productos (consulte el parámetro de consulta max-results ), la respuesta incluye el `nextPageToken` campo . En la siguiente solicitud, establezca continuation-token en el valor del token en `nextPageToken`.

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.
ProductStatus	Define el estado de una oferta de producto.
ProductStatuses	Define una lista de las ofertas de productos que tienen problemas.
ProductStatusesSummary	Define una vista de resumen del estado de las ofertas de productos en una tienda.
ProductStatusItemLevelIssue	Define un problema con la oferta del producto.

Error

Define un error.

Nombre	Valor	Tipo
código	Motivo por el que se produjo un error en la solicitud.	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[]

ProductStatus

Define el estado de una oferta de producto.

Nombre	Valor	Tipo
creationDate	Fecha y hora en que se creó la oferta de producto.	DateTime
expirationDate	Fecha y hora en que la oferta de producto está establecida para expirar.	DateTime
itemLevelIssues	Lista de problemas con la oferta del producto.	ProductStatusItemLevelIssue[]
lastUpdateDate	Fecha y hora en que se actualizó por última vez la oferta de producto.	DateTime
Productid	El identificador del producto.	Cadena
status	Estado de aprobación del producto. Los posibles valores son: Desaprobó Advertencia Los productos no aprobados no se sirven. Las advertencias indican que el producto tiene problemas que debe solucionar, pero no impiden que la oferta del producto sirva. Debe corregir los problemas y volver a enviar la oferta del producto.	Cadena
title	El título del producto	Cadena

ProductStatuses

Define una lista de las ofertas de productos que tienen problemas.

Nombre	Valor	Tipo
nextPageToken	Token para establecer el parámetro de consulta de token de continuación en si hay más ofertas de productos disponibles para obtener.	Cadena
recursos	La lista de ofertas de productos que tienen problemas. El parámetro de consulta max-results determina el número máximo de ofertas de la lista; el número real devuelto puede ser menor.	ProductStatus[]

ProductStatusesSummary

Define una vista de resumen del estado de las ofertas de productos en una tienda. Si el almacén se acaba de crear, todos los valores serán cero.

Nombre	Valor	Tipo
Aprobado	El número total de productos de la tienda aprobados.	Entero
Desaprobó	Número total de productos de la tienda que no se aprueban debido a errores.	Entero
Expirar	El número total de productos de la tienda que expirarán en las próximas 72 horas.	Entero
merchantId	El identificador de la tienda en la que se encuentran los productos.	Unsigned long
Pendiente	Número total de productos pendientes de revisión.	Entero

ProductStatusItemLevelIssue

Define un problema con la oferta del producto.

Nombre	Valor	Tipo
attributeName	Nombre de la propiedad de la oferta de producto que está causando el problema. No todos los problemas identifican una propiedad. Por ejemplo, el objeto no incluye este campo si el problema se debe a más de una propiedad.	Cadena
código	Código de error que identifica el problema. Por ejemplo, TitleTooLongErr.	Cadena
description	Descripción que explica el problema con la propiedad .	Cadena
servability	Valor que indica si el problema impide que la oferta sirva. Los posibles valores son: Desaprobó Inafectado Si no se aprueba, la oferta no servirá.	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.
400	Solicitud incorrecta. Lo más probable es que la solicitud especifique un parámetro de consulta o un valor de parámetro no válidos.
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
ContinuationTokenInvalidErr	El valor del parámetro de consulta de token de continuación no es válido. Asegúrese de establecer el parámetro con el valor en el campo del `nextPageToken` objeto ProductStatuses.

Comparteix a través de