यह कैसे काम करता है

परिचय

ज़ीरो-टच रजिस्ट्रेशन एपीआई की मदद से, डिवाइस के रीसेलर अपने इंटिग्रेशन को ऑटोमेट कर सकते हैं. आपके संगठन के सेल्स टूल, ज़ीरो-टच रजिस्ट्रेशन की सुविधा देते हैं. और आपके ग्राहक भी ज़्यादा बेहतर काम कर सकते हैं. अपने उपयोगकर्ताओं की मदद करने के लिए, एपीआई का इस्तेमाल करें:

• किसी ग्राहक के 'पहले से तैयार डिवाइस' सुविधा वाले खाते के लिए, खरीदे गए डिवाइस असाइन करें.
• अपने ग्राहक के लिए, ज़ीरो-टच नामांकन खाता बनाएं.
• अपने संगठन का टेलीफ़ोन नंबर अटैच करें और डिवाइसों पर ऑर्डर का मेटाडेटा जोड़ें.
• अपने ग्राहकों को असाइन किए गए डिवाइसों के बारे में रिपोर्ट बनाएं.

इस दस्तावेज़ में, एपीआई के बारे में बताया गया है और पैटर्न के बारे में जानकारी दी गई है. अगर आपको एपीआई को खुद एक्सप्लोर करना है, तो Java, .NET या Python के लिए क्विकस्टार्ट गाइड आज़माएं.

एपीआई के सिद्धांत

ग्राहक और डिवाइस, एपीआई में इस्तेमाल किए जाने वाले मुख्य संसाधन हैं. बनाने के लिए ग्राहक, create पर कॉल करें. डिवाइस बनाने के लिए, दावा करने के एपीआई के तरीकों का इस्तेमाल किया जा सकता है (नीचे देखें). आपका संगठन ये काम भी कर सकता है: ज़ीरो-टच रजिस्ट्रेशन की सुविधा वाले पोर्टल का इस्तेमाल करके, ग्राहक और डिवाइस बनाएं.

ग्राहक

वे कंपनियां जिनके लिए आपका संगठन डिवाइस बेचता है. ग्राहकों के पास name और ID है. किसी ग्राहक के डिवाइसों पर दावा करने या उन्हें ढूंढने के लिए, उसका इस्तेमाल करें. ज़्यादा जानने के लिए, Customer देखें.

डिवाइस

ज़ीरो-टच नामांकन की सुविधा वाला ऐसा Android या ChromeOS डिवाइस जिसे आपका संगठन किसी ग्राहक को बेचता है. डिवाइसों के हार्डवेयर आईडी, मेटाडेटा, और ग्राहक होते हैं दावे. डिवाइस, एपीआई के लिए अहम होते हैं. इसलिए, इनका इस्तेमाल ज़्यादातर तरीकों में किया जाता है. ज़्यादा जानने के लिए, Device देखें.

DeviceIdentifier

किसी मैन्युफ़ैक्चरर की पहचान करने के लिए, IMEI या MEID जैसे हार्डवेयर आईडी इनकैप्सुलेट करता है डिवाइस. डिवाइस को टारगेट करने के लिए DeviceIdentifier का इस्तेमाल करें जिसे आपको ढूँढना, अपडेट करना या उस पर दावा करना हो. ज़्यादा जानने के लिए, आइडेंटिफ़ायर लेख पढ़ें.

DeviceMetadata

डिवाइस के लिए, मेटाडेटा के की-वैल्यू पेयर को सेव करता है. अपने संगठन का मेटाडेटा सेव करने के लिए, DeviceMetadata का इस्तेमाल करें. ज़्यादा जानने के लिए, डिवाइस का मेटाडेटा लेख पढ़ें.

आपका ऐप्लिकेशन जिन एपीआई के तरीकों और संसाधनों का इस्तेमाल कर सकता है उन्हें सूची में जोड़ने के लिए, एपीआई का संदर्भ.

ग्राहक बनाना

Android डिवाइसों के लिए, रीसेलर को अपने ग्राहक की ओर से ग्राहक खाता बनाना होगा. ग्राहक इस खाते का इस्तेमाल करके, ज़ीरो-टच पोर्टल को ऐक्सेस करेगा, ताकि वह अपने डिवाइसों के लिए, डिवाइसों को उपलब्ध कराने की सेटिंग को कॉन्फ़िगर कर सके. यह उन ChromeOS डिवाइसों के लिए ज़रूरी नहीं है जिनके पास पहले से ही Google खाता है वह Workspace खाता चुनें जिसका इस्तेमाल करके, वह अपनी प्रॉविज़निंग की सेटिंग कॉन्फ़िगर कर सकेगा.

