फ़ाइल पर आधारित डेटा सोर्स की प्रोसेसिंग को मॉनिटर और ट्रिगर करना

Merchant API की मदद से, फ़ाइल पर आधारित डेटा सोर्स की प्रोसेसिंग की स्थिति पर नज़र रखी जा सकती है. साथ ही, उन्हें तुरंत फ़ेच करने के लिए मैन्युअल तरीके से ट्रिगर किया जा सकता है.

फ़ाइल अपलोड होने की स्थिति के बारे में नया अपडेट पाना

फ़ाइल पर आधारित डेटा सोर्स के लिए, प्रोसेसिंग की हाल ही में की गई कोशिश का स्टेटस देखने के लिए, fileUploads.get तरीके का इस्तेमाल करें. हाल ही के अपलोड या फ़ेच किए गए डेटा की स्थिति पाने के लिए, आपको fileuploadId के लिए latest उपनाम का इस्तेमाल करना होगा.

इस तरीके से इनके बारे में जानकारी मिलती है:

• प्रोसेसिंग की स्थिति (जैसे, SUCCEEDED, FAILED, IN_PROGRESS)
• प्रोसेस किए गए आइटम की संख्या
• कोई समस्या आई हो
• अपलोड करने का टाइमस्टैंप

GET https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}/fileUploads/latest

अनुरोध पूरा होने पर, FileUpload संसाधन दिखता है. इसमें स्थिति की जानकारी होती है.

यह चेतावनियों के साथ अपलोड किए गए डेटा के लिए, रिस्पॉन्स का उदाहरण है.

{
  "name": "accounts/123456789/dataSources/111222333/fileUploads/latest",
  "dataSourceId": "111222333",
  "processingState": "SUCCEEDED",
  "issues": [
    {
      "title": "Missing recommended attribute",
      "description": "Products are missing a recommended attribute 'description'.",
      "code": "validation/missing_recommended_attribute",
      "count": "5",
      "severity": "WARNING",
      "documentationUri": "https://support.google.com/merchants/answer/6324468"
    }
  ],
  "itemsTotal": "100",
  "itemsCreated": "90",
  "itemsUpdated": "10",
  "uploadTime": "2023-10-26T10:30:00Z"
}

यह अपलोड किए जा रहे डेटा के जवाब का उदाहरण है.

{
  "name": "accounts/123456789/dataSources/111222333/fileUploads/latest",
  "dataSourceId": "111222333",
  "processingState": "IN_PROGRESS",
  "uploadTime": "2023-10-26T11:00:00Z"
}

यह अपलोड न हो पाने पर मिले जवाब का उदाहरण है.

{
  "name": "accounts/123456789/dataSources/111222333/fileUploads/latest",
  "dataSourceId": "111222333",
  "processingState": "FAILED",
  "issues": [
    {
      "title": "Invalid file format",
      "description": "The uploaded file is not a valid XML or CSV file.",
      "code": "validation/invalid_file_format",
      "count": "1",
      "severity": "ERROR",
      "documentationUri": "https://support.google.com/merchants/answer/188494"
    }
  ],
  "uploadTime": "2023-10-26T11:15:00Z"
}

यहां दिए गए कोड सैंपल में, fileUploads.get एलियास के साथ fileUploads.get तरीके का इस्तेमाल करके, हाल ही में अपलोड की गई फ़ाइल की स्थिति पाने का तरीका बताया गया है.latest

Java

import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.datasources.v1.FileUpload;
import com.google.shopping.merchant.datasources.v1.FileUploadName;
import com.google.shopping.merchant.datasources.v1.FileUploadsServiceClient;
import com.google.shopping.merchant.datasources.v1.FileUploadsServiceSettings;
import com.google.shopping.merchant.datasources.v1.GetFileUploadRequest;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;

/** This class demonstrates how to get the latest data source file upload. */
public class GetFileUploadSample {

  public static void getFileUpload(Config config, String datasourceId) throws Exception {

    // Obtains OAuth token based on the user's configuration.
    GoogleCredentials credential = new Authenticator().authenticate();

    // Creates service settings using the credentials retrieved above.
    FileUploadsServiceSettings fileUploadsServiceSettings =
        FileUploadsServiceSettings.newBuilder()
            .setCredentialsProvider(FixedCredentialsProvider.create(credential))
            .build();

    // Creates FileUpload name with datasource id to identify datasource.
    String name =
        FileUploadName.newBuilder()
            .setAccount(config.getAccountId().toString())
            .setDatasource(datasourceId)
            .setFileupload("latest")
            .build()
            .toString();

    // Calls the API and catches and prints any network failures/errors.
    try (FileUploadsServiceClient fileUploadsServiceClient =
        FileUploadsServiceClient.create(fileUploadsServiceSettings)) {

      // The name has the format: accounts/{account}/datasources/{datasource}/fileUploads/latest
      GetFileUploadRequest request = GetFileUploadRequest.newBuilder().setName(name).build();

      System.out.println("Sending get FileUpload request:");
      FileUpload response = fileUploadsServiceClient.getFileUpload(request);

      System.out.println("Retrieved FileUpload below");
      System.out.println(response);
      //   return response;
    } catch (Exception e) {
      System.out.println(e);
    }
  }

