Contacts: insert

Wymaga autoryzacji

Wstawia nowy kontakt. Zobacz przykład

Żądanie

Żądanie HTTP

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

Upoważnienie

To żądanie wymaga autoryzacji w następującym zakresie (więcej informacji o uwierzytelnianiu i autoryzacji).

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

Treść żądania

W treści żądania podaj zasób Kontaktów z tymi właściwościami:

Nazwa usługi Wartość Opis Uwagi
Wymagane właściwości
acceptCommands[].type string Typ operacji, której dotyczy to polecenie. Dozwolone wartości to:
  • TAKE_A_NOTE – udostępnia element osi czasu z transkrypcją wypowiedzi użytkownika z polecenia menu „Utwórz notatkę”.
  • POST_AN_UPDATE – udostępnia element osi czasu z transkrypcją mowy użytkownika wypisaną w poleceniu „Opublikuj aktualizację”.
zapisywalny
displayName string Nazwa wyświetlana dla tego kontaktu. zapisywalny
id string Identyfikator tego kontaktu. Jest on generowany przez aplikację i jest traktowany jako nieprzejrzysty token. zapisywalny
imageUrls[] list Zestaw adresów URL obrazów wyświetlanych kontaktowi. Większość kontaktów ma jeden obraz, ale kontakt typu „grupa” może zawierać do 8 adresów URL obrazów. Rozmiar kontaktu zostanie zmieniony i przycięty do mozaiki po stronie klienta. zapisywalny
Właściwości opcjonalne
acceptCommands[] list Lista poleceń menu głosowych, które może obsługiwać kontakt. Glass pokazuje do 3 kontaktów na każde polecenie menu głosowego. Jeśli jest ich więcej, wyświetlane są 3 kontakty z najwyższym poziomem wartości priority dla tego polecenia. zapisywalny
acceptTypes[] list Lista typów MIME obsługiwanych przez kontakty. Kontakt wyświetli się użytkownikowi, jeśli którykolwiek z jego atrybutów metody akceptuje wszystkie typy załączników w elemencie. Jeśli nie podasz żadnych wartości prób typów, typ kontaktu jest widoczny dla wszystkich elementów. zapisywalny
phoneNumber string Podstawowy numer telefonu kontaktu. Może to być pełny i jednoznaczny numer telefonu, w tym numer kierunkowy kraju i numer kierunkowy lub numer lokalny. zapisywalny
priority unsigned integer Priorytet kontaktu w celu określenia kolejności na liście kontaktów. Kontakty o wyższych priorytetach będą wyświetlane przed tymi o niższych priorytetach. zapisywalny
speakableName string Nazwa tego kontaktu, jak powinna być wymawiana. Jeśli imię i nazwisko tego kontaktu muszą być wymawiane w ramach menu wyboru głosu, jest to oczekiwana wymowa. Jest to przydatne w przypadku nazw kontaktów z niezrozumiałymi znakami lub w innych przypadkach pisownia nie jest fonetyczna. zapisywalny
type string Typ tego kontaktu. Służy do sortowania w UI. Dozwolone wartości to:
  • INDIVIDUAL – reprezentuje jedną osobę. Jest to ustawienie domyślne.
  • GROUP – reprezentuje więcej niż jedną osobę.
zapisywalny

Odpowiedź

Jeśli operacja się uda, ta metoda zwróci zasób Kontaktów w treści odpowiedzi.

Przykłady

Uwaga: dostępne dla tej metody przykłady kodu nie odzwierciedlają wszystkich obsługiwanych języków programowania. Listę obsługiwanych języków znajdziesz na stronie z bibliotekami klienta.

Java

Używa biblioteki klienta w języku Java.

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

Używa biblioteki klienta.NET.

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

Używa biblioteki klienta PHP.

/**
 * 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

Używa biblioteki klienta dla języka Python.

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

Używa biblioteki klienta Ruby.

##
# 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

Go

Używa biblioteki klienta Go.

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
}

Nieprzetworzony protokół HTTP

Nie korzysta z biblioteki klienta.

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"]
}