create एपीआई तरीके को कॉल करके इस तरह बनाया जा सकता है: 'पहले से तैयार डिवाइस' सुविधा के लिए ग्राहक खाते. आपके ग्राहकों को ज़ीरो-टच रजिस्ट्रेशन पोर्टल में कंपनी का नाम दिखता है. इसलिए, आपके ऐप्लिकेशन के उपयोगकर्ता को इस बात की पुष्टि करनी चाहिए कि यह नाम सही है. ग्राहक बनाने के बाद, उसके नाम में बदलाव नहीं किया जा सकता.

मालिकाना हक पाने के लिए, आपको कम से कम एक ऐसा कॉर्पोरेट ईमेल पता देना होगा जो किसी Google खाते से जुड़ा हो. निजी Gmail खातों का इस्तेमाल एपीआई. अगर ग्राहक को खाता जोड़ने में मदद चाहिए, तो निर्देश Google खाता जोड़ें.

एपीआई को कॉल करके ग्राहक बनाने के बाद, वे अपने कर्मचारियों के पोर्टल ऐक्सेस को मैनेज करते हैं. एपीआई का इस्तेमाल करके, अपने ग्राहकों के उपयोगकर्ताओं में बदलाव नहीं किया जा सकता. नीचे दिए गए स्निपेट में, ग्राहक बनाने का तरीका बताया गया है:

// Provide the customer data as a Company type.
// The API requires a name and owners.
Company customer = new Company();
customer.setCompanyName("XYZ Corp");
customer.setOwnerEmails(Arrays.asList("liz@example.com", "darcy@example.com"));
customer.setAdminEmails(Collections.singletonList("jane@example.com"));

// Use our reseller ID for the parent resource name.
String parentResource = String.format("partners/%d", PARTNER_ID);

// Call the API to create the customer using the values in the company object.
CreateCustomerRequest body = new CreateCustomerRequest();
body.setCustomer(customer);
Company response = service.partners().customers().create(parentResource, body).execute();

// Provide the customer data as a Company type.
// The API requires a name and owners.
var customer = new Company
{
    CompanyName = "XYZ Corp",
    OwnerEmails = new String[] { "liz@example.com", "darcy@example.com" },
    AdminEmails = new String[] { "jane@example.com" }
};

// Use our reseller ID for the parent resource name.
var parentResource = String.Format("partners/{0}", PartnerId);

// Call the API to create the customer using the values in the company object.
var body = new CreateCustomerRequest
{
    Customer = customer
};
var request = service.Partners.Customers.Create(body, parentResource);
var response = request.Execute();

# Provide the customer data as a Company type. The API requires
# a name and at least one owner.
company = {'companyName':'XYZ Corp', \
  'ownerEmails':['liz@example.com', 'darcy@example.com'], \
  'adminEmails':['jane@example.com']}

# Use our reseller ID for the parent resource name.
parent_resource = 'partners/{0}'.format(PARTNER_ID)

# Call the API to create the customer using the values in the company object.
response = service.partners().customers().create(parent=parent_resource,
    body={'customer':company}).execute()

अपने ग्राहक के कर्मचारियों के लिए मालिक और एडमिन की भूमिकाओं के बारे में ज़्यादा जानने के लिए, पोर्टल उपयोगकर्ता पढ़ें.

ग्राहकों के डिवाइसों पर दावा करना

जब आपके ग्राहक डिवाइस खरीद लेंगे, तब वे प्रावधान को कॉन्फ़िगर करना चाहेंगे सेटिंग मैनेज करने की सुविधा देती है. किसी डिवाइस पर दावा करने से डिवाइस जुड़ जाता है ज़ीरो-टच रजिस्ट्रेशन की सुविधा देता है और ग्राहक को प्रावधान करने की सेटिंग.

डिवाइस के प्रावधान रिकॉर्ड में, 'पहले से तैयार डिवाइस' सुविधा के लिए एक सेक्शन है. किसी ग्राहक के लिए, रिकॉर्ड के ज़ीरो-टच रजिस्ट्रेशन सेक्शन पर दावा करके, डिवाइस असाइन किया जा सकता है. partners.devices.claim या partners.devices.claimAsync तरीकों को कॉल करें. इसके लिए, आर्ग्युमेंट के तौर पर ग्राहक का नाम दें. sectionType के लिए, वैल्यू के तौर पर हमेशा SECTION_TYPE_ZERO_TOUCH सबमिट करें.