  public static void main(String[] args) throws Exception {
    Config config = Config.load();
    // An ID assigned to a datasource by Google.
    String datasourceId = "123456789";

    getFileUpload(config, datasourceId);
  }
}
GetFileUploadSample.java

cURL

curl \
"https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}/fileUploads/latest" \
-H "Authorization: Bearer <API_TOKEN>" \
-H "Content-Type: application/json"

डेटा सोर्स को तुरंत फ़ेच करना

इस तरीके से, फ़ाइल पर आधारित डेटा सोर्स को तुरंत फ़ेच और प्रोसेस करने का अनुरोध किया जा सकता है. इसके लिए, dataSources.fetch तरीके का इस्तेमाल करें. अगर आपने सोर्स फ़ाइल अपडेट की है और आपको Google से अगली फ़ेचिंग के शेड्यूल से पहले ही उसे वापस पाने का अनुरोध करना है, तो इस विकल्प का इस्तेमाल करें.

ध्यान दें: इस तरीके का इस्तेमाल सही तरीके से किया जाना चाहिए. dataSources.fetch तरीके में कोटे की सीमाएं कम होती हैं. साथ ही, पूरे डेटा सोर्स को फिर से प्रोसेस करने में काफ़ी समय (संभवतः कई घंटे) लग सकता है. यह समय, डेटा सोर्स के साइज़ पर निर्भर करता है. नियमित तौर पर अपडेट करने के लिए, खास तौर पर बार-बार अपडेट करने के लिए, Products sub-API का इस्तेमाल करें. इससे प्रॉडक्ट डेटा को सीधे तौर पर अपडेट किया जा सकता है. इसकी मदद से, अलग-अलग प्रॉडक्ट की जानकारी भी अपडेट की जा सकती है.

POST https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}:fetch

फ़ेच करने का अनुरोध पूरा होने पर, कोई जवाब नहीं मिलता, क्योंकि प्रोसेसिंग एसिंक्रोनस तरीके से होती है. fileUploads.get तरीके का इस्तेमाल करके, इस कार्रवाई के नतीजे पर नज़र रखी जा सकती है. इस तरीके के बारे में ऊपर बताया गया है.

यहां दिए गए कोड सैंपल में, dataSources.fetch तरीके का इस्तेमाल करके, किसी डेटा सोर्स को तुरंत फ़ेच करने का अनुरोध करने का तरीका बताया गया है.

Java

import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.datasources.v1.DataSourceName;
import com.google.shopping.merchant.datasources.v1.DataSourcesServiceClient;
import com.google.shopping.merchant.datasources.v1.DataSourcesServiceSettings;
import com.google.shopping.merchant.datasources.v1.FetchDataSourceRequest;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;

/**
 * This class demonstrates how to fetch a specific FileInput DataSource for a given Merchant Center
 * account.
 */
public class FetchFileDataSourceSample {

  public static void fetchDataSource(Config config, String dataSourceId) throws Exception {

    // Obtains OAuth token based on the user's configuration.
    GoogleCredentials credential = new Authenticator().authenticate();

    // Creates service settings using the credentials retrieved above.
    DataSourcesServiceSettings dataSourcesServiceSettings =
        DataSourcesServiceSettings.newBuilder()
            .setCredentialsProvider(FixedCredentialsProvider.create(credential))
            .build();

    // Creates datasource name to identify datasource.
    String name =
        DataSourceName.newBuilder()
            .setAccount(config.getAccountId().toString())
            .setDatasource(dataSourceId)
            .build()
            .toString();

    // Calls the API and catches and prints any network failures/errors.
    try (DataSourcesServiceClient dataSourcesServiceClient =
        DataSourcesServiceClient.create(dataSourcesServiceSettings)) {

      // The name has the format: accounts/{account}/datasources/{datasource}
      FetchDataSourceRequest request = FetchDataSourceRequest.newBuilder().setName(name).build();

      System.out.println("Sending FETCH DataSource request:");
      // Fetch works ONLY for FileInput DataSource type.
      dataSourcesServiceClient.fetchDataSource(request); // No response returned on success

      System.out.println("Successfully fetched DataSource.");

    } catch (Exception e) {
      System.out.println(e);
      System.exit(1);
    }
  }

  public static void main(String[] args) throws Exception {
    Config config = Config.load();
    String datasourceId = "<DATASOURCE_ID>"; // Replace with your FileInput DataSource ID.

    fetchDataSource(config, datasourceId);
  }
}
FetchFileDataSourceSample.java

cURL

curl -X POST \
"https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}:fetch" \
-H "Authorization: Bearer <API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{}'