Neste guia, explicamos como os desenvolvedores de apps de terceiros podem usar o serviço
MerchantSupport
para criar uma página de diagnóstico no app para os comerciantes.
É possível usar esse serviço para criar interfaces semelhantes às páginas Diagnóstico da conta e Problemas do produto do Merchant Center.
O serviço MerchantSupport
é destinado apenas a interfaces de terceiros. As solicitações precisam ser acionadas quando um comerciante interage com a interface do seu aplicativo. Para automatizar
os diagnósticos da sua própria conta de comerciante, consulte os guias sobre status da
conta, status
do produto e filtragem
de produtos.
Recomendamos que você inclua as seguintes páginas no seu app para ajudar os comerciantes a resolver problemas:
- Diagnóstico da conta
- Diagnóstico do produto
Opções diferentes para implementar uma página de diagnóstico
É possível implementar a página de diagnóstico de diferentes maneiras. Com base na necessidade,
escolha a opção que determina como as ações de diagnóstico complexas são processadas. Na
solicitação, é possível definir user_input_action_option
como uma das seguintes
opções:
REDIRECT_TO_MERCHANT_CENTER
: esta é a opção padrão. As ações que exigem a exibição de mais conteúdo ou o recebimento de entradas extras do comerciante não são totalmente implementadas no app. Para elas, a API fornece um link de redirecionamento para a página correspondente no Merchant Center em que o comerciante pode realizar a ação.BUILT_IN_USER_INPUT_ACTIONS
: é possível implementar ações complexas que exigem entrada do usuário como uma solução no app.
Implementar uma página de diagnóstico
Esta seção mostra como implementar a página de diagnóstico. Ele usa a opção padrão (simples) para processar ações complexas, como redirecionamentos para o Merchant Center.
Para uma implementação mais avançada com ações no app, consulte as seções a seguir e consulte Implementar ações integradas com entrada do usuário.
Implementação
Veja como sugerimos que o fluxo da sua página de diagnóstico seja semelhante a:
- Um comerciante abre uma página de diagnóstico no seu app.
O app solicita um diagnóstico chamando o serviço
MerchantSupport
.Veja um exemplo de solicitação:
POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/merchantsupport/renderaccountissues?timeZone=America/Los_Angeles&languageCode=en-GB {}
Substitua {merchantId} pelo identificador exclusivo da conta para a qual você quer acionar o processamento da ação.
O app mostra o diagnóstico e as ações recomendadas na resposta ao comerciante. Veja um exemplo de resposta:
{ "issues": [ { "title": "Misrepresentation", "impact": { "message": "Prevents all products from showing in all countries", "severity": "ERROR", "breakdowns": [ { "regions": [ { "code": "001", "name": "All countries" } ], "details": [ "Products not showing organically" ] } ] }, "prerenderedContent": "\u003cdiv class=\"issue-detail\"\u003e\u003cdiv class=\"issue-content\"\u003e\u003cp class=\"content-element\"\u003e\u003cspan class=\"segment\"\u003eBased on the information available about your business, there is reason to believe that customers are being misled on Google. Review the Misrepresentation policy and make changes to your Merchant Center and/or online store.u003c/span\u003e\u003c/p\u003e\u003cp class=\"content-element root-causes-intro\"\u003e\u003cspan class=\"segment\"\u003eMake sure your Merchant Center and online store follow the following best practices / guidelines\u003c/span\u003e\u003c/p\u003e\u003cul class=\"content-element root-causes\"\u003e\u003cli\u003e\u003cp\u003e\u003cspan class=\"segment\"\u003eProvide transparency about your business identity, business model, policies and how your customers can interact with you\u003c/span\u003e\u003c/p\u003e\u003c/li\u003e\u003cli\u003e\u003cp\u003e\u003cspan class=\"segment\"\u003ePromote your online reputation by showing reviews or highlighting any badges or seals of approval\u003c/span\u003e\u003c/p\u003e\u003c/li\u003e\u003cli\u003e\u003cp class=\"tooltip tooltip-style-info\"\u003e\u003cspan class=\"segment\"\u003eUse a professional design for your online store that includes an SSL certificate\u003c/span\u003e\u003cspan class=\"tooltip-icon\"\u003e\u003cbr\u003e\u003c/span\u003e\u003cspan class=\"tooltip-text\"\u003e\u003cspan class=\"segment\"\u003eMake sure it's accessible for all users without any redirects and doesn't have any placeholders for text and images.u003c/span\u003e\u003c/span\u003e\u003c/p\u003e\u003c/li\u003e\u003cli\u003e\u003cp class=\"tooltip tooltip-style-info\"\u003e\u003cspan class=\"segment\"\u003eProvide information in the business information settings in your Merchant Center\u003c/span\u003e\u003cspan class=\"tooltip-icon\"\u003e\u003cbr\u003e\u003c/span\u003e\u003cspan class=\"tooltip-text\"\u003e\u003cspan class=\"segment\"\u003eLink any relevant third-party platforms to your Merchant Center and create a Google Business Profile.u003c/span\u003e\u003c/span\u003e\u003c/p\u003e\u003c/li\u003e\u003cli\u003e\u003cp\u003e\u003cspan class=\"segment\"\u003eFollow SEO guidelines, improve your eligibility for seller ratings and match your product data in your Merchant Center with your online store\u003c/span\u003e\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e\u003ca href=\"https://support.google.com/merchants/answer/6150127?hl=en-US\" class=\"content-element\"\u003eLearn more about the Misrepresentation policy\u003c/a\u003e\u003c/div\u003e\u003c/div\u003e", "actions": [ { "externalAction": { "type": "REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER", "uri": "https://merchants.google.com/mc/products/diagnostics/accountissues?a=672911686&hl=en-US" }, "buttonLabel": "Request review", "isAvailable": true } ] }, { "title": "Adult-oriented content", "impact": { "message": "Prevents all products from showing in all countries", "severity": "ERROR", "breakdowns": [ { "regions": [ { "code": "001", "name": "All countries" } ], "details": [ "Products not showing organically" ] } ] }, "prerenderedContent": "\u003cdiv class=\"issue-detail\"\u003e\u003cdiv class=\"callout-banners\"\u003e\u003cdiv class=\"callout-banner callout-banner-info\"\u003e\u003cp\u003e\u003cspan class=\"segment\"\u003eReview requested on Aug 9, 2023. It can take a few days to complete.u003c/span\u003e\u003c/p\u003e\u003c/div\u003e\u003c/div\u003e\u003cdiv class=\"issue-content\"\u003e\u003cp class=\"content-element\"\u003e\u003cspan class=\"segment\"\u003eThere was a problem identified with the sale of prohibited adult products on your online store. In the case that you are intentionally selling adult items, enable Adult content in Settings in your Merchant Center. In your product file, use the \u003c/span\u003e\u003cspan class=\"segment segment-attribute\"\u003eadult\u003c/span\u003e\u003cspan class=\"segment\"\u003e attribute for specific products.u003c/span\u003e\u003c/p\u003e\u003cp class=\"content-element root-causes-intro\"\u003e\u003cspan class=\"segment\"\u003eMake sure the products meet the policy requirements\u003c/span\u003e\u003c/p\u003e\u003cul class=\"content-element root-causes\"\u003e\u003cli\u003e\u003cp class=\"tooltip tooltip-style-info\"\u003e\u003cspan class=\"segment\"\u003eAdult oriented content may be prohibited or restricted depending on the product sold and the country it is sold\u003c/span\u003e\u003cspan class=\"tooltip-icon\"\u003e\u003cbr\u003e\u003c/span\u003e\u003cspan class=\"tooltip-text\"\u003e\u003cspan class=\"segment\"\u003eSee a full list of countries in the HelpCenter\u003c/span\u003e\u003c/span\u003e\u003c/p\u003e\u003c/li\u003e\u003cli\u003e\u003cp class=\"tooltip tooltip-style-info\"\u003e\u003cspan class=\"segment\"\u003eDon't list sexually explicit content that is intended to arouse or includes content such as text, image, audio, or video of graphic sexual acts intended to arouse\u003c/span\u003e\u003cspan class=\"tooltip-icon\"\u003e\u003cbr\u003e\u003c/span\u003e\u003cspan class=\"tooltip-text\"\u003e\u003cspan class=\"segment\"\u003eExamples: Graphic depictions of sexual acts in progress, including hardcore pornography, any type of genital, anal, or oral sexual activity; graphic depictions of masturbation or genital arousal and language explicitly referencing arousal, masturbation, cartoon porn, or hentai\u003c/span\u003e\u003c/span\u003e\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e\u003ca href=\"https://support.google.com/merchants/answer/6150138?hl=en-US#wycd-restricted-adult-content\" class=\"content-element\"\u003eLearn more about the Adult-oriented content policy\u003c/a\u003e\u003c/div\u003e\u003c/div\u003e" }, { "title": "Missing return and refund policy", "impact": { "message": "Limits visibility of all products in all countries", "severity": "ERROR", "breakdowns": [ { "regions": [ { "code": "001", "name": "All countries" } ], "details": [ "Limited visibility for products showing organically" ] } ] }, "prerenderedContent": "\u003cdiv class=\"issue-detail\"\u003e\u003cdiv class=\"issue-content\"\u003e\u003cp class=\"content-element\"\u003e\u003cspan class=\"segment\"\u003eThere was a problem identified with the return and/or refund policy of your online store. Update your return or refund policy to provide customers a transparent shopping experience.u003c/span\u003e\u003c/p\u003e\u003cp class=\"content-element root-causes-intro\"\u003e\u003cspan class=\"segment\"\u003eMake sure your products meet the Shopping policy requirements\u003c/span\u003e\u003c/p\u003e\u003cul class=\"content-element root-causes\"\u003e\u003cli\u003e\u003cp class=\"tooltip tooltip-style-info\"\u003e\u003cspan class=\"segment\"\u003eIt's available on your online store\u003c/span\u003e\u003cspan class=\"tooltip-icon\"\u003e\u003cbr\u003e\u003c/span\u003e\u003cspan class=\"tooltip-text\"\u003e\u003cspan class=\"segment\"\u003eWe recommend that you have a separate landing page for your policy and link to it from the other pages on your online store, so that it's easy to find.u003c/span\u003e\u003c/span\u003e\u003c/p\u003e\u003c/li\u003e\u003cli\u003e\u003cp class=\"tooltip tooltip-style-info\"\u003e\u003cspan class=\"segment\"\u003eIt's available in the language of the country you're selling in or in English\u003c/span\u003e\u003cspan class=\"tooltip-icon\"\u003e\u003cbr\u003e\u003c/span\u003e\u003cspan class=\"tooltip-text\"\u003e\u003cspan class=\"segment\"\u003eMake sure that the return and/or refund policy is available in the target language or in English. Ideally, users should be given the option to select the return and/or refund policy in their own language.u003c/span\u003e\u003c/span\u003e\u003c/p\u003e\u003c/li\u003e\u003cli\u003e\u003cp\u003e\u003cspan class=\"segment\"\u003eIt's accessible to everyone visiting your online store, without having to log in, sign up or enter any personal information\u003c/span\u003e\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e\u003ca href=\"https://support.google.com/merchants/answer/9158778?hl=en-US\" class=\"content-element\"\u003eLearn more about Missing return and refund policy\u003c/a\u003e\u003c/div\u003e\u003c/div\u003e", "actions": [ { "externalAction": { "type": "REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER", "uri": "https://merchants.google.com/mc/products/diagnostics/accountissues?a=672911686&hl=en-US" }, "buttonLabel": "Request review", "isAvailable": true } ] } ], "alternateDisputeResolution": { "uri": "https://support.google.com/european-union-digital-services-act-redress-options?hl=en-US", "label": "Additional options available to you" } }
Recomendamos que você mostre os problemas na ordem em que são retornados, com
title
eimpact.message
. Também recomendamos que você mostre oimpact.breakdowns
do problema quando o comerciante passar o cursor sobre o título ou a descrição dele.O comerciante clica em um problema na lista.
O app mostra o
impact
detalhado de cada problema porcountry
,destination
,prerendered_content
e botões doactions
que o comerciante pode realizar para resolver o problema. Há diferentes tipos de ações:- Ações externas: indique a página externa, por exemplo, no Merchant Center, em que o comerciante pode resolver o problema.
- Ações simples integradas: aponte para a página no seu aplicativo em que o comerciante pode resolver o problema.
- Ações integradas de entrada do usuário: abra uma caixa de diálogo em que o comerciante pode fornecer as informações necessárias e solicitar a ação. Esse tipo de
ação só estará disponível se o
BUILT_IN_USER_INPUT_ACTIONS
tiver sido solicitado.
O comerciante segue as instruções para resolver o problema.
O comerciante recarrega a página de diagnóstico no app.
O app envia outra solicitação para o serviço
MerchantSupport
e mostra uma lista atualizada de problemas.
Você pode comparar as informações mostradas pelo app final com as páginas de diagnóstico no Merchant Center para verificar sua implementação.
Simulações de interface
Confira um exemplo de como mostrar as informações da resposta
renderaccountissues
na página de diagnóstico da conta. Os objetos na
interface são mapeados para os campos de API correspondentes na simulação. É possível criar uma página
semelhante para problemas de produtos.
Veja como a página de diagnóstico da conta preenchida é:
Estilo HTML pré-renderizado
A resposta da chamada do serviço MerchantSupport
inclui o campo prerendered_content
, os detalhes de cada problema em HTML. É possível incorporar
esse conteúdo HTML diretamente à interface para mostrar o problema em um formato
legível.
Talvez apareçam elementos HTML com a classe new-element
. A classe new-element
é aplicada aos elementos adicionados ao HTML após a integração
com o serviço MerchantSupport
. Recomendamos ocultar elementos com a classe
new-element
para que você possa definir o estilo deles antes de serem exibidos
aos usuários no seu app.
Confira um exemplo do valor do campo prerendered_content
:
<div class="issue-detail">
<div class="callout-banners">
<div class="callout-banner callout-banner-info"><p><span class="segment">Review requested on Aug 9, 2023. It can take a few days to complete.</span>
</p></div>
</div>
<div class="issue-content"><p class="content-element"><span class="segment">There was a problem identified with the sale of prohibited adult products on your online store. In the case that you are intentionally selling adult items, enable Adult content in Settings in your Merchant Center. In your product file, use the </span><span
class="segment segment-attribute">adult</span><span class="segment"> attribute for specific products.</span>
</p>
<p class="content-element root-causes-intro"><span class="segment">Make sure the products meet the policy requirements</span>
</p>
<ul class="content-element root-causes">
<li><p class="tooltip tooltip-style-info"><span class="segment">Adult oriented content may be prohibited or restricted depending on the product sold and the country it is sold</span><span
class="tooltip-icon"><br></span><span class="tooltip-text"><span class="segment">See a full list of countries in the HelpCenter</span></span>
</p></li>
<li><p class="tooltip tooltip-style-info"><span class="segment">Don't list sexually explicit content that is intended to arouse or includes content such as text, image, audio, or video of graphic sexual acts intended to arouse</span><span
class="tooltip-icon"><br></span><span class="tooltip-text"><span class="segment">Examples: Graphic depictions of sexual acts in progress, including hardcore pornography, any type of genital, anal, or oral sexual activity; graphic depictions of masturbation or genital arousal and language explicitly referencing arousal, masturbation, cartoon porn, or hentai</span></span>
</p></li>
</ul>
<a href="https://support.google.com/merchants/answer/6150138?hl=en-US#wycd-restricted-adult-content"
class="content-element">Learn more about the Adult-oriented content policy</a></div>
</div>
Veja como ficaria se você incorporou o HTML prerendered_content
anterior no seu app sem nenhum estilo:
É possível usar várias classes CSS para ajustar a forma como o conteúdo é renderizado na interface. Confira um exemplo de CSS que pode ser usado:
issue-detail {
text-align: left;
width: 700px;
border-radius: 8px;
background: white;
margin: 16px;
padding: 16px;
}
.content-element {
margin: 8px 0 8px 0;
display: block;
}
/* callout banners */
.callout-banners {
margin: 0 0 16px 0;
}
.callout-banner {
display: block;
padding: 16px 16px 6px 16px;
margin: 0 0 8px 0;
border-radius: 8px;
}
.callout-banner-info {
background: #e8f0fe;
}
.callout-banner-warning {
background: #fef7e0;
}
.callout-banner-error {
background: #fce8e6;
}
/* add an icon to the callout banner */
.callout-banner p {
background-repeat: no-repeat;
padding-left: 32px;
}
.callout-banner-error p {
background-image: url("https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/error/default/20px.svg");
}
.callout-banner-warning p {
background-image: url("https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/warning/default/20px.svg");
}
.callout-banner-info p {
background-image: url("https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/search/default/20px.svg");
}
/* segments with style */
.segment-attribute {
color: #198639;
font-family: monospace, monospace;
}
.segment-bold {
font-weight: bold;
}
.segment-italic {
font-style: italic;
}
/* tooltip */
.tooltip {
position: relative;
}
.tooltip-style-info .tooltip-icon:before {
content: '(i)';
font-style: normal;
font-weight: normal;
text-decoration: inherit;
margin-left: 5px;
}
.tooltip-style-question .tooltip-icon:before {
content: '(?)';
font-style: normal;
font-weight: normal;
text-decoration: inherit;
margin-left: 5px;
}
.tooltip .tooltip-text {
visibility: hidden;
text-align: left;
background: white;
border-radius: 8px;
padding: 5px 0;
border: 1px solid;
padding: 10px;
box-shadow: 3px 7px 12px #c1c1c1;
position: absolute;
z-index: 1;
}
.tooltip:hover .tooltip-text {
visibility: visible;
}
/* table */
table.content-element {
margin: 16px 0 16px 0;
border: 1px solid #ccc;
border-collapse: collapse;
margin: 1em 0;
}
table.content-element th {
background-color: #eee;
}
table.content-element th, table td {
border: 1px solid #ddd;
font-size: 0.9em;
padding: 0.3em 1em;
}
/* hidde elements added in future, until they are supported in your application */
.new-element {
visibility: hidden;
}
Veja como o conteúdo renderizado vai ficar se você usar o CSS anterior:
Também é possível configurar e mostrar dicas com o CSS:
Implementar uma ação integrada com entrada do usuário
Uma ação integrada com entrada do usuário permite que você forneça um recurso de diagnóstico complexo como uma solução no app. Recomendamos implementá-la como uma caixa de diálogo em que o comerciante pode fornecer a entrada, ler mais informações e confirmar a solicitação.
Cada ação contém um ou mais fluxos de ação. Para algumas ações, pode haver mais de um fluxo. Por exemplo, pode haver um fluxo diferente quando o comerciante pedir outra análise porque ele discorda da decisão e outro quando o problema já foi corrigido.
Para solicitar dados para implementar ações complexas com entrada do usuário, defina
o campo user_input_action_option
como o valor BUILT_IN_USER_INPUT_ACTIONS
.
POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/merchantsupport/renderaccountissues
{
"user_input_action_option": "BUILT_IN_USER_INPUT_ACTIONS"
}
Substitua {merchantId} pelo identificador exclusivo da conta para a qual você quer acionar o processamento da ação.
Implementação
Confira como sugerimos que o fluxo da página de diagnóstico que solicite a entrada do usuário seja semelhante a:
O comerciante clica no botão de ação.
- Se houver vários fluxos disponíveis, todos eles serão oferecidos pelo app para que o comerciante selecione um, de acordo com a intenção.
- O comerciante seleciona o fluxo.
Seu app exibe o título, a mensagem, a frase de destaque e o formulário de entrada do usuário para o fluxo de ações selecionado. Recomendamos que você mostre esses detalhes em uma caixa de diálogo.
- A frase de destaque, se houver, contém informações importantes que ajudam o comerciante a entender melhor como a ação funciona e o que fazer para ter sucesso. Recomendamos destacar e definir o estilo dessa mensagem de acordo com a gravidade da frase de destaque.
- Se houver campos de entrada no fluxo, eles precisarão ser exibidos para que o comerciante forneça valores. Se o campo de entrada estiver marcado como obrigatório, seu app não permitirá que o comerciante envie a solicitação antes de fornecer o valor.
O comerciante lê as informações e fornece os valores solicitados.
O comerciante confirma a solicitação clicando no botão.
O app aciona o processamento da ação chamando o serviço
MerchantSupport
. Veja um exemplo de solicitação:POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/merchantsupport/triggeraction { actionContext: "ActionContextValue=", actionInput: { actionFlowId: "flow1", inputValues: [ { input_field_id: "input1", checkbox_input_value: { value: true } } ] }
Substitua {merchantId} pelo identificador exclusivo da conta para a qual você quer acionar o processamento da ação.
Para acessar o método
triggeraction
paraBuiltInUserInputAction
, envie uma solicitação usando este formulário.Seu app mostra a mensagem de confirmação retornada do serviço
MerchantSupport
.- Se o serviço retornar um erro de validação com o status
INVALID_ARGUMENT
, ele vai conter informações detalhadas e uma mensagem de erro localizada que precisa ser mostrada ao comerciante. Recomendamos mostrar esse erro perto do campo de entrada afetado. Confira um exemplo de resposta:
{ "error": { "code": 400, "message": "[actionInput.inputValues] Invalid user input", "status": "INVALID_ARGUMENT", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "invalid", "domain": "global" }, { "@type": "type.googleapis.com/google.rpc.BadRequest", "fieldViolations": [ { "field": "actionInput.inputValues.input", "description": "The field is required" } ] } ] } }
- Se o serviço retornar um estado inválido ou erro interno, indicados pelos status
FAILED_PRECONDITION
eINTERNAL
, o aplicativo precisará instruir o comerciante a atualizar a página ou tentar mais tarde.
- Se o serviço retornar um erro de validação com o status