इससे पहले कि आप ऐसा कर सकें, आपको ग्राहक के डिवाइस से दावा (नीचे देखें) करना होगा किसी अन्य ग्राहक के लिए एक ही डिवाइस का दावा करें. दावा करने के तरीके DeviceIdentifier फ़ील्ड की पुष्टि करें, जैसे, IMEI या MEID या सीरियल नंबर, मैन्युफ़ैक्चरर का नाम और मॉडल, और नया डिवाइस बनाते समय, ChromeOS डिवाइसों के लिए प्रमाणित किया गया डिवाइस आईडी.

नीचे दिए गए स्निपेट में, किसी डिवाइस पर दावा करने का तरीका बताया गया है:

// Identify the device to claim.
DeviceIdentifier identifier = new DeviceIdentifier();
// The manufacturer value is optional but recommended for cellular devices
identifier.setManufacturer("Google");
identifier.setImei("098765432109875");

// Create the body to connect the customer with the device.
ClaimDeviceRequest body = new ClaimDeviceRequest();
body.setDeviceIdentifier(identifier);
body.setCustomerId(customerId);
body.setSectionType("SECTION_TYPE_ZERO_TOUCH");

// Claim the device.
ClaimDeviceResponse response = service.partners().devices().claim(PARTNER_ID, body).execute();

// Identify the device to claim.
var deviceIdentifier = new DeviceIdentifier
{
    // The manufacturer value is optional but recommended for cellular devices
    Manufacturer = "Google",
    Imei = "098765432109875"
};

// Create the body to connect the customer with the device.
ClaimDeviceRequest body = new ClaimDeviceRequest
{
    DeviceIdentifier = deviceIdentifier,
    CustomerId = CustomerId,
    SectionType = "SECTION_TYPE_ZERO_TOUCH"
};

// Claim the device.
var response = service.Partners.Devices.Claim(body, PartnerId).Execute();

# Identify the device to claim.
# The manufacturer value is optional but recommended for cellular devices
device_identifier = {'manufacturer':'Google', 'imei':'098765432109875'}

# Create the body to connect the customer with the device.
request_body = {'deviceIdentifier':device_identifier, \
    'customerId':customer_id, \
    'sectionType':'SECTION_TYPE_ZERO_TOUCH'}

# Claim the device.
response = service.partners().devices().claim(partnerId=PARTNER_ID,
    body=request_body).execute()

डिवाइसों पर दावा हटाना

आपका संगठन, ग्राहक के डिवाइस पर दावा हटा सकता है. डिवाइस से दावा हटाना इसे 'पहले से तैयार डिवाइस' सुविधा से हटा दिया जाता है. रीसेलर ऐसे डिवाइस पर दावा कर सकता है जिसे वे किसी दूसरे खाते में माइग्रेट करना चाहते हैं, वापस लौटना चाहते हैं या जिस पर गलती से दावा किया गया था. किसी ग्राहक के डिवाइस पर से दावा हटाने के लिए, partners.devices.unclaim या partners.devices.unclaimAsync वाले तरीके को कॉल करें.

विक्रेता

वेंडर का इस्तेमाल, अपने डीलर नेटवर्क में रीसेलर पार्टनर, ग्लोबल रीसेलर नेटवर्क में स्थानीय ऑपरेटर या आपकी ओर से डिवाइस बेचने वाले किसी भी संगठन को दिखाने के लिए किया जा सकता है. वेंडर की मदद से अपने उपयोगकर्ताओं, ग्राहकों, और डिवाइस:

• आपके बनाए गए वेंडर, आपके पहले से तैयार डिवाइस के लिए बनाए गए खाते या एक-दूसरे के खाते नहीं देख सकते.
• आपके पास अपने वेंडर के ग्राहकों और डिवाइसों को देखने का विकल्प होता है. साथ ही, आपके पास वेंडर के डिवाइसों का रजिस्ट्रेशन रद्द करने का विकल्प भी होता है. हालांकि, अपने वेंडर को डिवाइस असाइन नहीं किए जा सकते ग्राहकों.

अपने संगठन के लिए वेंडर बनाना — इसके लिए, एपीआई का इस्तेमाल नहीं किया जा सकता. नया वेंडर बनाने के लिए, आपके खाते की भूमिका मालिक होनी चाहिए. अगर आपके संगठन में वेंडर हैं, आप partners.vendors.list पर कॉल करके वेंडर और partners.vendors.customers.list का विकल्प चुनें. नीचे दिए गए उदाहरण में इन दोनों तरीकों का इस्तेमाल किया गया है वेंडर के लिए सेवा की शर्तें दिखाने वाली रिपोर्ट को प्रिंट करने के लिए ग्राहक:

// First, get the organization's vendors.
String parentResource = String.format("partners/%d", PARTNER_ID);
ListVendorsResponse results = service.partners().vendors().list(parentResource).execute();
if (results.getVendors() == null) {
  return;
}

