Acompanhamento de e-commerce

Este documento fornece uma visão geral de como avaliar os pagamentos no aplicativo e a receita usando o SDK v4 do Google Analytics para Android.

Aviso: o SDK de e-commerce foi descontinuado. Use o SDK de e-commerce avançado.

Visão geral

Com a avaliação do comércio eletrônico, é possível enviar compras e vendas no aplicativo ao Google Analytics. Os dados de e-commerce no Google Analytics são compostos por hits de transação e item relacionados por um ID de transação compartilhado.

As transações têm os seguintes campos:

Nome do campo	Tipo	Obrigatório	Descrição
Transaction ID	String	Sim	Um ID exclusivo que representa a transação. Esse ID não deve colidir com outros IDs de transação.
Affiliation	String	Sim	Uma entidade à qual a transação deve ser afiliada (por exemplo, uma loja específica)
Receita	Double	Sim	A receita total de uma transação, incluindo impostos e frete.
Tax	Double	Sim	O total de impostos de uma transação.
Shipping	Double	Sim	O custo total do frete de uma transação.
Currency code	String	Não	A moeda local de uma transação. O padrão é a moeda da vista da propriedade (perfil) em que as transações estão sendo visualizadas.

Os itens têm os seguintes campos:

Nome do campo	Tipo	Obrigatório	Descrição
Transaction ID	String	Sim	O código da transação com o qual o produto deve ser associado.
Nome	String	Sim	O nome do produto.
SKU	String	Sim	O SKU de um produto.
Category	String	Não	Uma categoria à qual produto pertence.
Preço	Double	Sim	O preço de um produto.
Quantity	Long	Sim	A quantidade de um produto.
Currency code	String	Não	A moeda local de uma transação. O padrão é a moeda da vista da propriedade (perfil) em que as transações são informadas.

Os dados do comércio eletrônico são usados principalmente nestes relatórios padrão:

• Visão geral do comércio eletrônico
• Desempenho do produto
• Desempenho de vendas
• Transações
• Tempo até a compra

Implementação

O TransactionBuilder e o ItemBuilder são usados para enviar dados de transações e itens ao Google Analytics. Cada campo de comércio eletrônico é definido por meio de métodos auxiliares. Exemplo:

// Build the transaction.
sendDataToTwoTrackers(new HitBuilders.TransactionBuilder()
    .setTransactionId(getOrderId())
    .setAffiliation(getStoreName())
    .setRevenue(getTotalOrder())
    .setTax(getTotalTax())
    .setShipping(getShippingCost())
    .setCurrencyCode("USD")
    .build());

// Build an item.
sendDataToTwoTrackers(new HitBuilders.ItemBuilder()
    .setTransactionId(getOrderId())
    .setName(getItemName(1))
    .setSku(getItemSku(1))
    .setCategory(getItemCategory(1))
    .setPrice(getItemPrice(getView(), 1))
    .setQuantity(getItemQuantity(getView(), 1))
    .setCurrencyCode("USD")
    .build());


// Sends the ecommerce data.
private void sendDataToTwoTrackers(Map<String, String> params) {
  AnalyticsSampleApp app = ((AnalyticsSampleApp) getActivity().getApplication());
  Tracker appTracker = app.getTracker(TrackerName.APP_TRACKER);
  Tracker ecommerceTracker = app.getTracker(TrackerName.ECOMMERCE_TRACKER);
  appTracker.send(params);
  ecommerceTracker.send(params);
}

Consulte Configuração avançada para detalhes sobre o método getTracker.

Veja um snippet de código do aplicativo de exemplo

O snippet a seguir mostra um exemplo completo de comércio eletrônico:

package com.google.android.apps.mobileplayground;

