Esta é a documentação do Recommendations AI, da Pesquisa de varejo e do novo Console do Varejo. Para usar a pesquisa de varejo na fase GA restrita, entre em contato com a equipe de vendas do Cloud.

Se você estiver usando apenas o Recommendations AI, permaneça no Console do Recommendations e consulte a documentação do Recommendations AI.

Antes de começar

Nesta página, descrevemos as etapas que você precisa seguir antes de usar a API Retail.

Crie o projeto

É necessário criar um projeto do Google Cloud para acessar a API Retail. Para configurar um projeto, siga estas etapas:

  1. Acesse a página Gerenciar recursos do Console do Cloud.

    Acessar a página "Gerenciar recursos"

  2. No menu suspenso na parte superior da página, selecione a organização na qual você quer criar um projeto.

  3. Clique em Create Project.

  4. Na janela Novo projeto que será exibida, insira o nome do projeto e selecione uma conta de faturamento, conforme aplicável.

  5. Se quiser adicionar o projeto a uma pasta, digite o nome dela na caixa Local.

  6. Quando terminar de inserir os detalhes do novo projeto, clique em Criar.

  7. Ative a API Retail para seu projeto do Google Cloud.

    ATIVAR A API RETAIL

    Clique no botão ATIVAR no Console do Google Cloud para ativar a API.

Configurar a autenticação do seu aplicativo

Configure os dois métodos de autenticação a seguir para acessar a API Retail:

  • Conta de serviço: os aplicativos usam uma conta de serviço para autenticar chamadas para o Product.

  • Chave de API: os aplicativos usam uma chave de API para chamadas às APIs de registro de eventos do usuário.

Crie uma conta de serviço

  1. Acesse a página Credenciais do Console do Cloud.

  2. Selecione o projeto para o qual você está criando credenciais (o projeto pode já estar selecionado).

  3. Clique em Criar credenciais. Em seguida, selecione Chave da conta de serviço.

  4. Preencha os campos a seguir:

    Campo Valor
    Conta de serviço Nova conta de serviço
    Nome da conta de serviço enter a name for your service account
    Papel Contas de serviço > Criador de token da conta de serviço
    Varejo > Editor de varejo
    Tipo de chave JSON
  5. Clique em Criar para criar a conta de serviço.

    O arquivo JSON que contém a chave pública/privada para a nova conta de serviço é salvo automaticamente no seu computador. Esse arquivo JSON é a única cópia da chave da sua conta de serviço. Armazene-o em um local seguro. O arquivo de chave JSON precisa ser armazenado em um local acessível a partir do aplicativo (consulte your-service-account-json-key-file em Como autenticar usando uma conta de serviço OAuth 2.0).

Adicionar a conta de serviço ao ambiente local

Se você quiser fazer chamadas para a API Retail usando a ferramenta de linha de comando cURL, precisará disponibilizar a conta de serviço no ambiente local. cURL usa o comando gcloud auth application-default print-access-token para receber um token de acesso à sua conta de serviço usando o SDK do Cloud do Google Cloud. Para fazer o download e instalar o SDK, consulte SDK do Cloud.

  export GOOGLE_APPLICATION_CREDENTIALS=path-to-service-account-json-key-file

Criar uma chave de API

  1. Acesse a página Credenciais do Console do Cloud.

  2. Na lista suspensa do projeto, na parte superior da página do Console do Google Cloud, selecione o projeto (o projeto já pode estar selecionado).

  3. Clique em Criar credenciais e, em seguida, selecione Chave de API. Não adicione restrições de referenciador. Algumas configurações de privacidade do usuário costumam não passar o URL referenciador.

    • Anote a chave de API gerada, que será usada ao chamar a API de registro de eventos do usuário.
  4. Para reforçar a segurança, adicione uma restrição HTTP à sua chave de API para restringir o acesso ao serviço de varejo em https://retail.googleapis.com/*.

Exemplos

Como autenticar usando uma conta de serviço (OAuth 2.0)

Veja um exemplo de Java da autenticação do OAuth 2.0 usando uma conta de serviço. Instruções mais detalhadas são encontradas na documentação de autenticação. O Google tem bibliotecas de cliente em sete idiomas que podem ser usadas para implementar a autenticação do OAuth2 no seu aplicativo. Se preferir implementar o HTTP/REST diretamente, siga as instruções de autenticação REST.

No exemplo, substitua your-service-account-json-key-file pelo caminho para o arquivo de chave JSON da sua conta de serviço.

// Simple Java example of using Google Cloud OAuth client library.
//
// Please see here for the list of libraries in different languages:
// https://developers.google.com/identity/protocols/OAuth2#libraries
//
// The following example depends on the google api client library.
//
// Maven:
//    <dependency>
//      <groupId>com.google.api-client</groupId>
//      <artifactId>google-api-client</artifactId>
//      <version>1.22.0</version>
//    </dependency>
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpResponse;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.json.JsonHttpContent;
import com.google.api.client.json.GenericJson;
import com.google.api.client.json.jackson2.JacksonFactory;
import java.io.FileInputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

public class RetailApiSample {
  public static final String CREATE_PRODUCT_URL =
     "https://retail.googleapis.com/v2/projects/[PROJECT_NUMBER]/locations/global/catalogs/default_catalog/branches/0/products";

  public static GoogleCredential authorize() throws Exception {
    return GoogleCredential.fromStream(new FileInputStream("your-service-account-json-key-file"))
        .createScoped(Collections.singleton("https://www.googleapis.com/auth/cloud-platform"))
        .setExpirationTimeMilliseconds(new Long(3600 * 1000));;
  }

  // Build an example product.
  public static GenericJson getProduct() {
    GenericJson categories = new GenericJson()
        .set("categories", Arrays.asList("Electronics > Computers", "Laptops"));
    GenericJson priceInfo = new GenericJson
        .set("currency_code", "USD")
        .set("price", 800.00)
        .set("original_price", 1000.00);

    return new GenericJson()
        .set("name", "projects/[PROJECT_NUMBER]/locations/global/catalogs/default_catalog/branches/0/products/[ProductName]")
        .set("title", "Sample Laptop")
        .set("description", "Indisputably the most fantastic laptop ever created.")
        .set("categories", categories)
        .set("price_info", priceInfo)
        .set("availability", "IN_STOCK")
        .set("available_quantity", 1219);
  }

  public static void main(String[] args) {
    try {
      GoogleCredential credential = RetailApiSample.authorize();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      HttpRequestFactory requestFactory = httpTransport.createRequestFactory();
      HttpRequest request = requestFactory.buildPostRequest(new GenericUrl(CREATE_PRODUCT_URL),
          new JsonHttpContent(new JacksonFactory(), RetailApiSample.getProduct()));
      credential.initialize(request);
      HttpResponse response = request.execute();
      System.out.println("Response content: " + response.parseAsString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Acessar o console de gerenciamento de varejo

No Console do Retail, é possível gerenciar recursos de varejo e monitorar a atividade dele no Console do Google Cloud baseado em navegador.

Consulte Visão geral do console de administração de varejo para uma visão geral do que você pode fazer no console.

Acessar o Console do Retail Cloud

A seguir