// For each vendor, report the company name and a maximum 5 customers.
for (Company vendor: results.getVendors()) {
  System.out.format("\n%s customers\n", vendor.getCompanyName());
  System.out.println("---");
  // Use the vendor's API resource name as the parent resource.
  AndroidProvisioningPartner.Partners.Vendors.Customers.List customerRequest =
      service.partners().vendors().customers().list(vendor.getName());
  customerRequest.setPageSize(5);
  ListVendorCustomersResponse customerResponse = customerRequest.execute();

  List<Company> customers = customerResponse.getCustomers();
  if (customers == null) {
    System.out.println("No customers");
    break;
  } else {
    for (Company customer: customers) {
      System.out.format("%s: %s\n",
          customer.getCompanyName(),
          customer.getTermsStatus());
    }
  }
}

// First, get the organization's vendors.
var parentResource = String.Format("partners/{0}", PartnerId);
var results = service.Partners.Vendors.List(parentResource).Execute();
if (results.Vendors == null)
{
    return;
}

// For each vendor, report the company name and a maximum 5 customers.
foreach (Company vendor in results.Vendors)
{
    Console.WriteLine("\n{0} customers", vendor);
    Console.WriteLine("---");
    // Use the vendor's API resource name as the parent resource.
    PartnersResource.VendorsResource.CustomersResource.ListRequest customerRequest =
        service.Partners.Vendors.Customers.List(vendor.Name);
    customerRequest.PageSize = 5;
    var customerResponse = customerRequest.Execute();

    IList<Company> customers = customerResponse.Customers;
    if (customers == null)
    {
        Console.WriteLine("No customers");
        break;
    }
    else
    {
        foreach (Company customer in customers)
        {
            Console.WriteLine("{0}: {1}", customer.Name, customer.TermsStatus);
        }
    }
}

# First, get the organization's vendors.
parent_resource = 'partners/{0}'.format(PARTNER_ID)
vendor_response = service.partners().vendors().list(
    parent=parent_resource).execute()
if 'vendors' not in vendor_response:
  return

# For each vendor, report the company name and a maximum 5 customers.
for vendor in vendor_response['vendors']:
  print '\n{0} customers'.format(vendor['companyName'])
  print '---'
  # Use the vendor's API resource name as the parent resource.
  customer_response = service.partners().vendors().customers().list(
      parent=vendor['name'], pageSize=5).execute()
  if 'customers' not in customer_response:
    print 'No customers'
    break
  for customer in customer_response['customers']:
    print '  {0}: {1}'.format(customer['name'], customer['termsStatus'])

अगर आपके पास कई डिवाइस हैं, तो आपको यह जानना पड़ सकता है कि किस रीसेलर या वेंडर ने डिवाइस पर दावा किया है. अंकों वाला रीसेलर आईडी पाने के लिए, डिवाइस के दावे के रिकॉर्ड में resellerId फ़ील्ड की वैल्यू देखें.

आपका संगठन, वेंडर के दावे वाले डिवाइस पर से दावा हटा सकता है. ऐसे अन्य एपीआई कॉल के लिए डिवाइस में बदलाव करें, तो आपको यह जांच करनी चाहिए कि आपके संगठन ने डिवाइस पर दावा किया है या नहीं देख लें. नीचे दिए गए उदाहरण में बताया गया है कि ऐसा कैसे किया जा सकता है:

// Get the devices claimed for two customers: one of our organization's
// customers and one of our vendor's customers.
FindDevicesByOwnerRequest body = new FindDevicesByOwnerRequest();
body.setSectionType("SECTION_TYPE_ZERO_TOUCH");
body.setCustomerId(Arrays.asList(resellerCustomerId, vendorCustomerId));
body.setLimit(MAX_PAGE_SIZE);
FindDevicesByOwnerResponse response =
    service.partners().devices().findByOwner(PARTNER_ID, body).execute();
if (response.getDevices() == null) {
  return;
}

for (Device device: response.getDevices()) {
  // Confirm the device was claimed by our reseller and not a vendor before
  // updating metadata in another method.
  for (DeviceClaim claim: device.getClaims()) {
    if (claim.getResellerId() == PARTNER_ID) {
      updateDeviceMetadata(device.getDeviceId());
      break;
    }
  }
}

// Get the devices claimed for two customers: one of our organization's
// customers and one of our vendor's customers.
FindDevicesByOwnerRequest body = new FindDevicesByOwnerRequest
{
    Limit = MaxPageSize,
    SectionType = "SECTION_TYPE_ZERO_TOUCH",
    CustomerId = new List<long?>
    {
        resellerCustomerId,
        vendorCustomerId
    }
};
var response = service.Partners.Devices.FindByOwner(body, PartnerId).Execute();
if (response.Devices == null)
{
    return;
}

