Migrar o gerenciamento da conta da API Content for Shopping

Este documento explica como migrar da API Content v2.1 para a API Merchant.

Visão geral das mudanças da API Content v2.1 para a API Merchant

A API Merchant apresenta melhorias significativas em relação à API Content v2.1, com o objetivo de melhorar a usabilidade, a consistência e a flexibilidade para desenvolvedores e empresas.

Estrutura granular de recursos

Os recursos na API Merchant representam conceitos únicos, como account, businessDetails, user, homepage e program. Eles são organizados hierarquicamente para refletir os relacionamentos. Por exemplo, um account é o recurso pai de um user.

Serviços de conta unificados

Todos os serviços de conta (por exemplo, agregação de contas para MCAs e subcontas ou entre provedores de serviços de terceiros e contas) são gerenciados por um recurso accountService unificado. Os provedores de serviços podem gerenciar os relacionamentos usando o recurso accountRelationship.

Estrutura de URL simplificada

Os URLs agora usam um único ID de conta (por exemplo, merchantapi.googleapis.com/accounts/v1beta/accounts/{accountId}) em vez de vários IDs. Os caminhos de URL refletem a estrutura de recursos granular.

Outros aperfeiçoamentos

  • Gerenciamento aprimorado de programas e usuários: programas como anúncios do Shopping e listagens sem custo financeiro são consolidados em um único recurso program. O recurso user inclui recursos de gerenciamento abrangentes com direitos de acesso granulares.
  • Informações comerciais estruturadas e identidade comercial: há recursos dedicados para businessInfo e businessIdentity. Eles incluem suporte à conformidade com campos para dados específicos da região. Por exemplo, o número de registro comercial coreano.
  • Reivindicação simplificada da página inicial: um recurso homepage dedicado gerencia o URL da página inicial da loja. Métodos como claim e unclaim processam a reivindicação do site diretamente pela API.
  • Compliance com as diretrizes da API do Google: a API Merchant tem como objetivo se alinhar às propostas de melhoria da API do Google.

Migração do gerenciamento da conta

É possível usar o recurso accounts para criar e gerenciar sua conta de comerciante. Para mais informações, consulte Visão geral da API Merchant Accounts.

Esta página descreve como migrar o gerenciamento de contas da API Content para a API Merchant.

Solicitações

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

https://merchantapi.googleapis.com/accounts/v1beta/{ACCOUNT_ID}/accounts

Confira um exemplo de comparação entre a API Content for Shopping e a API Merchant Accounts para solicitações de criação e gerenciamento de contas:

  API Content for Shopping API Merchant Accounts
URL https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/accounts/{accountId}/ https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*}
Identificadores merchantId,accountId ``nome

Recursos

Os dados da conta são transmitidos usando o recurso Account na API Content for Shopping. A API Merchant Accounts oferece vários recursos para transmitir dados de contas. Esses recursos incluem Account, User, BusinessInfo e BusinessIdentity.

A tabela a seguir mostra uma comparação entre o recurso Account na API Content for Shopping e o recurso Account na API Merchant Accounts.

API Content for Shopping API Merchant Accounts
id name
name accountName
kind Indisponível
websiteUrl Campo uri no recurso Homepage
adultContent adultContent
sellerId Campo accountIdAlias no recurso AccountRelationship
users No recurso User
youtubeChannelLinks Ainda não disponível
googleMyBusinessLink Ainda não disponível
businessInformation No recurso businessInfo
businessIdentity No recurso businessIdentity
automaticImprovements Ainda não disponível
adsLinks Campo campaignsManagement no recurso AccountService
cssId Disponível apenas na API CSS
labelIds Disponível apenas na API CSS
accountManagement Campo accountManagement no recurso AccountService
automaticLabelIds Disponível apenas na API CSS
conversionSettings Ainda não disponível

A tabela a seguir mostra uma comparação entre o recurso AccountUser na API Content for Shopping e o recurso User na API Merchant Accounts.

API Content for Shopping API Merchant Accounts
emailAddress O e-mail faz parte do name (accounts/{account}/users/{email}).
admin user#accessRights.ADMIN
orderManager Indisponível
paymentsManager Indisponível
paymentsAnalyst Indisponível
reportingManager user#accessRights.PERFORMANCE_REPORTING

A tabela a seguir mostra uma comparação entre o recurso AccountBusinessInformation na API Content for Shopping e o recurso equivalente businessInfo na API Merchant Accounts.

API Content for Shopping API Merchant Accounts
address address
phoneNumber phone
phoneVerificationStatus phoneVerificationState
customerService customerService
koreanBusinessRegistrationNumber koreanBusinessRegistrationNumber

A tabela a seguir compara o recurso AccountBusinessIdentity na API Content for Shopping e o recurso businessIdentity na API Merchant Accounts.

API Content for Shopping API Merchant Accounts
blackOwned blackOwned
womenOwned womenOwned
veteranOwned veteranOwned
latinoOwned latinoOwned
smallBusiness smallBusiness
includeForPromotions promotionsConsent
- true significa PROMOTION_CONSENT_GIVEN
- false significa PROMOTION_CONSENT_DENIED

O recurso AccountIdentityType na API Content é representado pelo tipo IdentityAttribute e pelo campo identityDeclaration na MerchantAPI.

API Content for Shopping API Merchant Accounts
self_identified identityDeclaration
- true significa SELF_IDENTIFIES_AS
- false significa DOES_NOT_SELF_IDENTIFY_AS

Métodos

Os métodos a seguir foram introduzidos na API Merchant Accounts:

API Content for Shopping API Merchant Accounts
accounts.authinfo GET https://merchantapi.googleapis.com/accounts/v1beta/accounts sem filtro
accounts.claimwebsite POST https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/homepage:claim Para mais informações, consulte Método: accounts.v1beta.accounts.homepage.claim
accounts.custombatch Indisponível. Não é possível usar lotes personalizados na API Merchant.
accounts.delete DELETE https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*}
accounts.get GET https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*}`
accounts.insert POST https://merchantapi.googleapis.com/accounts/v1beta/accounts:createAndConfigure Para mais informações, consulte Criar e configurar uma conta de comerciante.
accounts.link AccountService Recurso
accounts.list GET https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}:listSubaccounts
accounts.listlinks GET https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/services
accounts.requestphoneverification Incompatível.
accounts.update É mapeado para uma solicitação de atualização do recurso em que o campo obrigatório ou conjunto de campos é definido.
accounts.updatelabels Disponível apenas na API CSS
accounts.verifyphonenumber Incompatível.
Anterior
Visão geral
Próxima
Migrar o gerenciamento de inventário