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 a integração da API for usada no AppScript 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 conta do Merchant Center, consulte Começar a usar o Merchant Center.

Ir para o Merchant Center

Registrar-se como um desenvolvedor

Para usar a API Merchant, vincule sua conta do Merchant Center e seu projeto do Google Cloud usando o método de registro de desenvolvedor, da seguinte forma:

  1. Vincule o Merchant Center e seu projeto do Google Cloud: a vinculação é aprovada automaticamente, já que o autor da chamada tem um token de acesso ou uma chave de API válidos do projeto do Google Cloud e é um usuário autorizado da conta do Merchant Center.

  2. Adicione um usuário desenvolvedor de API à conta do Merchant Center: a API Registration adiciona um usuário desenvolvedor de API à conta do Merchant Center. Se um usuário já existir, ele vai receber o novo tipo de acesso. Se for um novo usuário, ele vai receber um convite por e-mail do Merchant Center.

Recomendamos que você use o método accounts.users.create para adicionar outros desenvolvedores de API ou de backup e verificar se, caso a pessoa saia da sua organização ou seja excluída, você ainda terá um registro de desenvolvedor válido.

Depois do registro, é possível conferir o status usando GetDeveloperRegistration ou cancelar o registro usando UnregisterGCP.

A chamada de registro é

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

{
  developer_email:"[email protected]"
}

Depois que a solicitação for executada, aguarde a resposta:

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

Depois que o desenvolvedor de API for registrado, use o método accounts.users.patch para conceder a ele outros papéis, como STANDARD e ADMIN.

Encontrar o ID da conta

Você pode extrair o ID da conta usando o método accounts.list.

Use o Google APIs Explorer para executar solicitações da API Merchant. O APIs Explorer usa o Google OAuth 2.0 para autenticação. Antes de executar as solicitações, verifique se a caixa de seleção Google OAuth 2.0 está marcada.

Para autenticar usando o OAuth 2.0, faça login na sua Conta do Google e no APIs Explorer. Você também precisa permitir que o APIs Explorer gerencie suas contas e informações de produtos.

A solicitação a seguir mostra como recuperar seu ID da conta:

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts

ou

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

Depois que a solicitação for executada, você vai ver a seguinte resposta:

{
  "accounts": [
    {
      "name": "{ACCOUNT_NAME}",
      "accountId": "{ACCOUNT_ID}",
      "accountName": "{ACCOUNT_DISPLAY_NAME}",
      "timeZone": {
        "id": "America/Los_Angeles"
      },
      "languageCode": "en-US"
    }
  ]
}

Copie o {ACCOUNT_ID} porque você vai precisar dele para executar outras solicitações.

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/v1beta/accounts/{ACCOUNT_ID}/dataSources HTTP/1.1

{
  "primaryProductDataSource": {
    "channel": "ONLINE_PRODUCTS",
    "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 que essa solicitação for executada, você vai receber a seguinte resposta:

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

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

A fonte de dados criada leva alguns minutos para ficar disponível para inserção de produtos.

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/v1beta/accounts/{ACCOUNT_ID}/productInputs:insert?dataSource={DATASOURCE_NAME} HTTP/1.1

{
  "channel": "ONLINE",
  "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.

Depois que essa solicitação for executada, você vai receber a seguinte resposta:

{
  "name": "accounts/{ACCOUNT_ID}/productInputs/online~en~US~tshirt-123",
  "product": "accounts/{ACCOUNT_ID}/products/online~en~US~tshirt-123",
  "channel": "ONLINE",
  "offerId": "tshirt-123",
  "contentLanguage": "en",
  "feedLabel": "US",
  "attributes": {
    "brand": "New brand",
    "gender": "Male"
  }
}

O ID do produto recém-criado é online~en~US~tshirt-123. Você pode usar o método accounts.products.get para recuperar detalhes sobre esse produto. Você também pode usar a interface do Merchant Center para ver esse produto.