foreach (Device device in response.Devices)
{
    // Confirm the device was claimed by our reseller and not a vendor before
    // updating metadata in another method.
    foreach (DeviceClaim claim in device.Claims)
    {
        if (claim.ResellerId == PartnerId)
        {
            UpdateDeviceMetadata(device.DeviceId);
            break;
        }
    }
}

# Get the devices claimed for two customers: one of our organization's
# customers and one of our vendor's customers.
request_body = {'limit':MAX_PAGE_SIZE, \
  'pageToken':None, \
  'customerId':[reseller_customer_id, vendor_customer_id], \
  'sectionType':'SECTION_TYPE_ZERO_TOUCH'}
response = service.partners().devices().findByOwner(partnerId=PARTNER_ID,
    body=request_body).execute()

for device in response['devices']:
  # Confirm the device was claimed by our reseller and not a vendor before
  # updating metadata in another method.
  for claim in device['claims']:
    if claim['resellerId'] == PARTNER_ID:
      update_device_metadata(device['deviceId'])
      break

लंबे समय तक चलने वाले बैच ऑपरेशन

एपीआई में, डिवाइस के तरीकों के एसिंक्रोनस वर्शन शामिल होते हैं. इन तरीकों से, कई डिवाइसों को एक साथ प्रोसेस किया जा सकता है. वहीं, सिंक्रोनस तरीकों से, हर एपीआई अनुरोध के लिए एक डिवाइस को प्रोसेस किया जाता है. एसिंक्रोनस तरीके के नाम एक साथ काम नहीं करने वाली प्रोसेस में सफ़िक्स होता है, उदाहरण के लिए claimAsync.

एसिंक्रोनस एपीआई के तरीके, प्रोसेस पूरी होने से पहले नतीजा दिखाते हैं. असाइनॉन्स तरीके से, लंबे समय तक चलने वाले ऑपरेशन के पूरा होने का इंतज़ार करते समय, आपके ऐप्लिकेशन (या टूल) के उपयोगकर्ताओं को रिस्पॉन्सिव अनुभव मिलता है. आपके ऐप्लिकेशन को चाहिए समय-समय पर कार्रवाई की स्थिति की जांच करें.

ऑपरेशंस

लंबे समय तक चलने वाले बैच ऑपरेशन को ट्रैक करने के लिए, Operation का इस्तेमाल किया जाता है. ऐप्लिकेशन किसी एसिंक्रोनस तरीके को पूरा करने वाला कॉल, ऑपरेशन का रेफ़रंस देता है डालें. नीचे दिया गया JSON स्निपेट, कॉल करने के बाद आम तौर पर मिलने वाला जवाब दिखाता है updateMetadataAsync:

{
  "name": "operations/apibatchoperation/1234567890123476789"
}

हर कार्रवाई में अलग-अलग टास्क की एक सूची होती है. ऑपरेशन में शामिल टास्क की स्थिति और नतीजों के बारे में जानने के लिए, operations.get को कॉल करें. नीचे दिए गए स्निपेट में, ऐसा करने का तरीका बताया गया है. आपको अपने ऐप्लिकेशन में, किसी भी तरह की गड़बड़ी को मैनेज करना होगा.

// Build out the request body to apply the same order number to a customer's
// purchase of 2 devices.
UpdateMetadataArguments firstUpdate = new UpdateMetadataArguments();
firstUpdate.setDeviceMetadata(metadata);
firstUpdate.setDeviceId(firstTargetDeviceId);

UpdateMetadataArguments secondUpdate = new UpdateMetadataArguments();
secondUpdate.setDeviceMetadata(metadata);
secondUpdate.setDeviceId(firstTargetDeviceId);

// Start the device metadata update.
UpdateDeviceMetadataInBatchRequest body = new UpdateDeviceMetadataInBatchRequest();
body.setUpdates(Arrays.asList(firstUpdate, secondUpdate));
Operation response = service
    .partners()
    .devices()
    .updateMetadataAsync(PARTNER_ID, body)
    .execute();

// Assume the metadata update started, so get the Operation for the update.
Operation operation = service.operations().get(response.getName()).execute();

// Build out the request body to apply the same order number to a customer's
// purchase of 2 devices.
var updates = new List<UpdateMetadataArguments>
{
    new UpdateMetadataArguments
    {
        DeviceMetadata = metadata,
        DeviceId = firstTargetDeviceId
    },
    new UpdateMetadataArguments
    {
        DeviceMetadata = metadata,
        DeviceId = secondTargetDeviceId
    }
};

