Serviço da API Merchant

O serviço da API Merchant permite usar a API Merchant no Apps Script para fazer upload de produtos e gerenciar contas do Merchant Center.

Para informações detalhadas sobre a API Merchant, consulte a documentação de referência. Assim como todos os serviços avançados no Apps Script, o serviço da API Merchant usa os mesmos objetos, métodos e parâmetros da API pública.

A API Merchant é um conjunto de sub-APIs, ou seja, grupos de serviços e recursos relacionados. Confira a lista de sub-APIs.

Para usar o serviço da API Merchant no Apps Script, siga estas etapas:

1. Verifique se o projeto do Apps Script está vinculado a um projeto padrão do Google Cloud. Para mais informações, consulte Usar outro projeto padrão do Cloud.

2. Ative o serviço avançado do Apps Script, conforme descrito neste documento:

   • Ative o appsscript.json para novos projetos.
   • Ative o Apps Script para projetos atuais.

3. Registre seu projeto padrão do Google Cloud com sua conta do Merchant Center, conforme descrito no guia de início rápido da API Merchant.

Ativar o serviço avançado do Apps Script

É possível ativar o serviço do Apps Script usando um dos dois métodos a seguir:

Ativar APIs em appsscript.json

Observação: se você estiver usando um projeto do Apps Script, siga as instruções em Ativar o Apps Script para outras sub-APIs ou projetos existentes.

O exemplo a seguir mostra um arquivo appsscript.json que ativa as sub-APIs Products, Accounts, Reports e Data sources.

1. No editor do Apps Script, selecione Configurações do projeto .

   

2. Ative a opção Mostrar arquivo de manifesto "appsscript.json" no editor.

3. No editor, selecione o arquivo appsscript.json.

4. Substitua o conteúdo do arquivo appsscript.json pelo seguinte:

   {
     "dependencies": {
       "enabledAdvancedServices": [
         {
           "userSymbol": "MerchantApiAccounts",
           "version": "accounts_v1",
           "serviceId": "merchantapi"
         },
         {
           "userSymbol": "MerchantApiDataSources",
           "version": "datasources_v1",
           "serviceId": "merchantapi"
         },
         {
           "userSymbol": "MerchantApiProducts",
           "version": "products_v1",
           "serviceId": "merchantapi"
         },
         {
           "userSymbol": "MerchantApiReports",
           "version": "reports_v1",
           "serviceId": "merchantapi"
         }
       ]
     },
     "exceptionLogging": "STACKDRIVER",
     "runtimeVersion": "V8"
   }
   appsscript_v1.json
   

5. Clique em Salvar.

6. Agora você pode se referir às seguintes sub-APIs no seu código como:

   a. MerchantApiAccounts

   b. MerchantApiDataSources

   c. MerchantApiProducts

   d. MerchantApiReports

Ativar o Apps Script para outras sub-APIs ou projetos atuais

Para ativar sub-APIs em projetos atuais, faça o seguinte:

1. Abra seu projeto do Apps Script.

2. À esquerda, clique em Editor < >.

3. À esquerda, ao lado de Serviços, clique em Adicionar um serviço +.

4. Selecione a sub-API que você quer ativar no seletor de versão.

5. Adicione o identificador com o nome da sub-API. Por exemplo, para ativar a sub-API Inventories, selecione a versão inventories_v1 e mude o identificador para MerchantApiInventories.

   

   Aviso: cada serviço precisa ter um identificador exclusivo. Sempre adicione o nome da sub-API ao identificador.

6. Agora você pode se referir à sub-API Inventories no seu código como MerchantApiInventories.

Código de amostra

Esta seção explica como usar a API Merchant para recursos selecionados.

Listar os produtos

Este exemplo demonstra como listar os produtos de uma determinada conta do Merchant Center.

/**
 * Lists all products for a given Merchant Center account.
 */
