Esta página foi traduzida pela API Cloud Translation.

Settings: list

Retorna todas as configurações do usuário autenticado. Faça um teste agora ou veja um exemplo.

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/calendar/v3/users/me/settings

Parâmetros

Nome do parâmetro	Valor	Descrição
Parâmetros de consulta opcionais
`maxResults`	`integer`	Número máximo de entradas retornadas em uma página de resultados. Por padrão, o valor é de 100 entradas. O tamanho da página não pode ser maior do que 250 entradas. Opcional.
`pageToken`	`string`	Token que especifica qual página de resultados deve ser retornada. Opcional.
`syncToken`	`string`	Token recebido do campo `nextSyncToken` retornado na última página de resultados da solicitação de lista anterior. Isso faz com que o resultado dessa solicitação de lista contenha apenas entradas que foram alteradas desde então. Se a `syncToken` expirar, o servidor responderá com um código de resposta 410 GONE, e o cliente precisará limpar o armazenamento e fazer uma sincronização completa sem nenhuma `syncToken`. Saiba mais sobre a sincronização incremental. Opcional. O padrão é retornar todas as entradas.

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos:

Escopo
`https://www.googleapis.com/auth/calendar.readonly`
`https://www.googleapis.com/auth/calendar`
`https://www.googleapis.com/auth/calendar.settings.readonly`

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "calendar#settings",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    settings Resource
  ]
}

Nome da propriedade	Valor	Descrição
`kind`	`string`	Tipo da coleção ("`calendar#settings`").
`etag`	`etag`	ETag da coleção.
`items[]`	`list`	Lista de configurações do usuário.
`nextPageToken`	`string`	Token usado para acessar a próxima página deste resultado. Omitido se nenhum outro resultado estiver disponível. Nesse caso, `nextSyncToken` é fornecido.
`nextSyncToken`	`string`	Token usado posteriormente para recuperar apenas as entradas que foram alteradas desde que esse resultado foi retornado. Omitido se outros resultados estiverem disponíveis. Nesse caso, `nextPageToken` é fornecido.

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.

JavaPythonPHPRuby

Usa a biblioteca cliente de Java.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Setting;
import com.google.api.services.calendar.model.Settings;
// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over all user settings
Settings settings = service.settings().list().execute();

for (Setting setting : settings.getItems()) {
  System.out.println(setting.getId() + ": " + setting.getValue());
}

Usa a biblioteca cliente de Python.

settings = service.settings().list().execute()

for setting in settings['items']:
  print '%s: %s' % (setting['id'], setting['value'])

Usa a biblioteca cliente de PHP.

$settings = $service->settings->listSettings();

foreach ($settings->getItems() as $setting) {
  echo $setting->getId() . ': ' . $setting->getValue();
}

Usa a biblioteca de cliente Ruby.

result = client.list_settings
result.items.each do |e|
  print e.id + ": " + e.value + "\n"
end