Contacts: insert

Autorisierung erforderlich

Fügt einen neuen Kontakt ein. Beispiel ansehen

Anfrage

HTTP-Anfrage

POST https://www.googleapis.com/mirror/v1/contacts

Autorisierung

Für diese Anfrage ist eine Autorisierung in folgendem Bereich erforderlich. Weitere Informationen zur Authentifizierung und Autorisierung

Umfang
https://www.googleapis.com/auth/glass.timeline

Anfragetext

Geben Sie im Anfragetext eine Kontakte-Ressource mit den folgenden Attributen an:

Property-Name Wert Beschreibung Hinweise
Erforderliche Attribute
acceptCommands[].type string Die Art des Vorgangs, für den dieser Befehl gilt. Zulässige Werte:
  • TAKE_A_NOTE: teilt eine Zeitachse mit dem Transkript der Nutzerrede aus „Notiz schreiben“ Sprachmenübefehl.
  • POST_AN_UPDATE: teilt eine Zeitachse mit dem Transkript der Nutzerstimme aus „Update posten“ Sprachmenübefehl.
Bearbeitbar
displayName string Der für diesen Kontakt anzuzeigende Name. Bearbeitbar
id string Eine ID für diesen Kontakt. Dieses wird von der Anwendung generiert und als intransparentes Token behandelt. Bearbeitbar
imageUrls[] list Satz von Bild-URLs, die für einen Kontakt angezeigt werden sollen. Die meisten Kontakte haben ein einzelnes Bild, aber eine „Gruppe“ kann bis zu acht Bild-URLs enthalten. Diese werden auf dem Client in ihrer Größe angepasst und zu einem Mosaik zugeschnitten. Bearbeitbar
Optionale Attribute
acceptCommands[] list Eine Liste mit Sprachbefehlen für das Menü, die ein Kontakt verarbeiten kann. Glass zeigt für jeden Menübefehl bis zu drei Kontakte an. Wenn mehr Werte vorhanden sind, werden für den jeweiligen Befehl die drei Kontakte mit dem höchsten priority angezeigt. Bearbeitbar
acceptTypes[] list Eine Liste der MIME-Typen, die ein Kontakt unterstützt. Der Kontakt wird dem Nutzer angezeigt, wenn einer seiner AcceptTypes mit einem der Typen der Anhänge für das Element übereinstimmt. Wenn keine AcceptTypes angegeben werden, wird der Kontakt für alle Artikel angezeigt. Bearbeitbar
phoneNumber string Primäre Telefonnummer des Kontakts Das kann eine voll qualifizierte Nummer mit Landesvorwahl und Ortsvorwahl oder eine lokale Nummer sein. Bearbeitbar
priority unsigned integer Priorität für den Kontakt, um die Reihenfolge in einer Kontaktliste festzulegen. Kontakte mit höherer Priorität werden vor Kontakten mit niedrigerer Priorität angezeigt. Bearbeitbar
speakableName string Name dieses Kontakts, wie er ausgesprochen werden soll. Wenn der Name dieses Kontakts in einem Menü zur Sprachauswahl ausgesprochen werden muss, wird dieser Name in der erwarteten Aussprache verwendet. Dies ist nützlich für Kontaktnamen, die nicht aussprechbare Zeichen enthalten oder deren Anzeige nicht phonetisch ist. Bearbeitbar
type string Der Typ für diesen Kontakt. Dies wird zum Sortieren in Benutzeroberflächen verwendet. Zulässige Werte:
  • INDIVIDUAL: Stellt eine einzelne Person dar. Das ist die Standardeinstellung.
  • GROUP: steht für mehr als eine Person.
Bearbeitbar

Antwort

Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine Ressource vom Typ "Kontakte" im Antworttext zurückgegeben.

Beispiele

Hinweis: Bei den für diese Methode verfügbaren Codebeispielen sind nicht alle unterstützten Programmiersprachen vertreten. Eine Liste der unterstützten Sprachen finden Sie auf der Seite für Clientbibliotheken.

Java

Verwendet die Java-Clientbibliothek.

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

import java.io.IOException;
import java.util.Arrays;

public class MyClass {
  // ...