function productList() {
  // IMPORTANT:
  // Enable the Merchant API Products sub-API Advanced Service and call it
  // "MerchantApiProducts"

  // Replace this with your Merchant Center ID.
  const accountId = '<MERCHANT_CENTER_ID>';

  // Construct the parent name
  const parent = 'accounts/' + accountId;

  try {
    console.log('Sending list Products request');
    let pageToken;
    // Set the page size to 1000. This is the maximum allowed page size.
    let pageSize = 1000;

    console.log('Retrieved products below:');
    // Call the Products.list API method. Use the pageToken to iterate through
    // all pages of results.
    do {
      response = MerchantApiProducts.Accounts.Products.list(parent, {pageToken, pageSize});
      console.log(response);
      pageToken = response.nextPageToken;
    } while (pageToken); // Exits when there is no next page token.
  } catch (e) {
    console.log('ERROR!');
    console.log(e);
  }
}
list_products_sample.gs

Filtrar produtos reprovados

Este exemplo demonstra como filtrar produtos reprovados em uma conta do Merchant Center.

/**
 * Demonstrates how to filter disapproved products using the Merchant API Reports service.
 */
function filterDisapprovedProducts() {
  // IMPORTANT:
  // Enable the Merchant API Reports sub-API Advanced Service and call it
  // "MerchantApiReports"
  // Enable the Merchant API Products sub-API Advanced Service and call it
  // "MerchantApiProducts"

  // Replace this with your Merchant Center ID.
  const accountId = '<INSERT_MERCHANT_CENTER_ID>';

  // Construct the parent name
  const parent = 'accounts/' + accountId;

  try {
    console.log('Sending search Report request');
    // Set pageSize to the maximum value (default: 1000)
    let pageSize = 1000;
    let pageToken;
    // The query below is an example of a query for the productView that gets product informations
    // for all disapproved products.
    let query = 'SELECT offer_id,' +
        'id,' +
        'price,' +
        'title' +
        ' FROM product_view' +
        ' WHERE aggregated_reporting_context_status = "NOT_ELIGIBLE_OR_DISAPPROVED"';


    // Call the Reports.search API method. Use the pageToken to iterate through
    // all pages of results.
    do {
      response =
          MerchantApiReports.Accounts.Reports.search({query, pageSize, pageToken}, parent);
      for (const reportRow of response.results) {
        console.log("Printing data from Product View:");
        console.log(reportRow);

        // OPTIONALLY, you can get the full product details by calling the GetProduct method.
        let productName = parent + "/products/" + reportRow.getProductView().getId();
        product = MerchantApiProducts.Accounts.Products.get(productName);
        console.log(product);
      }
      pageToken = response.nextPageToken;
    } while (pageToken);  // Exits when there is no next page token.

  } catch (e) {
    console.log('ERROR!');
    console.log('Error message:' + e.message);
  }
}
filter_disapproved_products_sample.gs

Recuperar um relatório de uma determinada conta

Este exemplo mostra como recuperar um relatório de uma determinada conta do Merchant Center.

/**
 * Searches a report for a given Merchant Center account.
 */
