Migrar relatórios da API Content for Shopping

Use a API Merchant Reports para saber mais sobre seus produtos, a performance deles e o ambiente competitivo no Google com a visualização de dados que ela oferece.

Você pode usar a API Merchant Reports para fazer o seguinte:

Saiba como integrar a API Merchant Reports à sua implementação atual da API Content for Shopping.

Solicitações

Use o seguinte formato de URL de solicitação para a API Merchant Reports:

POST https://merchantapi.googleapis.com/reports/v1/{PARENT}/reports:search

Confira um exemplo de comparação entre a API Content for Shopping e a API Merchant Reports para solicitações search:

API Content API Merchant
URL https://shoppingcontent.googleapis.com/content/v2.1/{MERCHANT_ID}/reports/search https://merchantapi.googleapis.com/reports/v1/{PARENT}/reports:search
Identificadores {MERCHANT_ID} {PARENT}

Métodos

Para consultar a API Merchant Reports, chame o método ReportService.Search.

Visualizações

Na API Merchant, os nomes das tabelas mudaram de CamelCase para snake_case.

MerchantPerformanceView agora é product_performance_view

Confira um mapeamento entre os nomes das tabelas na API Content for Shopping e na API Merchant:

API Content API Merchant
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

Na API Merchant, não é mais necessário especificar um prefixo de campo, por exemplo, segments.offer_id. Em vez disso, use apenas o nome do campo, offer_id.

Confira um exemplo de comparação de consultas na API Content do Shopping e na API Merchant:

API Content API Merchant 
   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

Veja um exemplo de resposta:

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

O nome da tabela pode ser usado como um prefixo de campo. Por exemplo, offer_id e product_performance_view.offer_id são aceitos na consulta da API Merchant.

Desempenho

Confira o que mudou na visualização de performance da API Merchant Reports:

API Content API Merchant Descrição
segments.program: string marketing_method: string O segmento program foi substituído por um novo campo marketing_method. Consulte os novos valores de marketing method para mais detalhes.
metrics.ctr: double clickThroughRate: double A métrica ctr foi renomeada como clickThroughRate.
metrics.conversionValueMicros: integer
segments.currencyCode: string 		conversionValue: {
object (Price)
} 		Os campos de micros de valor e moeda são mesclados em um campo do tipo Price.
metrics.orders,
metrics.orderedItems,
… 		Sem suporte As métricas do Comprar com o Google não são compatíveis com a API Merchant Reports

Novos valores de método de marketing

Confira o mapeamento entre os valores segments.program e marketing_method:

API Content API Merchant
SHOPPING_ADS ADS
FREE_PRODUCT_LISTING ORGANIC
FREE_LOCAL_PRODUCT_LISTING ORGANIC
BUY_ON_GOOGLE_LISTING Sem suporte

Produto

Confira o que mudou na visualização de produtos da API Merchant Reports:

API Content API Merchant Descrição
productView.id: string id: string O formato do campo muda de channel:language:targetCountry:offerId para
channel~language~feedLabel~offerId
productView.priceMicros: integer
productView.currencyCode: string 		price: {
object (Price)
} 		Os campos de micros de valor e moeda são mesclados em um campo do tipo Price.
productView.aggregated_destination_status: string aggregated_reporting_context_status: string O campo aggregated_destination_status foi renomeado para aggregated_reporting_context_status, mas os valores não mudaram.
productView.item_issues: [
{
object (ItemIssue)
}
] 		item_issues: [
{
object (ItemIssue)
}
] 		A definição de ItemIssue mudou
Sem suporte feedLabel: string O campo feedLabel é apresentado

Informações de preço

Confira o que mudou na visualização de insights de preço na API Merchant Reports:

API Content API Merchant Descrição
productView.id: string id: string O formato do campo muda de channel:language:targetCountry:offerId para channel~language~feedLabel~offerId
productView.priceMicros: integer
productView.currencyCode: string 		price: {
object (Price)
} 		Os campos de micros de valor e moeda são mesclados em um campo do tipo Price.
priceInsights.suggestedPriceMicros: integer
priceInsights.suggestedPriceCurrencyCode: string 		suggestedPrice: {
object (Price)
} 		Os campos de micros de valor e moeda são mesclados em um campo do tipo Price.
priceInsights.predictedGrossProfitChangeFraction: double
priceInsights.predictedMonthlyGrossProfitChangeMicros: integer
priceInsights.predictedMonthlyGrossProfitChangeCurrencyCode: string 		Sem suporte Campos relacionados à mudança no lucro bruto não são compatíveis com a API Merchant Reports.

Competitividade de preço

Confira o que mudou na visualização de competitividade de preço na API Merchant Reports:

API Content API Merchant Descrição
productView.id: string id: string O formato do campo muda de channel:language:targetCountry:offerId para channel~language~feedLabel~offerId
productView.priceMicros: integer
productView.currencyCode: string 		price: {
object (Price)
} 		Os campos de micros de valor e moeda são mesclados em um campo do tipo Price.
priceCompetitiveness.countryCode: string reportCountryCode: string O campo countryCode foi renomeado como reportCountryCode.
priceCompetitiveness.benchmarkPriceMicros: integer
priceCompetitiveness.benchmarkPriceCurrencyCode: string 		benchmarkPrice: {
object (Price)
} 		Os campos de micros de valor e moeda são mesclados em um campo do tipo Price.

Mais vendidos

Confira o que mudou nas visualizações de itens mais vendidos na API Merchant Reports:

API Content API Merchant Descrição
bestSellers.countryCode: string reportCountryCode: string O campo countryCode foi renomeado como reportCountryCode.
bestSellers.categoryId: int reportCategoryId: int O campo categoryId foi renomeado como reportCategoryId.

Visibilidade competitiva

Confira o que mudou nas visualizações de visibilidade competitiva na API Merchant Reports:

API Content API Merchant Descrição
competitiveVisibility.countryCode: string reportCountryCode: string O campo countryCode foi renomeado como reportCountryCode.
competitiveVisibility.categoryId: número inteiro reportCategoryId: número inteiro O campo categoryId foi renomeado como reportCategoryId.

Anterior
Migrate conversion sources management
Avançar
Migrate local feeds partnership management