Migrar as configurações da página inicial

A API Merchant apresenta um recurso Homepage dedicado. Esse recurso oferece novos métodos para gerenciar sua reivindicação da página inicial, com recursos além da API Content for Shopping clássica.

Para acessar os recursos da sua loja on-line, siga duas etapas: primeiro, verifique a propriedade e, depois, reivindique o site na sua conta. Para concluir a etapa final, use o accounts.homepage.claim.

principais diferenças

A API Merchant faz várias mudanças relacionadas à página inicial em comparação com a API Content for Shopping:

• Recurso dedicado: a API Merchant fornece um recurso Homepage distinto (accounts.homepage) para todas as operações relacionadas à página inicial. Na API Content for Shopping, você usava accounts.claimwebsite para realizar a ação de reivindicação. O URL da página inicial (website_url) fazia parte do recurso Account, e o status da reivindicação (website_claimed) fazia parte do recurso AccountStatus.
• Métodos granulares: a API Merchant oferece métodos específicos para:
  • Extrair detalhes da página inicial: accounts.homepage.getHomepage
  • Atualize o URI da página inicial: accounts.homepage.updateHomepage
  • Reivindicar a página inicial: accounts.homepage.claim
  • Exoneração de responsabilidade da página inicial: accounts.homepage.unclaim A API Content for Shopping usou accounts.claimwebsite para a ação de reivindicação, accounts.update para definir o URL (e efetivamente negar a responsabilidade definindo um URL vazio) e accounts.get/accountstatuses.get para recuperar o URL e o status da reivindicação, respectivamente.
• Informações centralizadas: o recurso Homepage da API Merchant contém o uri (URL da página inicial) e o status claimed diretamente. Todos os métodos que operam no recurso Homepage retornam esse recurso, fornecendo feedback imediato sobre o estado atual. Na API Content for Shopping, accounts.claimwebsite não retornava o status atualizado. Era necessário fazer chamadas separadas.
• Exoneração explícita: na API Content for Shopping, a exoneração era normalmente feita atualizando o Account.website_url para uma string vazia. A API Merchant fornece um método homepage.unclaim dedicado.
• Substituição de reivindicação: as duas APIs oferecem suporte a um parâmetro overwrite durante o processo de reivindicação para assumir uma reivindicação de outra conta se a propriedade puder ser verificada.

Solicitações

A API Merchant usa endpoints RESTful distintos para gerenciar diferentes aspectos da página inicial.

Descrição da solicitação	API Content for Shopping	API Merchant
Receber os detalhes da página inicial	accounts.get (para ler Account.website_url), accountstatuses.get (para ler AccountStatus.website_claimed)	GET /accounts/v1/accounts/{account}/homepage
Atualizar o URI da página inicial	accounts.update (configuração Account.website_url)	PATCH /accounts/v1/accounts/{account}/homepage
Reivindicar ou verificar novamente a página inicial	POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (ação realizada em Account.website_url definido usando accounts.update)	POST /accounts/v1/accounts/{account}/homepage:claim
Dispensar a página inicial	accounts.update (definindo Account.website_url como uma string vazia)	POST /accounts/v1/accounts/{account}/homepage:unclaim

Identificadores

A identificação de recursos foi simplificada na API Merchant.

Descrição do identificador	API Content for Shopping	API Merchant
Identificador da conta para acesso a recursos	merchantId (conta avançada) e accountId (subconta) no caminho	account (parte do campo name, como accounts/{account_id}/homepage)
Identificador de recurso da página inicial	Não relevante (implícito ao recurso Account)	name: accounts/{account_id}/homepage (identifica o sub-recurso Homepage)

Métodos

O método accounts.claimwebsite da API Content for Shopping, que se concentrava na ação de reivindicar, agora faz parte de um conjunto mais amplo de funcionalidades no recurso Homepage da API Merchant.

Método da API Content for Shopping	Método da API Merchant	Disponibilidade e observações
accounts.claimwebsite	accounts.homepage.claim	Inicia ou verifica novamente uma reivindicação de site diretamente. Atua no uri definido anteriormente usando homepage.update. Inclui um parâmetro overwrite. Retorna o recurso Homepage com o status uri e claimed atual.
accounts.get (para ler Account.website_url), accountstatuses.get (para ler AccountStatus.website_claimed)	accounts.homepage.getHomepage	Novo método dedicado para recuperar a página inicial uri atual e o status claimed dela em uma única chamada.
accounts.update (para definir Account.website_url)	accounts.homepage.updateHomepage	Novo método dedicado para definir ou mudar a página inicial uri.
accounts.update (definir Account.website_url como uma string vazia como solução alternativa para cancelar a reivindicação)	accounts.homepage.unclaim	Novo método dedicado para cancelar explicitamente a reivindicação de uma página inicial.

Mudanças detalhadas nos campos

A forma como as informações da página inicial são estruturadas e acessadas mudou significativamente, passando para o recurso Homepage explícito na API Merchant.

API Content for Shopping	API Merchant	Descrição
merchantId (parâmetro de caminho para accounts.claimwebsite)	name (parâmetro de caminho para métodos Homepage, formato: accounts/{account}/homepage)	A parte account da string name na API Merchant corresponde ao accountId da API Content for Shopping.
accountId (parâmetro de caminho para accounts.claimwebsite)	name (parâmetro de caminho para métodos Homepage, formato: accounts/{account}/homepage)	O identificador da conta específica cuja página inicial está sendo gerenciada.
overwrite (booleano no corpo ContentAccountsClaimwebsiteRequest e AccountsCustomBatchRequestEntry)	ClaimHomepageRequest.overwrite (booleano no corpo da solicitação homepage.claim)	Opcional. Se true, tenta reivindicar o site, possivelmente removendo uma reivindicação de outra conta se a propriedade puder ser verificada pela conta solicitante.
Account.website_url (campo no recurso Account, definido usando accounts.update, lido usando accounts.get)	Homepage.uri (campo no recurso Homepage)	O URI (URL) da página inicial da loja. Na API Merchant, esse é um campo explícito no recurso Homepage. Ele é definido usando accounts.homepage.updateHomepage e retornado por todos os métodos Homepage.
AccountStatus.website_claimed (campo no recurso AccountStatus, lido usando accountstatuses.get)	Homepage.claimed (campo booleano output_only no recurso Homepage)	Indica se o uri foi reivindicado e verificado. Esse status está disponível diretamente no recurso Homepage retornado por todos os métodos associados da API Merchant.
N/A	UpdateHomepageRequest.update_mask (parâmetro do corpo da solicitação accounts.homepage.updateHomepage)	Uma máscara de campo opcional para homepage.update especificar quais campos (por exemplo, uri) do recurso Homepage estão sendo atualizados.