import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.view.KeyEvent;
import android.view.LayoutInflater;
import android.view.View;
import android.view.View.OnClickListener;
import android.view.View.OnKeyListener;
import android.view.ViewGroup;
import android.widget.Button;
import android.widget.EditText;
import android.widget.TextView;
import android.widget.Toast;
import com.google.android.apps.mobileplayground.AnalyticsSampleApp.TrackerName;
import com.google.android.apps.mobileplayground.MobilePlayground.UserInputException;
import com.google.android.gms.analytics.GoogleAnalytics;
import com.google.android.gms.analytics.HitBuilders;
import com.google.android.gms.analytics.Tracker;
import java.util.Map;

/**
 * Class to exercise Ecommerce hits.
 */
public class EcommerceFragment extends Fragment {

  @Override
  public View onCreateView(LayoutInflater inflater, ViewGroup container,
      Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    View view = inflater.inflate(R.layout.ecommerce, container, false);

    setUniqueOrderId(view);
    calculate(view);

    setupAutoCalculate(view, R.id.item1Quantity);
    setupAutoCalculate(view, R.id.item1Price);
    setupAutoCalculate(view, R.id.item2Quantity);
    setupAutoCalculate(view, R.id.item2Price);

    final Button sendButton = (Button) view.findViewById(R.id.ecommerceSend);
    sendButton.setOnClickListener(new OnClickListener() {
      @Override
      public void onClick(View v) {
        sendEcommerce();
      }
    });

    final Button dispatchButton = (Button) view.findViewById(R.id.ecommerceDispatch);
    dispatchButton.setOnClickListener(new OnClickListener() {
      @Override
      public void onClick(View v) {
        // Manually start a dispatch (Unnecessary if the tracker has a dispatch interval).
        GoogleAnalytics.getInstance(getActivity().getBaseContext()).dispatchLocalHits();
      }
    });
    return view;
  }

  private void sendEcommerce() {
    try {
      // Build the transaction.
      sendDataToTwoTrackers(new HitBuilders.TransactionBuilder()
          .setTransactionId(getOrderId())
          .setAffiliation(getStoreName())
          .setRevenue(getTotalOrder())
          .setTax(getTotalTax())
          .setShipping(getShippingCost())
          .setCurrencyCode("USD")
          .build());

      // Build an item.
      sendDataToTwoTrackers(new HitBuilders.ItemBuilder()
          .setTransactionId(getOrderId())
          .setName(getItemName(1))
          .setSku(getItemSku(1))
          .setCategory(getItemCategory(1))
          .setPrice(getItemPrice(getView(), 1))
          .setQuantity(getItemQuantity(getView(), 1))
          .setCurrencyCode("USD")
          .build());

      sendDataToTwoTrackers(new HitBuilders.ItemBuilder()
          .setTransactionId(getOrderId())
          .setName(getItemName(2))
          .setSku(getItemSku(2))
          .setCategory(getItemCategory(2))
          .setPrice(getItemPrice(getView(), 2))
          .setQuantity(getItemQuantity(getView(), 2))
          .setCurrencyCode("USD")
          .build());
    } catch (UserInputException e) {
      Toast.makeText(getActivity(), e.getMessage(), Toast.LENGTH_SHORT).show();
    }
    setUniqueOrderId(getView());
  }
  private void sendDataToTwoTrackers(Map<String, String> params) {
    AnalyticsSampleApp app = ((AnalyticsSampleApp) getActivity().getApplication());
    Tracker appTracker = app.getTracker(TrackerName.APP_TRACKER);
    Tracker ecommerceTracker = app.getTracker(TrackerName.ECOMMERCE_TRACKER);
    appTracker.send(params);
    ecommerceTracker.send(params);
  }
  private double calculate(View view) {
    double item1Total = getItemQuantity(view, 1) * getItemPrice(view, 1);
    ((TextView) view.findViewById(R.id.item1Total)).setText(Double.toString(item1Total));
    double item2Total = getItemQuantity(view, 2) * getItemPrice(view, 2);
    ((TextView) view.findViewById(R.id.item2Total)).setText(Double.toString(item2Total));
    double itemTotal = item1Total + item2Total;
    ((TextView) view.findViewById(R.id.itemTotal)).setText(Double.toString(itemTotal));
    return itemTotal;
  }