// Start the device metadata update.
UpdateDeviceMetadataInBatchRequest body = new UpdateDeviceMetadataInBatchRequest
{
    Updates = updates
};
var response = service.Partners.Devices.UpdateMetadataAsync(body, PartnerId).Execute();

// Assume the metadata update started, so get the Operation for the update.
Operation operation = service.Operations.Get(response.Name).Execute();

# Build out the request body to apply the same order number to a customer's
# purchase of 2 devices.
updates = [{'deviceMetadata':metadata,'deviceId':first_target_device_id},
    {'deviceMetadata':metadata,'deviceId':second_target_device_id}]

# Start the device metadata update.
response = service.partners().devices().updateMetadataAsync(
    partnerId=PARTNER_ID, body={'updates':updates}).execute()

# Assume the metadata update started, so get the Operation for the update.
operation = service.operations().get(name=response['name']).execute()

यह जानने के लिए कि कोई कार्रवाई खत्म हुई या नहीं, done फ़ील्ड के लिए कार्रवाई देखें true की वैल्यू डालें. अगर done मौजूद नहीं है या false है, तो इसका मतलब है कि कार्रवाई अब भी जारी है.

जवाब

कोई ऑपरेशन पूरा होने के बाद, एपीआई उस ऑपरेशन को नतीजे के साथ अपडेट करता है. भले ही, सभी टास्क पूरे हो गए हों या कोई भी टास्क पूरा न हुआ हो. response फ़ील्ड DevicesLongRunningOperationResponse एक ऑब्जेक्ट है, जो ऑपरेशन के दौरान हर डिवाइस की प्रोसेसिंग का ब्यौरा देता है.

successCount फ़ील्ड की जांच करके, यह पता लगाएं कि कोई टास्क पूरा हुआ या नहीं. इससे, बड़ी नतीजों की सूचियों को दोहराने से बचा जा सकता है. DevicesLongRunningOperationResponse का perDeviceStatus फ़ील्ड, OperationPerDevice इंस्टेंस की सूची है. इसमें ऑपरेशन में शामिल हर डिवाइस की जानकारी होती है. सूची का क्रम, मूल अनुरोध में मौजूद टास्क से मेल खाता है.

हर OperationPerDevice टास्क में result फ़ील्ड और रिमाइंडर की खास जानकारी शामिल होती है सर्वर को मिले अनुरोध का. result फ़ील्ड का इस्तेमाल करके देखें कि टास्क पूरा हुआ या नहीं.

नीचे दिया गया JSON स्निपेट किसी कार्रवाई से मिलने वाले सामान्य जवाब का हिस्सा दिखाता है updateMetadataAsync को किया गया कॉल:

"response": {
  "perDeviceStatus": [
    {
      "result": {
        "deviceId": "12345678901234567",
        "status": "SINGLE_DEVICE_STATUS_SUCCESS"
      },
      "updateMetadata": {
        "deviceId": "12345678901234567",
        "deviceMetadata": {
          "entries": {
            "phonenumber": "+1 (800) 555-0100"
          }
        }
      }
    }
  ],
  "successCount": 1
}

प्रोग्रेस को ट्रैक करें

अगर आपके ऐप्लिकेशन को प्रोग्रेस को ट्रैक करने की ज़रूरत है, तो आपको समय-समय पर कार्रवाई. metadata फ़ील्ड में DevicesLongRunningOperationMetadata इंस्टेंस का इस्तेमाल करें. इससे आपके ऐप्लिकेशन को चल रही कार्रवाई की नई प्रोग्रेस देखने में मदद मिलती है. ऑपरेशन की प्रोग्रेस ट्रैक करने के लिए, यहां दी गई टेबल में दिए गए DevicesLongRunningOperationMetadata के फ़ील्ड का इस्तेमाल करें:

यहां दिए गए आसान उदाहरण में बताया गया है कि कोई ऐप्लिकेशन, पोलिंग इंटरवल सेट करने के लिए प्रोग्रेस मेटाडेटा का इस्तेमाल कैसे कर सकता है. आपके ऐप्लिकेशन में, पोलिंग के लिए ज़्यादा बेहतर टास्क रननर की ज़रूरत पड़ सकती है. आपको गड़बड़ी को मैनेज करने की सुविधा भी जोड़नी होगी.

// Milliseconds between polling the API.
private static long MIN_INTERVAL = 2000;
private static long MAX_INTERVAL = 10000;

// ...
// Start the device metadata update.
Operation response = service
    .partners()
    .devices()
    .updateMetadataAsync(PARTNER_ID, body)
    .execute();
String operationName = response.getName();

