รับเวอร์ชันที่เฉพาะเจาะจงของทรัพยากร

ทรัพยากรทุกรายการจะมีช่องเวอร์ชันที่เปลี่ยนทุกครั้งที่ทรัพยากรมีการเปลี่ยนแปลง ซึ่งก็คือช่อง etag ETag เป็นส่วนมาตรฐานของ HTTP และ Google ปฏิทิน API รองรับ ETag ใน 2 กรณีต่อไปนี้

• เมื่อมีการแก้ไขทรัพยากร เพื่อให้แน่ใจว่าไม่มีการเขียนทรัพยากรนี้ในระหว่างนั้น (การแก้ไขแบบมีเงื่อนไข)
• เมื่อมีการดึงข้อมูลทรัพยากร เพื่อดึงข้อมูลเฉพาะในกรณีที่ทรัพยากรมีการเปลี่ยนแปลง (การดึงข้อมูลแบบมีเงื่อนไข)

การแก้ไขแบบมีเงื่อนไข

หากต้องการอัปเดตหรือลบทรัพยากรเฉพาะในกรณีที่ทรัพยากรไม่มีการเปลี่ยนแปลงนับตั้งแต่ที่คุณดึงข้อมูลครั้งล่าสุด คุณสามารถระบุส่วนหัว If-Match ที่มีค่า ETag จากการดึงข้อมูลครั้งก่อนได้ ซึ่งจะช่วยป้องกันการแก้ไขทรัพยากรที่สูญหาย ไคลเอ็นต์สามารถดึงข้อมูลทรัพยากรอีกครั้งและใช้การเปลี่ยนแปลงอีกครั้งได้

หากรายการ (และ ETag ของรายการ) ไม่มีการเปลี่ยนแปลงนับตั้งแต่การดึงข้อมูลครั้งล่าสุด การแก้ไขจะสำเร็จและเซิร์ฟเวอร์จะแสดงผลทรัพยากรเวอร์ชันใหม่พร้อม ETag ใหม่ มิฉะนั้น เซิร์ฟเวอร์จะแสดงผลโค้ดตอบกลับ 412 Precondition Failed

สำคัญ: Calendar API ไม่รองรับการแก้ไขแบบมีเงื่อนไขสำหรับการดำเนินการแทรก แต่หากคุณระบุรหัสทรัพยากรที่กำหนดเอง การดำเนินการจะสำเร็จก็ต่อเมื่อไม่มีรายการที่มีอยู่มีรหัสดังกล่าว

ตัวอย่างต่อไปนี้แสดงวิธีทำการแก้ไขแบบมีเงื่อนไข ด้วย ไลบรารีของไคลเอ็นต์ Java

  private static void run() throws IOException {
    // Create a test event.
    Event event = Utils.createTestEvent(client, "Test Event");
    System.out.println(String.format("Event created: %s", event.getHtmlLink()));

    // Pause while the user modifies the event in the Calendar UI.
    System.out.println("Modify the event's description and hit enter to continue.");
    System.in.read();

    // Modify the local copy of the event.
    event.setSummary("Updated Test Event");

    // Update the event, making sure that we don't overwrite other changes.
    int numAttempts = 0;
    boolean isUpdated = false;
    do {
      Calendar.Events.Update request = client.events().update("primary", event.getId(), event);
      request.setRequestHeaders(new HttpHeaders().setIfMatch(event.getEtag()));
      try {
        event = request.execute();
        isUpdated = true;
      } catch (GoogleJsonResponseException e) {
        if (e.getStatusCode() == 412) {
          // A 412 status code, "Precondition failed", indicates that the etag values didn't
          // match, and the event was updated on the server since we last retrieved it. Use
          // {@link Calendar.Events.Get} to retrieve the latest version.
          Event latestEvent = client.events().get("primary", event.getId()).execute();

          // You may want to have more complex logic here to resolve conflicts. In this sample we're
          // simply overwriting the summary.
          latestEvent.setSummary(event.getSummary());
          event = latestEvent;
        } else {
          throw e;
        }
      }
      numAttempts++;
    } while (!isUpdated && numAttempts <= MAX_UPDATE_ATTEMPTS);

    if (isUpdated) {
      System.out.println("Event updated.");
    } else {
      System.out.println(String.format("Failed to update event after %d attempts.", numAttempts));
    }
  }
ConditionalModificationSample.java

การดึงข้อมูลแบบมีเงื่อนไข

หากต้องการดึงข้อมูลทรัพยากรเฉพาะในกรณีที่ทรัพยากรมีการเปลี่ยนแปลงนับตั้งแต่ที่คุณดึงข้อมูลครั้งล่าสุด คุณสามารถระบุส่วนหัว If-None-Match ที่มีค่า ETag จากการดึงข้อมูลครั้งก่อนได้ หากรายการ (และ ETag ของรายการ) มีการเปลี่ยนแปลงนับตั้งแต่การดึงข้อมูลครั้งล่าสุด เซิร์ฟเวอร์จะแสดงผลทรัพยากรเวอร์ชันใหม่พร้อม ETag ใหม่ มิฉะนั้น เซิร์ฟเวอร์จะแสดงผลโค้ดตอบกลับ 304 Not Modified

หมายเหตุ: มีกรณีพิเศษที่ ETag จะไม่เปลี่ยนแปลง เช่น เมื่อช่องแบบอ่านอย่างเดียวของรายการ `calendarList` มีการเปลี่ยนแปลง (เช่น พร็อพเพอร์ตี้ของปฏิทินหรือ ACL)

ตัวอย่างต่อไปนี้แสดงวิธีทำการดึงข้อมูลแบบมีเงื่อนไข ด้วย ไลบรารีของไคลเอ็นต์ Java:

  private static void run() throws IOException {
    // Create a test event.
    Event event = Utils.createTestEvent(client, "Test Event");
    System.out.println(String.format("Event created: %s", event.getHtmlLink()));

    // Pause while the user modifies the event in the Calendar UI.
    System.out.println("Modify the event's description and hit enter to continue.");
    System.in.read();

    // Fetch the event again if it's been modified.
    Calendar.Events.Get getRequest = client.events().get("primary", event.getId());
    getRequest.setRequestHeaders(new HttpHeaders().setIfNoneMatch(event.getEtag()));
    try {
      event = getRequest.execute();
      System.out.println("The event was modified, retrieved latest version.");
    } catch (GoogleJsonResponseException e) {
      if (e.getStatusCode() == 304) {
        // A 304 status code, "Not modified", indicates that the etags match, and the event has
        // not been modified since we last retrieved it.
        System.out.println("The event was not modified, using local version.");
      } else {
        throw e;
      }
    }
  }
ConditionalRetrievalSample.java