Timeline: update

Requer autorização

Atualiza um item da linha do tempo. Veja um exemplo.

Esse método é compatível com um URI de /upload e aceita mídias enviadas com as seguintes características:

• Tamanho máximo do arquivo: 10 MB
• Tipos de mídia MIME aceitos: audio/* , image/* , video/*

Solicitação

Solicitação HTTP

Esse método oferece a funcionalidade de upload de mídia por dois URIs separados. Para mais detalhes, consulte o documento sobre upload de mídia.

• URI de upload, para solicitações de upload de mídia:

  PUT https://www.googleapis.com/upload/mirror/v1/timeline/id

• URI de metadados, para solicitações somente de metadados:

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

Parâmetros

Nome do parâmetro	Valor	Descrição
Parâmetros de caminho
id	string	ID do item da linha do tempo.
Parâmetros de consulta obrigatórios
uploadType	string	O tipo de solicitação de upload para o URI de /upload. Os valores aceitáveis são os seguintes: media: upload simples. Envie somente a mídia, sem metadados. multipart: upload de várias partes. Fazer upload da mídia e dos metadados com uma única solicitação. resumable: upload retomável. Fazer upload do arquivo de modo retomável usando uma série de pelo menos duas solicitações. A primeira inclui os metadados.

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos (leia mais sobre autenticação e autorização).

Escopo
https://www.googleapis.com/auth/glass.timeline
https://www.googleapis.com/auth/glass.location

Corpo da solicitação

No corpo da solicitação, forneça um recurso de linha do tempo com as seguintes propriedades como metadados. Para mais informações, consulte o documento sobre upload de mídia.

Nome da propriedade	Valor	Descrição	Observações
Propriedades opcionais
bundleId	string	O ID do pacote deste item. Os serviços podem especificar um bundleId para agrupar vários itens. Eles aparecem em um único item de nível superior no dispositivo.	gravável
canonicalUrl	string	Um URL canônico que aponta para a versão canônica/de alta qualidade dos dados representados pelo item da linha do tempo.	gravável
creator	nested object	O usuário ou grupo que criou o item.	gravável
displayTime	datetime	É o horário que deve ser exibido quando o item é visualizado na linha do tempo, formatado de acordo com o RFC 3339. A linha do tempo desse usuário é organizada de acordo com o tempo de exibição, o que também determina onde o item aparece. Se não for definido pelo serviço, o tempo de exibição será definido como updated por padrão.	gravável
html	string	Conteúdo HTML deste item. Se text e html forem fornecidos para um item, o html será renderizado no cronograma. Elementos HTML permitidos: você pode usar esses elementos nos cards da linha do tempo. Cabeçalhos: h1, h2, h3, h4, h5, h6 Imagens: img Listas: li, ol, ul Semântica do HTML5: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time Estrutural: blockquote, br, div, hr, p, span Estilo: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup Tabelas: table, tbody, td, tfoot, th, thead, tr Elementos HTML bloqueados: esses elementos e o conteúdo deles são removidos dos payloads HTML. Cabeçalhos do documento: head, title Incorporações: audio, embed, object, source, video Armações: frame, frameset Script: applet, script Outros elementos: todos os elementos não listados serão removidos, mas o conteúdo deles será preservado.	gravável
isBundleCover	boolean	Indica se este item é uma capa de pacote. Se um item for marcado como uma capa de pacote, ele será o ponto de entrada para o pacote de itens que tenham o mesmo bundleId. Ele será exibido somente na linha do tempo principal, não no pacote aberto. Na linha do tempo principal, os itens mostrados são: Itens com isBundleCover definido como true Itens que não têm bundleId Em um sub-linha do tempo de pacote, os itens mostrados são: Itens com bundleId em questão E isBundleCover definido como false	gravável
location	nested object	A localização geográfica associada a este item.	gravável
menuItems[]	list	Uma lista de itens de menu que vão ser apresentados ao usuário quando esse item for selecionado na linha do tempo.	gravável
menuItems[].action	string	Controla o comportamento quando o usuário escolhe a opção do menu. Os valores permitidos são: CUSTOM: ação personalizada definida pelo serviço. Quando o usuário seleciona esse menuItem, a API aciona uma notificação para o callbackUrl com o userActions.type definido como CUSTOM e o userActions.payload definido como ID do item de menu. Esse é o valor padrão. Ações integradas: REPLY: inicie uma resposta ao item da linha do tempo usando a interface de gravação de voz. O atributo creator precisa ser definido no item da linha do tempo para que esse menu esteja disponível. REPLY_ALL: mesmo comportamento que REPLY. O recipients do item da linha do tempo original será adicionado ao item de resposta. DELETE: exclui o item da linha do tempo. SHARE: compartilhe o item da linha do tempo com os contatos disponíveis. READ_ALOUD – Leia a speakableText do item da linha do tempo em voz alta. Se este campo não estiver definido, leia o campo text. se nenhum desses campos for definido, o item de menu será ignorado. GET_MEDIA_INPUT: permite que os usuários forneçam payloads de mídia de um item de menu para o Glassware. No momento, somente texto transcrito de entrada de texto por voz é compatível. Inscreva-se para receber notificações quando os usuários invocarem esse item de menu para receber o ID dele. Recupere a mídia do item da linha do tempo na propriedade payload. VOICE_CALL: inicia uma chamada telefônica usando o atributo creator.phoneNumber do item da linha do tempo como destinatário. NAVIGATE: navegue até o location do item da linha do tempo. TOGGLE_PINNED: alterna o estado isPinned do item da linha do tempo. OPEN_URI: abra o payload do item de menu no navegador. PLAY_VIDEO: abra o payload do item de menu no player de vídeo do Glass. SEND_MESSAGE – Início do envio de uma mensagem para o creator do item da linha do tempo: Se a creator.phoneNumber estiver definida e o Google Glass estiver conectado a um smartphone Android, a mensagem será um SMS. Caso contrário, se creator.email estiver definido, a mensagem será um e-mail.	gravável
menuItems[].id	string	O ID desse item de menu. Ele é gerado pelo aplicativo e tratado como um token opaco.	gravável
menuItems[].payload	string	Um payload genérico cujo significado muda dependendo da ação desse MenuItem. Quando a ação for OPEN_URI, o payload será o URL do site a ser visualizado. Quando a ação é PLAY_VIDEO, o payload é o URL de streaming do vídeo. Quando a ação é GET_MEDIA_INPUT, o payload é a transcrição de texto da entrada de fala de um usuário	gravável
menuItems[].removeWhenSelected	boolean	Se definido como verdadeiro em um item de menu do CUSTOM, ele será removido do menu depois de ser selecionado.	gravável
menuItems[].values[]	list	Para itens CUSTOM, uma lista de valores que controlam a aparência do item de menu em cada um dos estados. É necessário fornecer um valor para o estado DEFAULT. Se os estados PENDING ou CONFIRMED estiverem ausentes, eles não serão exibidos.	gravável
menuItems[].values[].displayName	string	Nome a ser exibido para o item de menu. Se você especificar essa propriedade para um item de menu integrado, o comando de voz contextual padrão desse item de menu não será mostrado.	gravável
menuItems[].values[].iconUrl	string	URL de um ícone a ser exibido com o item de menu.	gravável
menuItems[].values[].state	string	O estado ao qual este valor se aplica. Os valores permitidos são: DEFAULT: valor padrão mostrado quando exibido na lista menuItems. PENDING: valor exibido quando o menuItem é selecionado pelo usuário, mas ainda pode ser cancelado. CONFIRMED: valor mostrado quando o menuItem é selecionado pelo usuário e não pode mais ser cancelado.	gravável
notification	nested object	Controla como as notificações deste item são apresentadas no dispositivo. Se essa informação não for informada, nenhuma notificação será gerada.	gravável
notification.deliveryTime	datetime	O horário em que a notificação deve ser entregue.	gravável
notification.level	string	Descreve a importância da notificação. Os valores permitidos são: DEFAULT: notificações de importância padrão. Uma campainha vai tocar para alertar os usuários.	gravável
recipients[]	list	Uma lista de usuários ou grupos com os quais este item foi compartilhado.	gravável
sourceItemId	string	String opaca que você pode usar para mapear um item da linha do tempo para dados no seu próprio serviço.	gravável
speakableText	string	A versão falada do conteúdo deste item. Além do item de menu READ_ALOUD, use esse campo para fornecer um texto mais claro quando lido em voz alta ou para fornecer mais informações sobre o que é exibido visualmente no Google Glass. O Glassware também precisa especificar o campo SpeakableType, que será falado antes do texto quando o contexto adicional for útil, por exemplo, quando o usuário solicitar que o item seja lido em voz alta após uma notificação.	gravável
speakableType	string	Uma descrição falada do tipo deste item. Isso será anunciado ao usuário antes da leitura do conteúdo do item nos casos em que o contexto adicional for útil, por exemplo, quando o usuário solicitar que o item seja lido em voz alta após uma notificação. Deve ser um sintagma nominal curto e simples, como "E-mail", "Mensagem de texto" ou "Atualização diária de novidades do planeta". Os Glasswares são incentivados a preencher esse campo para cada item da linha do tempo, mesmo que o item não contenha speakableText ou texto, para que o usuário possa aprender o tipo do item sem olhar para a tela.	gravável
text	string	Conteúdo de texto deste item.	gravável
title	string	Título deste item.	gravável

Resposta

Se for bem-sucedido, esse método retornará um recurso de Linha do tempo no corpo da resposta.

Exemplos

Observação: os exemplos de código disponíveis para esse método não representam todas as linguagens de programação compatíveis. Consulte a página de bibliotecas cliente para ver uma lista de linguagens compatíveis.

Java

Usa a biblioteca cliente de Java.

import com.google.api.services.mirror.Mirror;
import com.google.api.services.mirror.model.NotificationConfig;
import com.google.api.services.mirror.model.TimelineItem;

import java.io.IOException;

public class MyClass {
  // ...

  /**
   * Update a timeline item in the user's Glass with an optional notification and attachment.
   * 
   * @param service Authorized Mirror service.
   * @param itemId ID of the timeline item to update.
   * @param newText timeline item's text.
   * @param newNotificationLevel Optional notification level, supported values
   *        are {@code null} and "AUDIO_ONLY".
   * @return Updated timeline item on success, {@code null} otherwise.
   */
  public static TimelineItem updateTimelineItem(Mirror service, String itemId, String newText,
      String newNotificationLevel) {
    try {
      // First retrieve the timeline item from the API.
      TimelineItem timelineItem = service.timeline().get(itemId).execute();
      // Update the timeline item's metadata.
      timelineItem.setText(newText);
      if (newNotificationLevel != null && newNotificationLevel.length() > 0) {
        timelineItem.setNotification(new NotificationConfig().setLevel(newNotificationLevel));
      } else {
        timelineItem.setNotification(null);
      }
      return service.timeline().update(itemId, timelineItem).execute();
    } catch (IOException e) {
      System.err.println("An error occurred: " + e);
      return null;
    }
  }

  // ...
}