function searchReport() {
  // IMPORTANT:
  // Enable the Merchant API Reports sub-API Advanced Service and call it
  // "MerchantApiReports"

  // Replace this with your Merchant Center ID.
  const accountId = '<MERCHANT_CENTER_ID>';

  // Construct the parent name
  const parent = 'accounts/' + accountId;

  try {
    console.log('Sending search Report request');
    // Set pageSize to the maximum value (default: 1000)
    let pageSize = 1000;
    let pageToken;
    // Uncomment the desired query from below. Documentation can be found at
    // https://developers.google.com/merchant/api/reference/rest/reports_v1beta/accounts.reports#ReportRow
    // The query below is an example of a query for the product_view.
    let query = 'SELECT offer_id,' +
        'id,' +
        'price,' +
        'gtin,' +
        'item_issues,' +
        'channel,' +
        'language_code,' +
        'feed_label,' +
        'title,' +
        'brand,' +
        'category_l1,' +
        'product_type_l1,' +
        'availability,' +
        'shipping_label,' +
        'thumbnail_link,' +
        'click_potential' +
        ' FROM product_view';

    /*
    // The query below is an example of a query for the
    price_competitiveness_product_view. let query = "SELECT offer_id,"
                 + "id,"
                 + "benchmark_price,"
                 + "report_country_code,"
                 + "price,"
                 + "title,"
                 + "brand,"
                 + "category_l1,"
                 + "product_type_l1"
                + " FROM price_competitiveness_product_view"
                + " WHERE date BETWEEN '2023-03-03' AND '2025-03-10'"; */
    /*
    // The query below is an example of a query for the
    price_insights_product_view. let query = "SELECT offer_id,"
                     + "id,"
                     + "suggested_price,"
                     + "price,"
                     + "effectiveness,"
                     + "title,"
                     + "brand,"
                     + "category_l1,"
                     + "product_type_l1,"
                     + "predicted_impressions_change_fraction,"
                     + "predicted_clicks_change_fraction,"
                     + "predicted_conversions_change_fraction"
                    + " FROM price_insights_product_view"; */

    /*
    // The query below is an example of a query for the
    product_performance_view. let query = "SELECT offer_id,"
            + "conversion_value,"
            + "marketing_method,"
            + "customer_country_code,"
            + "title,"
            + "brand,"
            + "category_l1,"
            + "product_type_l1,"
            + "custom_label0,"
            + "clicks,"
            + "impressions,"
            + "click_through_rate,"
            + "conversions,"
            + "conversion_rate"
            + " FROM product_performance_view"
            + " WHERE date BETWEEN '2023-03-03' AND '2025-03-10'"; */

    // Call the Reports.search API method. Use the pageToken to iterate through
    // all pages of results.
    do {
      response =
          MerchantApiReports.Accounts.Reports.search({query, pageSize, pageToken}, parent);
      for (const reportRow of response.results) {
        console.log(reportRow);
      }
      pageToken = response.nextPageToken;
    } while (pageToken);  // Exits when there is no next page token.

  } catch (e) {
    console.log('ERROR!');
    console.log(e);
    console.log('Error message:' + e.message);
    if (e.stack) {
      console.log('Stack trace:' + e.stack);
    }
  }
}

search_report_sample.gs

Listar todas as origens de dados

Este exemplo demonstra como listar todas as fontes de dados em uma determinada conta do Merchant Center.

/**
 * Lists all data sources for a given Merchant Center account.
 */
function listDataSources() {
  // IMPORTANT:
  // Enable the Merchant API DataSources sub-API Advanced Service and call it
  // "MerchantApiDataSources"

  // Replace this with your Merchant Center ID.
  const accountId = '<MERCHANT_CENTER_ID>';

  // Construct the parent name
  const parent = 'accounts/' + accountId;
  let dataSources = [];
  let primaryDataSources = [];
  try {
    console.log('Sending list DataSources request');
    let pageToken;
    let pageSize = 10;
    // Call the DataSources.list API method. Use the pageToken to iterate through
    // all pages of results.
    do {
      response =
          MerchantApiDataSources.Accounts.DataSources.list(parent, {pageSize, pageToken});
      for (const datasource of response.dataSources) {
        dataSources.push(datasource);
        if (datasource.primaryProductDataSource) {
          primaryDataSources.push(datasource);
        }
      }
      pageToken = response.nextPageToken;
    } while (pageToken);  // Exits when there is no next page token.
    console.log('Retrieved ' + dataSources.length + ' data sources.');
    console.log(
        'There were ' + primaryDataSources.length +
        ' primary product data sources.');
  } catch (e) {
    console.log('ERROR!');
    console.log(e);
  }
}
list_data_sources_sample.gs