Veja como integrar a API Merchant Reports à sua implementação 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/v1beta/{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/v1beta/{PARENT}/reports:search |
| Identificadores | {MERCHANT_ID}
|
{PARENT}
|
Métodos
É possível consultar a API Merchant Reports chamando o método
ReportService.Search.
Visualizações
Na API Merchant, os nomes das tabelas foram alterados de CammelCase 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, especificar um prefixo de campo, por exemplo, segments.offer_id,
não é mais necessário. Em vez disso, use o nome do campo, offer_id.
Confira um exemplo de comparação de consultas na API Content for 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 para a visualização de performance na 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: duplo
|
clickThroughRate: duplo
|
A métrica ctr foi renomeada como clickThroughRate.
|
metrics.conversionValueMicros: número inteiro
segments.currencyCode: string
|
conversionValue: {
|
Micros de valor e campos de moeda são mesclados em um campo com o tipo Price
|
metrics.orders,
|
Sem suporte | As métricas do programa 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 para a visualização de produtos 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: número inteiro
productView.currencyCode: string
|
price: {
|
Micros de valor e campos de moeda são mesclados em um campo com o 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: [
|
item_issues: [
|
A definição de ItemIssue foi alterada
|
| Sem suporte | feedLabel: string
|
O campo feedLabel foi introduzido
|
Informações de preço
Confira o que mudou para a visualização de informações 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: número inteiro
productView.currencyCode: string
|
price: {
|
Micros de valor e campos de moeda são mesclados em um campo com o tipo Price
|
priceInsights.suggestedPriceMicros: número inteiro
priceInsights.suggestedPriceCurrencyCode: string
|
suggestedPrice: {
|
Micros de valor e campos de moeda são mesclados em um campo com o tipo Price
|
priceInsights.predictedGrossProfitChangeFraction: duplo
priceInsights.predictedMonthlyGrossProfitChangeMicros: inteiro
priceInsights.predictedMonthlyGrossProfitChangeCurrencyCode: string
|
Sem suporte | Os 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 para a 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: número inteiro
productView.currencyCode: string
|
price: {
|
Micros de valor e campos de moeda são mesclados em um campo com o tipo Price
|
priceCompetitiveness.countryCode: string
|
reportCountryCode: string
|
O campo countryCode foi renomeado como reportCountryCode.
|
priceCompetitiveness.benchmarkPriceMicros: número inteiro
priceCompetitiveness.benchmarkPriceCurrencyCode: string
|
benchmarkPrice: {
|
Micros de valor e campos de moeda são mesclados em um campo com o tipo Price
|
Mais vendidos
Confira o que mudou para as visualizações de 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 para as 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.
|