Contacts: update

נדרשת הרשאה

עדכון של איש קשר במקום. דוגמה

בקשה

בקשת HTTP

PUT https://www.googleapis.com/mirror/v1/contacts/id

פרמטרים

שם הפרמטר	רמת המחירים	תיאור
פרמטרים של נתיב
id	string	המזהה של איש הקשר.

אישור

הבקשה הזו דורשת הרשאה ברמת ההיקף הבאה (מידע נוסף על אימות והרשאה).

היקף
https://www.googleapis.com/auth/glass.timeline

גוף הבקשה

בגוף הבקשה, מספקים משאב אנשי קשר עם המאפיינים הבאים:

שם הנכס	ערך	תיאור	הערות
המאפיינים הנדרשים
acceptCommands[].type	string	סוג הפעולה שהפקודה הזו מתייחסת אליה. הערכים המותרים הם: TAKE_A_NOTE – שיתוף פריט בציר הזמן עם תמליל הדיבור של המשתמש מההערה 'Take a note' פקודה קולית בתפריט. POST_AN_UPDATE – שיתוף פריט בציר הזמן עם תמליל הדיבור של המשתמש מהקטע 'פרסום עדכון' פקודה קולית בתפריט.	ניתן לכתיבה
displayName	string	השם שיוצג של איש הקשר הזה.	ניתן לכתיבה
id	string	המזהה של איש הקשר הזה. המזהה נוצר על ידי האפליקציה ומטופל כמו אסימון אטום.	לכתיבה
imageUrls[]	list	קבוצה של כתובות URL של תמונות שיוצגו עבור איש קשר. לרוב אנשי הקשר תהיה תמונה אחת, אבל איש קשר מסוג 'קבוצה' יכול לכלול עד 8 כתובות URL של תמונות, והן יותאמו לגודל וייחתוכ למוזאיקה בצד הלקוח.	לכתיבה
מאפיינים אופציונליים
acceptCommands[]	list	רשימת פקודות בתפריט הקולי שאיש קשר יכול לטפל בהן. ב-Glass מוצגים עד שלושה אנשי קשר לכל פקודה בתפריט הקול. אם יש יותר מ-3, יוצגו שלושת אנשי הקשר עם הערך הגבוה ביותר של priority עבור הפקודה הספציפית הזו.	לכתיבה
acceptTypes[]	list	רשימה של סוגי ה-MIME שנתמכים על ידי איש הקשר. איש הקשר יוצג למשתמש אם אחד מסוגי ה-consentType שלו תואם לאחד מסוגי הקבצים המצורפים בפריט. אם לא צוינו acceptTypes, פרטי איש הקשר יוצגו בכל הפריטים.	ניתן לכתיבה
phoneNumber	string	מספר הטלפון הראשי של איש הקשר. זה יכול להיות מספר מלא, עם קוד המדינה וקידומת האזור, או מספר מקומי.	ניתן לכתיבה
priority	unsigned integer	עדיפות לאיש הקשר כדי לקבוע את הסדר ברשימת אנשי הקשר. אנשי קשר בעדיפות גבוהה יותר יוצגו לפני אנשי קשר בעדיפות נמוכה יותר.	ניתן לכתיבה
speakableName	string	השם של איש הקשר כפי שצריך לבטא אותו. אם צריך לומר את שם איש הקשר הזה כחלק מתפריט להסרת עמימות קולית, השם הזה ישמש כהגייה הצפויה. האפשרות הזו שימושית בשמות של אנשי קשר עם תווים שלא ניתן לבטא אותם, או בשמות שהאיות שלהם בתצוגה לא פונטי.	ניתן לכתיבה
type	string	הסוג של איש הקשר. השדה הזה משמש למיון בממשקי משתמש. הערכים המותרים הם: INDIVIDUAL – מייצג אדם אחד. (זוהי ברירת המחדל) GROUP – מייצג יותר מאדם אחד.	לכתיבה

תשובה

אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר משאב אנשי קשר בגוף התגובה.

דוגמאות

הערה: דוגמאות הקוד הזמינות לשיטה זו לא מייצגות את כל שפות התכנות הנתמכות (רשימת השפות הנתמכות זמינה בדף של ספריות המשתמשים).

Java

משתמשת בספריית הלקוח של Java.

import com.google.api.services.mirror.Mirror;
import com.google.api.services.mirror.model.Contact;

import java.io.IOException;

public class MyClass {
  // ...

  /**
   * Rename an existing contact for the current user.
   * 
   * @param service Authorized Mirror service.
   * @param contactId ID of the contact to rename.
   * @param newDisplayName New displayName for the contact.
   * @return Patched contact on success, {@code null} otherwise.
   */
  public static Contact renameContact(Mirror service, String contactId, String newDisplayName) {
    try {
      // Get the latest version of the contact from the API.
      Contact contact = service.contacts().get(contactId).execute();

      contact.setDisplayName(newDisplayName);
      // Send an update request to the API.
      return service. contacts().update(contactId, contact).execute();
    } catch (IOException e) {
      System.err.println("An error occurred: " + e);
      return null;
    }
  }