.NET

Usa a biblioteca de cliente.NET.

using System;
using System.IO;

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

public class MyClass {
  // ...

  /// <summary>
  /// Update a timeline item in the user's Glass with an optional
  /// notification and attachment.
  /// </summary>
  /// <param name='service'>Authorized Mirror service.</param>
  /// <param name='itemId'>ID of the timeline item to update.</param>
  /// <param name='newText'>Timeline Item's text content.</param>
  /// <param name='newNotificationLevel'>
  /// Optional notification level, supported values are null and
  /// "AUDIO_ONLY".
  /// </param>
  /// <returns>
  /// Updated timeline item on success, null otherwise.
  /// </returns>
  public static TimelineItem UpdateTimelineItem(MirrorService service,
      String itemId, String newText, String newNotificationLevel) {
    try {
      // First retrieve the timeline item from the API.
      TimelineItem timelineItem = service.Timeline.Get(itemId).Fetch();
      // Update the timeline item's metadata.
      timelineItem.Text = newText;
      if (!String.IsNullOrEmpty(newNotificationLevel)) {
        timelineItem.Notification = new NotificationConfig() {
          Level = newNotificationLevel
        };
      } else {
        timelineItem.Notification = null;
      }
      return service.Timeline.Update(timelineItem, itemId).Fetch();
    } catch (Exception e) {
      Console.WriteLine("An error occurred: " + e.Message);
      return null;
    }
  }

