Campos padrão

Nesta seção, descrevemos um conjunto de definições de campo de mensagem padrão que precisam ser usadas quando conceitos similares são necessários. Isso garantirá que o mesmo conceito tenha o mesmo nome e semântica em diferentes APIs.

Nome Tipo Descrição
name string O campo name deve conter o nome do recurso relativo.
parent string Para definições de recurso e solicitações List/Create, o campo parent deve conter o nome do recurso relativo pai.
create_time Timestamp O carimbo de data/hora de criação de uma entidade.
update_time Timestamp O último carimbo de data/hora de atualização de uma entidade. Observação: o update_time é atualizado quando a operação create/patch/delete é executada.
delete_time Timestamp O carimbo de data/hora de exclusão de uma entidade, apenas se for compatível com a retenção.
expire_time Timestamp O carimbo de data/hora de expiração de uma entidade se ela expirar.
start_time Timestamp O carimbo de data/hora que marca o início de algum período.
end_time Timestamp O carimbo de data/hora que marca o fim de algum período ou operação (independentemente do sucesso).
read_time Timestamp O carimbo de data/hora em que determinada entidade precisa ser lida (se usada em uma solicitação) ou foi lida (se usada em uma resposta).
time_zone string O nome do fuso horário. Deve ser um nome IANA TZ, como "America/Los_Angeles". Para mais informações, consulte https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
region_code string O código de país/região Unicode (CLDR) de um local, como "US" e "419". Para mais informações, consulte http://www.unicode.org/reports/tr35/#unicode_region_subtag.
language_code string O código de idioma BCP-47, como "en-US" ou "sr-Latn". Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
mime_type string Um tipo MIME publicado pela IANA (também conhecido como tipo de mídia). Para mais informações, consulte https://www.iana.org/assignments/media-types/media-types.xhtml.
display_name string O nome de exibição de uma entidade.
title string O nome oficial de uma entidade, como o nome da empresa. Ele deve ser tratado como a versão formal do display_name.
description string Um ou mais parágrafos de descrição de texto de uma entidade.
filter string O parâmetro de filtro padrão para métodos List.
query string O mesmo que filter se estiver sendo aplicado a um método de pesquisa (por exemplo, :search)
page_token string O token de paginação na solicitação de List.
page_size int32 O tamanho da paginação na solicitação de List.
total_size int32 A contagem total de itens na lista independentemente da paginação.
next_page_token string O próximo token de paginação na resposta do List. Ele deve ser usado como page_token para a solicitação a seguir. Um valor vazio significa que não há mais resultados.
order_by string Especifica o ordenamento de resultados para solicitações de List.
request_id string Um código de string exclusivo usado para detectar solicitações duplicadas.
resume_token string Um token opaco usado para retomar uma solicitação de streaming.
labels map<string, string> Representa os marcadores de recurso do Cloud.
deleted bool Se um recurso permitir o cancelamento de exclusão, ele deverá ter um campo deleted indicando que o recurso foi excluído.
show_deleted bool Se um recurso permitir exclusão no comportamento, o método List correspondente deverá ter um campo show_deleted para que o cliente possa descobrir os recursos excluídos.
update_mask FieldMask É usado para uma mensagem de solicitação Update para realizar a atualização parcial em um recurso. Essa máscara é relativa ao recurso, não à mensagem de solicitação.
validate_only bool Se for verdadeiro, indica que a solicitação fornecida só poderá ser validada, mas não executada.

Parâmetros do sistema

Além dos campos padrão, as APIs do Google também são compatíveis com um conjunto de parâmetros de solicitação comuns disponíveis em todos os métodos da API. Esses parâmetros são conhecidos como parâmetros do sistema. Para mais informações, consulte Parâmetros de sistema.