Esta página foi traduzida pela API Cloud Translation.

Introdução à API Merchant

Nesta página, explicamos como criar uma conta do Merchant Center e fazer upload de um produto de amostra usando a API Merchant.

Antes de começar

Ative a API Merchant no projeto do Google Cloud.

Se você usar a integração da API no Apps Script com o serviço de conteúdo do Shopping, um projeto padrão do Google Cloud será criado e o serviço da API Merchant será ativado automaticamente. No entanto, você ainda precisa concluir um registro único de desenvolvedor antes de usar a API Merchant. Para mais informações, consulte Usar o serviço da API Merchant no Apps Script.

Acessar o Google Cloud

Criar uma conta

Para usar a API Merchant, você precisa ter uma conta do Merchant Center. Para criar uma, consulte Começar a usar o Merchant Center.

Acesse o Merchant Center

Registrar-se como um desenvolvedor

Para usar a API Merchant, crie um link entre seu projeto do Google Cloud e sua conta principal do Merchant Center. Esse registro único é necessário para cada projeto do Google Cloud usado com a API Merchant.

Ao se registrar como desenvolvedor, você faz duas coisas:

Ele vincula seu projeto do Google Cloud à conta principal do Merchant Center, estabelecendo uma conexão formal.
Ele cria um contato técnico atribuindo a função API_DEVELOPER a um usuário na sua conta do Merchant Center. Assim, o Google pode enviar atualizações importantes sobre a API, como anúncios de serviço e informações sobre novos recursos.

Registrar seu projeto do Google Cloud

Para registrar, chame o método developerRegistration.registerGcp. Essa chamada vincula o projeto do Google Cloud que você usa para fazer a chamada à conta do Merchant Center especificada na solicitação.

No corpo da solicitação, você precisa fornecer um endereço de e-mail de desenvolvedor para usar como contato técnico. Esse endereço precisa estar associado a uma Conta do Google (conta do Google Workspace ou do Gmail), por exemplo, sampleuser@gmail.com. As contas de serviço não podem ser usadas porque são contas não humanas destinadas ao acesso programático e não à comunicação com desenvolvedores.

Se o endereço de e-mail já pertencer a um usuário na conta do Merchant Center, ele vai receber a função API_DEVELOPER.
Se o endereço de e-mail não pertencer a um usuário, um convite será enviado para ele. O destinatário precisa aceitar o convite para ser adicionado como um novo usuário com a função API_DEVELOPER.

Veja um exemplo de solicitação:

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/developerRegistration:registerGcp

{
  "developerEmail": "{DEVELOPER_EMAIL}"
}

Uma chamada bem-sucedida retorna um recurso DeveloperRegistration, que confirma a vinculação entre seu projeto e sua conta.

{
  "name": "accounts/{ACCOUNT_ID}/developerRegistration",
  "gcpIds": [
    "123456789012345"
  ]
}

Gerenciar contatos e permissões de desenvolvedor

Depois de se registrar, recomendamos que você adicione vários desenvolvedores e conceda a eles direitos de acesso adicionais.

Conceder outras permissões

O papel API_DEVELOPER é necessário para receber notificações importantes, mas tem permissões mínimas no Merchant Center. Para permitir que esse usuário faça outras chamadas de API ou gerencie configurações na interface do Merchant Center, conceda a ele outras funções, como STANDARD ou ADMIN. Para mais informações, consulte Tipos de acesso.

É possível atualizar os direitos de acesso de um usuário com o método accounts.users.patch.

O exemplo a seguir mostra como atualizar um usuário para conceder a ele as funções ADMIN e API_DEVELOPER. Assim, eles podem gerenciar totalmente a conta e também recebem comunicações relacionadas à API.

PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/users/{DEVELOPER_EMAIL}?update_mask=access_rights

{
  "access_rights": [
    "ADMIN",
    "API_DEVELOPER"
  ]
}

Adicionar desenvolvedores de backup

Para evitar que o acesso à API seja interrompido se o contato principal do desenvolvedor sair da sua organização, adicione pelo menos um desenvolvedor substituto.

É possível adicionar um usuário com o método accounts.users.create ou atualizar um usuário atual com o método accounts.users.patch. Recomendamos que você conceda a esse usuário as funções ADMIN e API_DEVELOPER.

Criar uma fonte de dados de produtos principal

Para inserir um produto, você precisa de uma fonte de dados de produtos principal. A solicitação a seguir mostra como criar uma fonte de dados que pode ser usada para inserir um produto na sua conta:

POST https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources HTTP/1.1

{
  "primaryProductDataSource": {
    "contentLanguage": "en",
    "countries": [
      "US"
    ],
    "feedLabel": "US"
  },
  "name": "primary-data-source",
  "displayName": "Primary Products Data Source"
}

Substitua {ACCOUNT_ID} pelo ID da conta do Merchant Center que você criou.

Depois de executar essa solicitação, você vai receber a seguinte resposta:

{
  "name": "accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}",
  "dataSourceId": "{DATASOURCE_ID}",
  "displayName": "Primary Products Data Source",
  "primaryProductDataSource": {
    "feedLabel": "US",
    "contentLanguage": "en",
    "countries": [
      "US"
    ],
    "defaultRule": {
      "takeFromDataSources": [
        {
          "self": true
        }
      ]
    }
  },
  "input": "API"
}

Copie o valor do campo name. Você vai precisar dele para inserir um produto.

Você pode conferir essa fonte de dados na interface do Merchant Center. Para mais informações, consulte Como encontrar a guia "Fontes de dados".

Inserir um produto

Para inserir um produto de exemplo na sua conta, execute a seguinte solicitação:

POST https://merchantapi.googleapis.com/products/v1/accounts/{ACCOUNT_ID}/productInputs:insert?dataSource={DATASOURCE_NAME} HTTP/1.1

{
  "contentLanguage": "en",
  "feedLabel": "US",
  "name": "Red T-shirt",
  "attributes": {
    "gender": "Male",
    "brand": "New brand"
  },
  "offerId": "tshirt-123"
}

Substitua {DATASOURCE_NAME} pelo valor que você copiou antes.