  // ...
}

PHP

Usa a biblioteca cliente de PHP.

/**
 * Update a timeline item in the user's Glass with an optional
 * notification and attachment.
 *
 * @param Google_MirrorSservice $service Authorized Mirror service.
 * @param string $itemId ID of the timeline item to update.
 * @param string $newText timeline item's text (can be HTML content).
 * @param string $newNotificationLevel Optional notification level,
 *               supported values are {@code null} and "AUDIO_ONLY".
 * @return Google_TimelineItem Updated timeline item on success,
 *         null otherwise.
 */
function updateTimelineItem($service, $itemId, $newText, $newNotificationLevel) {
  try {
    $timelineItem = $service->timeline->get($itemId);
    $timelineItem->setText($newText);
    if ($notificationlevel != null) {
      $notification = new Google_NotificationConfig();
      $notification->setLevel($newNotificationLevel);
      $timelineItem->setNotification($notification);
    } else {
      $timelineItem->setNotification(null);
    }
    return $service->timeline->update($itemId, $timelineItem);
  } catch (Exception $e) {
    print 'An error occurred: ' . $e->getMessage();
    return null;
  }
}

Python

Usa a biblioteca cliente de Python.

import io

from apiclient import errors
from apiclient.http import MediaIoBaseUpload
# ...