  private void setUniqueOrderId(View view) {
    final EditText orderIdButton = (EditText) view.findViewById(R.id.orderId);
    orderIdButton.setText(getString(R.string.orderId) + System.currentTimeMillis());
  }

  private void setupAutoCalculate(View view, int editTextId) {
    final EditText editText = (EditText) view.findViewById(editTextId);
    editText.setOnKeyListener(new OnKeyListener() {
      @Override
      public boolean onKey(View v, int keyCode, KeyEvent event) {
        calculate(getView());
        return false;
      }
    });
  }

  private String getStoreName() {
    String storeName =
        ((EditText) getView().findViewById(R.id.storeName)).getText().toString().trim();
    if (storeName.length() == 0) {
      return null;
    }
    return storeName;
  }

  private String getOrderId() throws UserInputException {
    String orderId = ((EditText) getView().findViewById(R.id.orderId)).getText().toString().trim();
    if (orderId.length() == 0) {
      throw new UserInputException(getString(R.string.orderIdWarning));
    }
    return orderId;
  }

  private double getTotalOrder() {
    String total = ((TextView) getView().findViewById(R.id.itemTotal)).getText().toString().trim();
    if (total.length() == 0) {
      return 0;
    }
    return Double.valueOf(total);
  }

  private double getTotalTax() {
    String tax = ((EditText) getView().findViewById(R.id.totalTax)).getText().toString().trim();
    if (tax.length() == 0) {
      return 0;
    }
    return Double.valueOf(tax);
  }

  private double getShippingCost() {
    String shipping =
        ((EditText) getView().findViewById(R.id.shippingCost)).getText().toString().trim();
    if (shipping.length() == 0) {
      return 0;
    }
    return Double.valueOf(shipping);
  }

  private String getItemName(int index) {
    int buttonId = index == 1 ? R.id.item1Name : R.id.item2Name;
    String name = ((EditText) getView().findViewById(buttonId)).getText().toString().trim();
    if (name.length() == 0) {
      return null;
    }
    return name;
  }

  private String getItemCategory(int index) {
    int buttonId = index == 1 ? R.id.item1Category : R.id.item2Category;
    String name = ((EditText) getView().findViewById(buttonId)).getText().toString().trim();
    if (name.length() == 0) {
      return null;
    }
    return name;
  }

  private String getItemSku(int index) throws UserInputException {
    int buttonId = index == 1 ? R.id.item1Sku : R.id.item2Sku;
    String sku = ((EditText) getView().findViewById(buttonId)).getText().toString().trim();
    if (sku.length() == 0) {
      int warningId = index == 1 ? R.string.item1SkuWarning : R.string.item2SkuWarning;
      throw new UserInputException(getString(warningId));
    }
    return sku;
  }

  private long getItemQuantity(View view, int index) {
    int buttonId = index == 1 ? R.id.item1Quantity : R.id.item2Quantity;
    String quantity = ((EditText) view.findViewById(buttonId)).getText().toString().trim();
    if (quantity.length() == 0) {
      return 0;
    }
    return Long.valueOf(quantity);
  }

  private double getItemPrice(View view, int index) {
    int buttonId = index == 1 ? R.id.item1Price : R.id.item2Price;
    String price = ((EditText) view.findViewById(buttonId)).getText().toString().trim();
    if (price.length() == 0) {
      return 0;
    }
    return Double.valueOf(price);
  }
}

Os campos de moeda de comércio eletrônico suportam valores de moeda negativos, como pode ser necessário no caso de reembolsos ou devoluções.

Atenção : não inclua símbolos de moeda ou vírgulas nos campos de moeda.

Especificação de moedas

Por padrão, presume-se que os valores das transações estejam na mesma moeda da vista da propriedade (perfil) em que são informados.

Para substituir a moeda local de uma transação e todos os produtos associados, defina o campo do código de moeda dos hits de transações e itens com o novo código de moeda. Para ver a lista completa das moedas aceitas e os códigos correspondentes, consulte a referência de moedas aceitas.