Timeline: update

승인 필요

제자리에 있는 타임라인 항목을 업데이트합니다. 예를 참조하세요.

이 메서드는 /upload URI를 지원하고 다음과 같은 특성을 가진 업로드된 미디어를 허용합니다.

  • 최대 파일 크기: 10MB
  • 허용되는 미디어 MIME 유형: <ph type="x-smartling-placeholder">audio/*</ph> , image/* , video/*

요청

HTTP 요청

이 메서드는 별도의 두 URI를 통해 미디어 업로드 기능을 제공합니다. 자세한 내용은 미디어 업로드에 관한 문서를 참고하세요.

  • 미디어 업로드 요청용 업로드 URI: 
    PUT https://www.googleapis.com/upload/mirror/v1/timeline/id
  • 메타데이터 전용 요청의 경우 메타데이터 URI: 
    PUT https://www.googleapis.com/mirror/v1/timeline/id

매개변수

매개변수 이름 값 설명
경로 매개변수
id string 타임라인 항목의 ID입니다.
필수 쿼리 매개변수
uploadType string /upload URI에 대한 업로드 요청 유형입니다. 사용 가능한 값은 다음과 같습니다. <ph type="x-smartling-placeholder">
    </ph>
  • media - 간단한 업로드. 메타데이터 없이 미디어만 업로드합니다.
  • multipart - 멀티파트 업로드. 단일 요청으로 미디어와 미디어 메타데이터를 모두 업로드합니다.
  • resumable - 재개 가능한 업로드. 첫 번째 요청에 메타데이터가 포함되는 일련의 최소 2개 이상의 요청을 사용하여 재개 가능한 방식으로 파일을 업로드합니다.

승인

이 요청에는 다음 범위 중 최소 하나를 사용하여 인증이 필요합니다. (인증 및 승인에 대해 자세히 알아보기)

범위
https://www.googleapis.com/auth/glass.timeline
https://www.googleapis.com/auth/glass.location

요청 본문

요청 본문에 다음 속성을 메타데이터로 사용하여 타임라인 리소스를 제공합니다. 자세한 내용은 미디어 업로드에 관한 문서를 참고하세요.

속성 이름 값 설명 참고
선택적 속성
bundleId string 이 상품의 번들 ID입니다. 서비스는 bundleId를 지정하여 많은 항목을 함께 그룹화할 수 있습니다. 기기의 단일 최상위 항목 아래에 표시됩니다. 쓰기 가능
canonicalUrl string 타임라인 항목이 나타내는 데이터의 표준/고화질 버전을 가리키는 표준 URL입니다. 쓰기 가능
creator nested object 이 항목을 만든 사용자 또는 그룹입니다. 쓰기 가능
displayTime datetime 이 항목이 RFC 3339에 따른 형식으로 타임라인에 표시될 때 표시되어야 하는 시간입니다. 이 사용자의 타임라인은 표시 시간에 따라 시간순으로 정렬되므로 타임라인에서 항목이 표시되는 위치도 결정됩니다. 서비스에서 설정하지 않으면 표시 시간은 기본적으로 updated 시간으로 설정됩니다. 쓰기 가능
html string 이 항목의 HTML 콘텐츠입니다. 항목에 text와 html가 모두 제공되면 html가 타임라인에 렌더링됩니다.

허용된 HTML 요소 - 타임라인 카드에서 이러한 요소를 사용할 수 있습니다.

  • 헤더: h1, h2, h3, h4, h5, h6
  • 이미지: img
  • 목록: li, ol, ul
  • HTML5 의미: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
  • 구조: blockquote, br, div, hr, p, span
  • 스타일: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
  • 테이블: table, tbody, td, tfoot, th, thead, tr

차단된 HTML 요소: 이러한 요소와 관련 콘텐츠는 HTML 페이로드에서 삭제됩니다.

  • 문서 헤더: head, title
  • 퍼가기: audio, embed, object, source, video
  • 프레임: frame, frameset개
  • 스크립트: applet, script

기타 요소: 나열되지 않은 요소는 삭제되지만 콘텐츠는 유지됩니다.

 쓰기 가능
isBundleCover boolean 상품이 번들 커버인지 여부입니다.

상품을 번들 표지로 표시하면 해당 상품과 bundleId이 동일한 상품 번들의 진입점이 됩니다. 열린 번들 내부가 아닌 기본 타임라인에만 표시됩니다.

기본 타임라인에 표시되는 항목은 다음과 같습니다.
  • isBundleCover이(가) true(으)로 설정된 항목
  • bundleId가 없는 항목
번들 하위 타임라인에 표시되는 항목은 다음과 같습니다.
  • 문제의 bundleId 및 isBundleCover이(가) false로 설정된 항목
쓰기 가능
location nested object 이 상품과 연결된 지리적 위치입니다. 쓰기 가능
notification nested object 이 항목의 알림이 기기에 표시되는 방식을 제어합니다. 이 ID가 없으면 알림이 생성되지 않습니다. 쓰기 가능
notification.deliveryTime datetime 알림이 전달되어야 하는 시간입니다. 쓰기 가능
notification.level string 알림의 중요도를 설명합니다. 허용되는 값은 다음과 같습니다.
  • DEFAULT - 기본 중요도 알림 사용자에게 알리기 위해 차임벨이 울립니다.
 쓰기 가능
recipients[] list 이 항목이 공유된 사용자 또는 그룹 목록입니다. 쓰기 가능
sourceItemId string 자체 서비스의 데이터에 타임라인 항목을 매핑하는 데 사용할 수 있는 불투명 문자열입니다. 쓰기 가능
speakableText string 이 항목의 콘텐츠의 음성 버전입니다. READ_ALOUD 메뉴 항목과 함께 이 입력란을 사용하여 소리내어 읽을 때 더 명확하게 표시되는 텍스트를 제공하거나 Glass에 표시되는 내용에 대해 확장된 정보를 제공할 수 있습니다.

Glass 소프트웨어는 또한 추가 컨텍스트가 유용한 경우(예: 사용자가 알림 후 항목을 소리 내어 읽도록 요청하는 경우) 이 텍스트보다 먼저 말할 SpeakeasyableType 필드도 지정해야 합니다.
 쓰기 가능
speakableType string 이 항목의 유형에 대한 음성 지원 설명입니다. 예를 들어 사용자가 알림 후에 항목을 소리 내어 읽어 달라고 요청하는 경우와 같이 추가 컨텍스트가 유용한 경우 항목의 콘텐츠를 읽기 전에 사용자에게 알림이 제공됩니다.

'이메일', '문자 메시지' 또는 '일일 플래닛 뉴스 업데이트'와 같이 짧고 간단한 명사구여야 합니다.

Glass 소프트웨어는 사용자가 화면을 보지 않고도 항목 유형을 알 수 있도록 항목에 SpeechableText 또는 텍스트가 포함되어 있지 않더라도 모든 타임라인 항목에 이 필드를 채우는 것이 좋습니다.		 쓰기 가능
text string 이 항목의 텍스트 콘텐츠입니다. 쓰기 가능
title string 이 항목의 제목입니다. 쓰기 가능

응답

요청에 성공할 경우 이 메서드는 응답 본문에 타임라인 리소스를 반환합니다.

예

참고: 이 메서드에 제공되는 코드 예시가 지원되는 모든 프로그래밍 언어를 나타내는 것은 아닙니다. 지원되는 언어 목록은 클라이언트 라이브러리 페이지를 참조하세요.

자바

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

.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

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

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

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

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

클라이언트 라이브러리를 사용하지 않습니다.

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