// Start polling for completion.
long startTime = new Date().getTime();
while (true) {

  // Get the latest update on the operation's progress using the API.
  Operation operation = service.operations().get(operationName).execute();

  if (operation.get("done") != null && operation.getDone()) {
    // The operation is finished. Print the status.
    System.out.format("Operation complete: %s of %s successful device updates\n",
        operation.getResponse().get("successCount"),
        operation.getMetadata().get("devicesCount"));
    break;

  } else {
    // Estimate how long the operation *should* take - within min and max value.
    BigDecimal opProgress = (BigDecimal) operation.getMetadata().get("progress");
    double progress = opProgress.longValue();
    long interval = MAX_INTERVAL;
    if (progress > 0) {
      interval = (long) ((new Date().getTime() - startTime) *
          ((100.0 - progress) / progress));
    }
    interval = Math.max(MIN_INTERVAL, Math.min(interval, MAX_INTERVAL));

    // Sleep until the operation should be complete.
    Thread.sleep(interval);
  }
}

// Milliseconds between polling the API.
private static double MinInterval = 2000;
private static double MaxInterval = 10000;

// ...
// Start the device metadata update.
var response = service.Partners.Devices.UpdateMetadataAsync(body, PartnerId).Execute();
var operationName = response.Name;

// Start polling for completion.
var startTime = DateTime.Now;
while (true)
{

    // Get the latest update on the operation's progress using the API.
    Operation operation = service.Operations.Get(operationName).Execute();

    if (operation.Done == true)
    {
        // The operation is finished. Print the status.
        Console.WriteLine("Operation complete: {0} of {1} successful device updates",
                          operation.Response["successCount"],
                          operation.Metadata["devicesCount"]);
        break;
    }
    else
    {
        // Estimate how long the operation *should* take - within min and max value.
        double progress = (double)(long)operation.Metadata["progress"];
        double interval = MaxInterval;
        if (progress > 0)
        {
            interval = DateTime.Now.Subtract(startTime).TotalMilliseconds *
                                     ((100.0 - progress) / progress);
        }
        interval = Math.Max(MinInterval, Math.Min(interval, MaxInterval));

        // Sleep until the operation should be complete.
        System.Threading.Thread.Sleep((int)interval);
    }
}

# Seconds between polling the API.
MIN_INTERVAL = 2;
MAX_INTERVAL = 10;

# ...
# Start the device metadata update
response = service.partners().devices().updateMetadataAsync(
  partnerId=PARTNER_ID, body={'updates':updates}).execute()

op_name = response['name']
start_time = time.time()

# Start polling for completion
while True:
  # Get the latest update on the operation's progress using the API
  op = service.operations().get(name=op_name).execute()

  if 'done' in op and op['done']:
    # The operation is finished. Print the status.
    print('Operation complete: {0} of {1} successful device updates'.format(
      op['response']['successCount'], op['metadata']['devicesCount']
    ))
    break
  else:
    # Estimate how long the operation *should* take - within min and max.
    progress = op['metadata']['progress']
    interval = MIN_INTERVAL
    if progress > 0:
      interval = (time.time() - start_time) * ((100.0 - progress) / progress)
    interval = max(MIN_INTERVAL, min(interval, MAX_INTERVAL))

    # Sleep until the operation should be complete.
    time.sleep(interval)

पोलिंग का ऐसा तरीका चुनें जो आपके ऐप्लिकेशन के उपयोगकर्ताओं के लिए सही हो. अगर ऐप्लिकेशन के कुछ उपयोगकर्ता किसी प्रोसेस के पूरी होने का इंतज़ार कर रहे हैं, तो उन्हें प्रोग्रेस के बारे में नियमित अपडेट मिलने से फ़ायदा हो सकता है.

पेज किए गए नतीजे

partners.devices.findByOwner एपीआई का तरीका डिवाइस की बहुत बड़ी सूची दिखा सकता है. रिस्पॉन्स का साइज़ कम करने के लिए, यह और एपीआई के अन्य तरीके (जैसे कि partners.devices.findByIdentifier) सहायता पेज पर मौजूद नतीजे. पेज वाले नतीजों की मदद से, आपका ऐप्लिकेशन बार-बार बड़ी सूचियों को एक बार में एक पेज पर देखने और उन्हें प्रोसेस करने की सुविधा मिलती है.

एपीआई मेथड को कॉल करने के बाद, देखें कि जवाब में nextPageToken. अगर nextPageToken null नहीं है, तो आपका ऐप्लिकेशन इस जानकारी का इस्तेमाल करके, डिवाइसों का दूसरा पेज फ़ेच कर सकता है. इसके लिए, उसे फिर से इस तरीके को कॉल करना होगा. आपको इस सीमा में डिवाइस की संख्या के लिए ऊपरी सीमा सेट करनी होगी limit पैरामीटर. अगर nextPageToken null है, तो इसका मतलब है कि आपके ऐप्लिकेशन ने आखिरी पेज का अनुरोध किया है.

