Dịch vụ Merchant API

Dịch vụ Merchant API cho phép bạn sử dụng Merchant API trong Apps Script để tải sản phẩm lên và quản lý tài khoản Merchant Center.

Để biết thông tin chi tiết về Merchant API, hãy xem tài liệu tham khảo. Giống như tất cả các dịch vụ nâng cao trong Apps Script, dịch vụ Merchant API sử dụng cùng các đối tượng, phương thức và tham số như API công khai.

Merchant API là một tập hợp các API phụ, là các nhóm dịch vụ và tài nguyên có liên quan. Sau đây là danh sách các API phụ.

Để sử dụng dịch vụ Merchant API trong Apps Script, hãy bật các dịch vụ nâng cao của Apps Script bằng một trong các lựa chọn sau:

1. Bật appsscript.json cho các dự án mới. Bạn nên dùng lựa chọn này cho các dự án Apps Script mới.

2. Bật Apps Script cho các dự án hiện có. Sử dụng phương thức này để bật các API phụ khác trong các dự án hiện có.

Bật API trong appsscript.json

Lưu ý: Nếu bạn đang sử dụng dự án Apps Script hiện có, hãy làm theo hướng dẫn trong phần Bật Apps Script cho các API phụ khác hoặc dự án hiện có.

Ví dụ sau đây minh hoạ một tệp appsscript.json cho phép các API phụ Sản phẩm, Tài khoản, Báo cáo và Nguồn dữ liệu.

1. Trong trình chỉnh sửa Apps Script, hãy nhấp vào Project Settings (Cài đặt dự án) .

   

2. Bật lựa chọn Hiển thị tệp kê khai "appsscript.json" trong trình chỉnh sửa.

3. Trong trình chỉnh sửa, hãy chọn tệp appsscript.json.

4. Thay thế nội dung của tệp appsscript.json bằng nội dung sau:

   {
     "dependencies": {
       "enabledAdvancedServices": [
         {
           "userSymbol": "MerchantApiAccounts",
           "version": "accounts_v1beta",
           "serviceId": "merchantapi"
         },
         {
           "userSymbol": "MerchantApiDataSources",
           "version": "datasources_v1beta",
           "serviceId": "merchantapi"
         },
         {
           "userSymbol": "MerchantApiProducts",
           "version": "products_v1beta",
           "serviceId": "merchantapi"
         },
         {
           "userSymbol": "MerchantApiReports",
           "version": "reports_v1beta",
           "serviceId": "merchantapi"
         }
       ]
     },
     "exceptionLogging": "STACKDRIVER",
     "runtimeVersion": "V8"
   }
   appsscript.json
   

5. Nhấp vào Lưu.

6. Giờ đây, bạn có thể tham chiếu đến các API phụ sau đây trong mã của mình dưới dạng:

   a. MerchantApiAccounts

   b. MerchantApiDataSources

   c. MerchantApiProducts

   d. MerchantApiReports

Bật Apps Script cho các API phụ khác hoặc dự án hiện có

Hãy làm theo các bước sau để bật các API phụ trong dự án hiện có.

1. Mở dự án Apps Script của bạn.

2. Ở bên trái, hãy nhấp vào Trình chỉnh sửa < >.

3. Ở bên trái, bên cạnh Dịch vụ, hãy nhấp vào Thêm dịch vụ +.

4. Chọn API phụ mà bạn muốn bật trong bộ chọn phiên bản.

5. Thêm giá trị nhận dạng có tên của API phụ. Ví dụ: để bật API phụ Kho hàng, hãy chọn phiên bản inventories_v1beta và thay đổi giá trị nhận dạng thành MerchantApiInventories.

   

   Cảnh báo: Mỗi dịch vụ phải có một giá trị nhận dạng riêng biệt. Luôn thêm tên của API phụ vào Mã nhận dạng.

6. Giờ đây, bạn có thể tham khảo API phụ Kho hàng trong mã của mình dưới dạng MerchantApiInventories.

Mã mẫu

Phần này giải thích cách sử dụng Merchant API cho một số tính năng.

Liệt kê sản phẩm

Ví dụ này minh hoạ cách liệt kê các sản phẩm cho một tài khoản Merchant Center nhất định.

/**
 * Lists all products for a given Merchant Center account.
 */
function productList() {
  // IMPORTANT:
  // Enable the Merchant API Products Bundle 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

Lọc sản phẩm bị từ chối

Ví dụ này minh hoạ cách lọc các sản phẩm bị từ chối trong tài khoản Merchant Center.

/**
 * Demonstrates how to filter disapproved products using the Merchant API Reports service.
 */
function filterDisapprovedProducts() {
  // IMPORTANT:
  // Enable the Merchant API Reports Bundle Advanced Service and call it
  // "MerchantApiReports"
  // Enable the Merchant API Products Bundle 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

Truy xuất báo cáo cho một tài khoản nhất định

Ví dụ này minh hoạ cách truy xuất báo cáo cho một tài khoản Merchant Center nhất định.

/**
 * Searches a report for a given Merchant Center account.
 */
function searchReport() {
  // IMPORTANT:
  // Enable the Merchant API Reports Bundle 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

Liệt kê tất cả nguồn dữ liệu

Ví dụ này minh hoạ cách liệt kê tất cả nguồn dữ liệu trong một tài khoản Merchant Center nhất định.

/**
 * Lists all data sources for a given Merchant Center account.
 */
function listDataSources() {
  // IMPORTANT:
  // Enable the Merchant API DataSources Bundle 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