Recurso REST: serviços

Recurso: Serviço

Um serviço que está disponível para uso pelo consumidor.

Representação JSON 

{
  "name": string,
  "parent": string,
  "config": {
    object(ServiceConfig)
  },
  "state": enum(State)
}
Campos
name

string

O nome do recurso do consumidor e do serviço.

Um nome válido seria: - projects/123/services/serviceusage.googleapis.com
parent

string

O nome do recurso do consumidor.

Um nome válido seria: - projects/123
config

object(ServiceConfig)

A configuração do serviço disponível. Alguns campos podem ser filtrados da configuração nas respostas ao método services.list. Esses campos estão presentes apenas nas respostas ao método services.get.

state

enum(State)

Se o serviço foi ativado para uso pelo consumidor ou não.

ServiceConfig

A configuração do serviço.

Representação JSON 

{
  "name": string,
  "title": string,
  "apis": [
    {
      object(Api)
    }
  ],
  "documentation": {
    object(Documentation)
  },
  "quota": {
    object(Quota)
  },
  "authentication": {
    object(Authentication)
  },
  "usage": {
    object(Usage)
  },
  "endpoints": [
    {
      object(Endpoint)
    }
  ]
}
Campos
name

string

O endereço DNS em que esse serviço está disponível.

Um exemplo de endereço DNS seria: calendar.googleapis.com.
title

string

O título do produto para este serviço.

apis[]

object(Api)

Uma lista de interfaces da API exportadas por este serviço. Contém apenas nomes, versões e nomes de métodos das interfaces.

documentation

object(Documentation)

Documentação adicional da API. Contém apenas o resumo e o URL da documentação.

quota

object(Quota)

Configuração de cota.

authentication

object(Authentication)

Configuração de autenticação. Contém apenas as regras de OAuth.

usage

object(Usage)

Configuração que controla o uso desse serviço.

endpoints[]

object(Endpoint)

Configuração para pontos de extremidade da rede. Contém apenas os nomes e alias dos pontos de extremidade.

Estado

Se um serviço foi ativado para uso por um consumidor ou não.

Enums
STATE_UNSPECIFIED O valor padrão, que indica que o estado ativo do serviço não está especificado ou não é significativo. Atualmente, todos os consumidores que não sejam projetos (como pastas e organizações) estão sempre neste estado.
DISABLED O serviço não pode ser usado por este consumidor. Ele foi desativado explicitamente ou nunca foi ativado.
ENABLED O serviço foi ativado explicitamente para uso por este consumidor.

Métodos

batchEnable

 Ative vários serviços em um projeto.

disable

 Desative um serviço para que ele não possa mais ser usado em um projeto.

enable

 Ative um serviço para que ele possa ser usado com um projeto.

get

 Retorna a configuração do serviço e o estado ativo de um determinado serviço.

list

 Liste todos os serviços disponíveis para o projeto especificado e o estado atual desses serviços em relação ao projeto.