नीचे दिए गए तरीके का उदाहरण यह दिखाता है कि आपका ऐप्लिकेशन डिवाइस की सूची को कैसे प्रिंट कर सकता है, एक उदाहरण के तौर पर एक बार में कई पेज होने चाहिए:

private static long MAX_PAGE_SIZE = 10;

// ...
/**
 * Demonstrates how to loop through paginated lists of devices.
 * @param pageToken       The token specifying which result page to return.
 * @throws IOException    If the zero-touch API call fails.
 */
private void printDevices(String pageToken) throws IOException {

  // Create the request body to find the customer's devices.
  FindDevicesByOwnerRequest body = new FindDevicesByOwnerRequest();
  body.setLimit(MAX_PAGE_SIZE);
  body.setSectionType("SECTION_TYPE_ZERO_TOUCH");
  body.setCustomerId(Collections.singletonList(targetCustomerId));

  // Call the API to get a page of Devices. Send a page token from the method
  // argument (might be None). If the page token is None, the API returns the first page.
  FindDevicesByOwnerResponse response =
      service.partners().devices().findByOwner(PARTNER_ID, body).execute();
  if (response.getDevices() == null) {
    return;
  }

  // Print the devices included in this page of results.
  for (Device device: response.getDevices()) {
    System.out.format("Device %s\n", device.getName());
  }
  System.out.println("---");

  // Check to see if another page of devices is available. If yes,
  // fetch and print the devices.
  if (response.getNextPageToken() != null) {
    this.printDevices(response.getNextPageToken());
  }
}

// ...
// Pass null to start printing the first page of devices.
printDevices(null);

private static int MaxPageSize = 10;

// ...
/// <summary>Demonstrates how to loop through paginated lists of devices.</summary>
/// <param name="pageToken">The token specifying which result page to return.</param>
private void PrintDevices(string pageToken)
{
    // Create the request body to find the customer's devices.
    FindDevicesByOwnerRequest body = new FindDevicesByOwnerRequest
    {
        PageToken = pageToken,
        Limit = MaxPageSize,
        SectionType = "SECTION_TYPE_ZERO_TOUCH",
        CustomerId = new List<long?>
        {
            targetCustomerId
        }
    };

    // Call the API to get a page of Devices. Send a page token from the method
    // argument (might be None). If the page token is None, the API returns the first page.
    var response = service.Partners.Devices.FindByOwner(body, PartnerId).Execute();
    if (response.Devices == null)
    {
        return;
    }

    // Print the devices included in this page of results.
    foreach (Device device in response.Devices)
    {
        Console.WriteLine("Device: {0}", device.Name);
    }
    Console.WriteLine("---");

    // Check to see if another page of devices is available. If yes,
    // fetch and print the devices.
    if (response.NextPageToken != null)
    {
        this.PrintDevices(response.NextPageToken);
    }
}

// ...
// Pass null to start printing the first page of devices.
PrintDevices(null);

MAX_PAGE_SIZE = 10;

# ...
def print_devices(page_token):
  """Demonstrates how to loop through paginated lists of devices.

  Args:
    page_token: The token specifying which result page to return.
  """

   # Create the body to find the customer's devices.
  request_body = {'limit':MAX_PAGE_SIZE, \
    'pageToken':page_token, \
    'customerId':[target_customer_id], \
    'sectionType':'SECTION_TYPE_ZERO_TOUCH'}

  # Call the API to get a page of Devices. Send a page token from the method
  # argument (might be None). If the page token is None,
  # the API returns the first page.
  response = service.partners().devices().findByOwner(partnerId=PARTNER_ID,
    body=request_body).execute()

  # Print the devices included in this page of results.
  for device in response['devices']:
    print 'Device: {0}'.format(device['name'])
  print '---'

  # Check to see if another page of devices is available. If yes,
  # fetch and print the devices.
  if 'nextPageToken' in response:
    print_devices(response['nextPageToken'])

# ...
# Pass None to start printing the first page of devices.
print_devices(None);

अगले चरण

अब आपको पता है कि एपीआई कैसे काम करता है. इसलिए, अब इन उदाहरणों को क्विकस्टार्ट के साथ आज़माएं Java, .NET या Python. Google आपके यूआरएल पैरामीटर को कैसे इस्तेमाल करेगा, यह तय करने के लिए देखने के लिए colab एपीआई कॉल के उदाहरण और एपीआई को खुद कॉल करके देखें.