Cómo migrar los informes desde Content API for Shopping

Aquí te mostramos cómo puedes integrar la API de informes de comercios con tu implementación existente de Content API for Shopping.

Solicitudes

Use el siguiente formato de URL de solicitud para la API de informes de comerciantes:

POST https://merchantapi.googleapis.com/reports/v1beta/{parent}/reports:search

A continuación, se muestra una comparación de ejemplo de la Content API for Shopping con la API de Merchant Reports para solicitudes de search:

Content API API de Merchant Center
URL https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/reports/search https://merchantapi.googleapis.com/reports/v1beta/{parent}/reports:search
Identificadores {merchantId} {parent}

Métodos

Para consultar la API de informes de comercios, llama al método ReportService.Search.

Vistas

En la API de Merchant, los nombres de las tablas se cambian de CammelCase a snake_case.

MerchantPerformanceView ahora es product_performance_view

A continuación, se muestra una asignación entre los nombres de tablas en la Content API for Shopping y en la API de Merchant:

Content API API de Merchant Center
MerchantPerformanceView product_performance_view
ProductView product_view
PriceCompetitivenesProductView price_competitiveness_product_view
PriceInsightsProductView price_insights_product_view
BestSellersBrandView best_sellers_brand_view
BestSellersProductClusterView best_sellers_product_cluster_view
CompetitiveVisibilityCompetitorView competitive_visibility_competitor_view
CompetitiveVisibilityTopMerchantView competitive_visibility_top_merchant_view
CompetitiveVisibilityBenchmarkView competitive_visibility_benchmark_view

En la API de Merchant, ya no es necesario especificar un prefijo de campo, por ejemplo, segments.offer_id. En su lugar, solo usa el nombre del campo, offer_id.

A continuación, se muestra una comparación de ejemplo de las consultas en la Content API for Shopping y en la API de Merchant:

Content API API de Merchant Center
   SELECT
     segments.offer_id,
     metrics.clicks
   FROM MerchantPerformanceView
   WHERE segments.date DURING LAST_7_DAYS
   
   SELECT
     offer_id,
     clicks
   FROM product_performance_view
   WHERE date DURING LAST_7_DAYS
   

Esta es una respuesta de ejemplo:

Content API API de Merchant Center
{
  "segments":{
    "offerId":"abc"
  },
  "metrics":{
    "clicks":"123"
  }
}
{
  "productPerformanceView" : {
    "offerId": "abc",
    "clicks": "123"
  }
}

El nombre de la tabla se puede usar como un prefijo de campo. Por ejemplo, tanto offer_id como product_performance_view.offer_id se aceptan en la consulta de la API de Merchant.

Rendimiento

A continuación, se muestran los cambios en la vista de rendimiento de la API de informes de comerciantes:

Content API API de Merchant Center Descripción
segments.program: string marketing_method: string Se reemplazó el segmento program por un nuevo campo marketing_method. Consulta los nuevos valores marketing method para obtener más detalles.
metrics.ctr: doble clickThroughRate: doble Se cambió el nombre de la métrica ctr por clickThroughRate
metrics.conversionValueMicros: número entero
segments.currencyCode: cadena
conversionValue: {
object (Price)
}
Los campos de micros y moneda de importe se combinan en un campo con el tipo Price.
metrics.orders,
metrics.orderedItems,
No se permite Las métricas de Comprar con Google no se admiten en la API de informes de comercios

Valores de los nuevos métodos de marketing

Esta es la asignación entre los valores segments.program y marketing_method:

Content API API de Merchant Center
SHOPPING_ADS ADS
FREE_PRODUCT_LISTING ORGANIC
FREE_LOCAL_PRODUCT_LISTING ORGANIC
BUY_ON_GOOGLE_LISTING No se permite

Producto

Esto es lo que cambió en la vista de productos de la API de informes del comerciante:

Content API API de Merchant Center Descripción
productView.id: string id: string El formato del campo cambia de channel:language:targetCountry:offerId a
channel~language~feedLabel~offerId
productView.priceMicros: número entero
productView.currencyCode: cadena
price: {
object (Price)
}
Los campos de micros y moneda de importe se combinan en un campo con el tipo Price.
productView.aggregated_destination_status: string aggregated_reporting_context_status: string Se cambió el nombre del campo aggregated_destination_status a aggregated_reporting_context_status; los valores no se modificaron
productView.item_issues: [
{
object (ItemIssue)
}
]
item_issues: [
{
object (ItemIssue)
}
]
La definición de ItemIssue cambió
No se permite feedLabel: string Se introdujo el campo feedLabel

Información sobre precios

A continuación, se muestran los cambios en la vista de estadísticas de precios en la API de informes de comerciantes:

Content API API de Merchant Center Descripción
productView.id: string id: string El formato del campo cambia de channel:language:targetCountry:offerId a channel~language~feedLabel~offerId
productView.priceMicros: número entero
productView.currencyCode: cadena
price: {
object (Price)
}
Los campos de micros y moneda de importe se combinan en un campo con el tipo Price.
priceInsights.suggestedPriceMicros: número entero
priceInsights.suggestedPriceCurrencyCode: cadena
suggestedPrice: {
object (Price)
}
Los campos de micros y moneda de importe se combinan en un campo con el tipo Price.
priceInsights.predictedGrossProfitChangeFraction: doble
priceInsights.predictedMonthlyGrossProfitChangeMicros: número entero
priceInsights.predictedMonthlyGrossProfitChangeCurrencyCode: cadena
No se permite Los campos relacionados con el cambio de las ganancias brutas no se admiten en la API de informes de comerciantes

Competitividad de precios

Esto es lo que cambió en la vista de competitividad de los precios en la API de informes de comercios:

Content API API de Merchant Center Descripción
productView.id: string id: string El formato del campo cambia de channel:language:targetCountry:offerId a channel~language~feedLabel~offerId
productView.priceMicros: número entero
productView.currencyCode: cadena
price: {
object (Price)
}
Los campos de micros y moneda de importe se combinan en un campo con el tipo Price.
priceCompetitiveness.countryCode: string reportCountryCode: string Se cambió el nombre del campo countryCode por reportCountryCode
priceCompetitiveness.benchmarkPriceMicros: número entero
priceCompetitiveness.benchmarkPriceCurrencyCode: cadena
benchmarkPrice: {
object (Price)
}
Los campos de micros y moneda de importe se combinan en un campo con el tipo Price.

Los más vendidos

Esto es lo que cambió en las vistas de los más vendidos en la API de informes de comerciantes:

Content API API de Merchant Center Descripción
bestSellers.countryCode: string reportCountryCode: string Se cambió el nombre del campo countryCode por reportCountryCode
bestSellers.categoryId: Número entero reportCategoryId: Número entero Se cambió el nombre del campo categoryId por reportCategoryId

Visibilidad respecto de la competencia

Esto es lo que cambió en las vistas de visibilidad respecto a la competencia en la API de informes de comerciantes:

Content API API de Merchant Center Descripción
competitiveVisibility.countryCode: string reportCountryCode: string Se cambió el nombre del campo countryCode por reportCountryCode
competitiveVisibility.categoryId: Número entero reportCategoryId: Número entero Se cambió el nombre del campo categoryId por reportCategoryId