def update_timeline_item(service, item_id, new_text, 
                         new_notification_level=None):
  """Update a timeline item in the user's Glass.

  Args:
    service: Authorized Mirror service.
    item_id: ID of the timeline item to update.
    new_text: Timeline item's text (can be HTML content).
    new_content_type: Optional attachment's content type (supported content
                      types are 'image/*', 'video/*' and 'audio/*').
    new_attachment: Optional attachment as data string.
    new_notification_level: Optional notification level, supported values are
                            None and 'AUDIO_ONLY'.
  Returns:
    Updated timeline item on success, None otherwise.
  """
  try:
    # First retrieve the timeline item from the API.
    timeline_item = service.timeline().get(id=item_id).execute()
    # Update the timeline item's metadata.
    timeline_item['text'] = new_text
    if new_notification_level:
      timeline_item['notification'] = {'level': new_notification_level}
    elif 'notification' in timeline_item:
      timeline_item.pop('notification')
    return service.timeline().update(id=item_id, body=timeline_item).execute()
  except errors.HttpError, error:
    print 'An error occurred: %s' % error
    return None

Ruby

Usa a biblioteca de cliente Ruby.

##
# Update a timeline item in the user's glass.
#
# @param [Google::APIClient] client
#   Authorized client instance.
# @param [String] item_id
#   ID of the timeline item to update.
# @param [String] new_text
#   Timeline item's new text.
# @param [String] new_notification_level
#   Optional new notification level, supported values are nil and 'AUDIO_ONLY'.
# @return [Google::APIClient::Schema::Mirror::V1::TimelineItem]
#   Updated timeline item instance if successful, nil otherwise.
def update_timeline_item(client, item_id, new_text, new_notification_level)
  mirror = client.discovered_api('mirror', 'v1')
  result = client.execute(
    :api_method => mirror.timeline.get,
    :parameters => { 'id' => item_id })
  if result.success?
    timeline_item = result.data
    timeline_item.text = new_text
    if new_notification_level
      timeline_item.notification = { 'level' => new_notification_level }
    else
      timeline_item.notification = nil
    end
    result = client.execute(
      :api_method => mirror.timeline.update,
      :body_object => timeline_item,
      :parameters => { 'id' => item_id })
    if result.success?
      return result.data
    end
  end
  puts "An error occurred: #{result.data['error']['message']}"
end

Go

Usa a biblioteca de cliente Go.

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

// UpdateTimelineItem updates a timeline item in the user's timeline with an
// optional notification and attachment.
func UpdateTimelineItem(g *mirror.Service, itemId string, newNotificationLevel string) (
	*mirror.TimelineItem, error) {
	t, err := g.Timeline.Get(itemId).Do()
	if err != nil {
		fmt.Printf("An error occurred: %v\n", err)
		return nil, err
	}
	t.Text = newText
	if newNotificationLevel != "" {
		t.Notification = &mirror.NotificationConfig{Level: newNotificationLevel}
	} else {
		t.Notification = nil
	}
	r, err := g.Timeline.Update(itemId, t).Do()
	if err != nil {
		fmt.Printf("An error occurred: %v\n", err)
		return nil, err
	}
	return r, nil
}

HTTP bruto

Não usa uma biblioteca de cliente.

PUT /mirror/v1/timeline/timeline item id HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer auth token
Content-Type: application/json
Content-Length: 26

{ "text": "Hello world" }