  // ...
}

‎.NET

משתמש בספריית הלקוח של NET..

using System;

using Google.Apis.Mirror.v1;
using Google.Apis.Mirror.v1.Data;

public class MyClass {
  // ...

  /// <summary>
  /// Rename an existing contact for the current user.
  /// </summary>
  /// <param name='service'>Authorized Mirror service.</param>
  /// <param name='contactId'>ID of the contact to rename.</param>
  /// <param name='newDisplayName'>
  /// New displayName for the contact.
  /// </param>
  /// <returns>
  /// Updated contact on success, null otherwise.
  /// </returns>
  public static Contact RRenameContact(MirrorService service,
      String contactId, String newDisplayName) {
    try {
      Contact contact = service.Contacts.Get(contactId).Fetch();
      contact.DisplayName = newDisplayName;
      return service.Contacts.Update(contact, contactId).Fetch();
    } catch (Exception e) {
      Console.WriteLine("An error occurred: " + e.Message);
      return null;
    }
  }

  // ...
}

PHP

משתמש בספריית הלקוח של PHP.

/**
 * Rename an existing contact for the current user.
 *
 * @param Google_MirrorService $service Authorized Mirror service.
 * @param string $contactId ID of the contact to rename.
 * @param string $newDisplayName New displayName for the contact.
 * @return Google_Contact Updated contact on success, null otherwise.
 */
function renameContact($service, $contactId, $newDisplayName) {
  try {
    $updatedContact = $service->contacts->get($contactId);
    $updatedContact->setDisplayName($newDisplayName);
    return $service->contacts->update($contactId, $updatedContact);
  } catch (Exception $e) {
    print 'An error occurred: ' . $e->getMessage();
    return null;
  }
}

Python

משתמש בספריית הלקוח של Python.

from apiclient import errors
# ...

def rename_contact(service, contact_id, new_display_name):
  """Rename an existing contact for the current user.

  Args:
    service: Authorized Mirror service.
    contact_id: ID of the contact to rename.
    new_display_name: New displayName for the contact.

  Returns:
    return Patched contact on success, None otherwise.
  """
  try:
    # Get the latest version of the contact from the API.
    contact = service.contacts().get(contact_id).execute()

    contact['displayName'] = new_display_name
    return service. contacts().update(
        id=contact_id, body=contact).execute()
  except errors.HttpError, e:
    print 'An error occurred: %s' % error
    return None

Ruby

משתמש בספריית הלקוח של Ruby.

##
# Rename an existing contact for the current user.
#
# @param [Google::APIClient] client
#   Authorized client instance.
# @param [String] contact_id
#   ID of the contact to rename.
# @param [String] new_display_name
#   New displayName for the contact.
# @return [Google::APIClient::Schema::Mirror::V1::Contact]
#   Updated contact on success, nil otherwise.
def rename_contact(client, contact_id, new_display_name)
  mirror = client.discovered_api('mirror', 'v1')
  # Get the latest version of the contact from the API.
  result = client.execute(
    :api_method => mirror.contacts.get,
    :parameters => { 'id' => contact_id })
  if result.success?
    contact = result.data
    contact.display_name = new_display_name
    result = client.execute(
      :api_method => mirror.contacts.update,
      :parameters => { 'id' => contact_id },
      :body_object => contact)
    if result.success?
      return result.data
    end
  end
  puts "An error occurred: #{result.data['error']['message']}"
end

Go

משתמשים בספריית הלקוח של Go.

import (
        "code.google.com/p/google-api-go-client/mirror/v1"
        "fmt"
)

// RenameContact renames an existing contact for the current user.
func RenameContact(g *mirror.Service, contactId string,
        newDisplayName string) (*mirror.Contact, error) {
        s, err := g. Contacts.Get(contactId).Do()
        if err != nil {
                fmt.Printf("An error occurred: %v\n", err)
                return nil, err
        }
        s.DisplayName = newDisplayName
        r, err := g.Contacts.Patch(contactId, s).Do()
        if err != nil {
                fmt.Printf("An error occurred: %v\n", err)
                return nil, err
        }
        return r, nil
}

HTTP גולמי

לא נעשה שימוש בספריית לקוח.

PUT /mirror/v1/contacts/harold HTTP/1.1
Authorization: Bearer auth token
Content-Type: application/json
Content-Length: length

{
  "displayName": "Harold Penguin",
  "imageUrls": ["https://developers.google.com/glass/images/harold.jpg"]
}