  /**
   * Insert a new contact for the current user.
   * 
   * @param service Authorized Mirror service.
   * @param contactId ID of the contact to insert.
   * @param displayName Display name for the contact to insert.
   * @param iconUrl URL of the contact's icon.
   * @return The inserted contact on success, {@code null} otherwise.
   */
  public static Contact insertContact(Mirror service, String contactId, String displayName,
      String iconUrl) {
    Contact contact = new Contact();
    contact.setId(contactId);
    contact.setDisplayName(displayName);
    contact.setImageUrls(Arrays.asList(iconUrl));

    try {
      return service.contacts().insert(contact).execute();
    } catch (IOException e) {
      System.err.println("An error occurred: " + e);
      return null;
    }
  }

  // ...
}

.NET

Verwendet die .NET-Clientbibliothek.

using System;
using System.Collections.Generic;

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

public class MyClass {
  // ...

  /// <summary>
  /// Insert a new contact for the current user.
  /// </summary>
  /// <param name='service'>Authorized Mirror service.</param>
  /// <param name='contactId'>ID of the contact to insert.</param>
  /// <param name='displayName'>
  /// Display name for the contact to insert.
  /// </param>
  /// <param name='iconUrl'>URL of the contact's icon.</param>
  /// <returns>
  /// The inserted contact on success, null otherwise.
  /// </returns>
  public static Contact InsertContact(MirrorService service,
      String contactId, String displayName, String iconUrl) {
    Contact contact = new Contact() {
      Id = contactId,
      DisplayName = displayName,
      ImageUrls = new List<String>() {iconUrl}
    };
    try {
      return service.Contacts.Insert(contact).Fetch();
    } catch (Exception e) {
      Console.WriteLine("An error occurred: " + e.Message);
      return null;
    }
  }

  // ...
}

PHP

Verwendet die PHP-Clientbibliothek.

/**
 * Insert a new contact for the current user.
 *
 * @param Google_MirrorService $service Authorized Mirror service.
 * @param string $contactId ID of the contact to insert.
 * @param string $displayName Display name for the contact to insert.
 * @param string $iconUrl URL of the contact's icon.
 * @return Google_Contact The inserted contact on success, null otherwise.
 */
function insertContact($service, $contactId, $displayName, $iconUrl) {
  try {
    $contact = new Google_Contact();
    $contact->setId($contactId);
    $contact->setDisplayName($displayName);
    $contact->setImageUrls(array($iconUrl));
    return $service->contacts->insert($contact);
  } catch (Exception $e) {
    print 'An error occurred: ' . $e->getMessage();
    return null;
  }
}

Python

Verwendet die Python-Clientbibliothek.

from apiclient import errors
# ...

def insert_contact(service, contact_id, display_name, icon_url):
  """Insert a new contact for the current user.

  Args:
    service: Authorized Mirror service.
    contact_id: ID of the contact to insert.
    display_name: Display name for the contact to insert.
    icon_url: URL of the contact's icon.
  Returns:
    The inserted contact on success, None otherwise.
  """
  contact = {
      'id': contact_id,
      'displayName': display_name,
      'imageUrls': [icon_url]
  }
  try:
    service.contacts().insert(body=contact).execute()
  except errors.HttpError, error:
    print 'An error occurred: %s' % error
    return None

Ruby

Verwendet die Ruby-Clientbibliothek.

##
# Insert a new contact for the current user.
#
# @param [Google::APIClient] client
#   Authorized client instance.
# @param [String] contact_id
#   ID of the contact to insert.
# @param [String] display_name
#   Display name for the contact to insert.
# @param [String] image_url
#   URL of the contact's icon.
# @return [Google::APIClient::Schema::Mirror::V1::Contact]
#   The inserted contact on success, nil otherwise.
def insert_contact(client, contact_id, display_name, image_url)
  mirror = client.discovered_api('mirror', 'v1')
  contact = mirror.contacts.insert.request_schema.new({
    'id' => contact_id,
    'displayName' => display_name,
    'imageUrls' => [image_url]
  })
  result = client.execute(
    :api_method => mirror.contacts.insert,
    :body_object => contact)
  if result.success?
    return result.data
  else
    puts "An error occurred: #{result.data['error']['message']}"
  end
end

Ok

Verwendet die Go-Clientbibliothek.

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

// InsertContact inserts a new contact for the current user.
func InsertContact(g *mirror.Service, contactId string,
        displayName string, iconUrl string) (*mirror.Contact, error) {
        s := &mirror.Contact{
                Id:          contactId,
                DisplayName: displayName,
                ImageUrls:     []string{iconUrl},
        }
        r, err := g.Contacts.Insert(s).Do()
        if err != nil {
                fmt.Printf("An error occurred: %v\n", err)
                return nil, err
        }
        return r, nil
}

HTTP-Rohdaten

Verwendet keine Clientbibliothek.

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

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