Uso

Configuração que controla o uso de um serviço.

Representação JSON

{
  "requirements": [
    string
  ],
  "rules": [
    {
      object(UsageRule)
    }
  ],
  "producerNotificationChannel": string
}
Campos
requirements[]

string

Requisitos que precisam ser atendidos antes que um projeto de consumidor possa usar o serviço. Cada requisito tem o formato <service.name>/. Por exemplo: "serviceusage.googleapis.com/billing-enabled".

rules[]

object(UsageRule)

Uma lista de regras de uso que se aplicam aos métodos individuais da API.

OBSERVAÇÃO: todas as regras de configuração do serviço seguem a ordem "vale a última opção".

producerNotificationChannel

string

O nome completo do recurso de um canal usado para enviar notificações ao produtor de serviços.

O Google Service Management atualmente só aceita o Google Cloud Pub/Sub como canal de notificação. Para usar o Google Cloud Pub/Sub como canal, precisa ser o nome de um tópico do Cloud Pub/Sub que usa o formato de nome do tópico do Cloud Pub/Sub documentado em https://cloud.google.com/pubsub/docs/overview.

UsageRule

Regras de configuração de uso para o serviço.

OBSERVAÇÃO: em desenvolvimento.

Use esta regra para configurar chamadas não registradas para o serviço. Chamadas não registradas são chamadas que não contêm a identificação do projeto de consumidor. Exemplo: chamadas que não contêm uma chave da API. Por padrão, os métodos da API não permitem chamadas não registradas e cada chamada de método precisa ser identificada por uma identidade de projeto de consumidor. Use esta regra para permitir/bloquear chamadas não registradas.

Exemplo de uma API que quer permitir chamadas não registradas para todo o serviço.

usage:
  rules:
  - selector: "*"
    allowUnregisteredCalls: true

Exemplo de um método que quer permitir chamadas não registradas.

usage:
  rules:
  - selector: "google.example.library.v1.LibraryService.CreateBook"
    allowUnregisteredCalls: true
Representação JSON

{
  "selector": string,
  "allowUnregisteredCalls": boolean,
  "skipServiceControl": boolean
}
Campos
selector

string

Seleciona os métodos aos quais esta regra se aplica. Use "*" para indicar todos os métodos em todas as APIs.

Consulte selector para ver detalhes da sintaxe.

allowUnregisteredCalls

boolean

Se for "True", o método selecionado permite chamadas não registradas. Por exemplo, chamadas que não identificam nenhum usuário ou aplicativo.

skipServiceControl

boolean

Se for "True", o método selecionado ignora o controle do serviço e os recursos do plano de controle, como cota e faturamento, não estarão disponíveis. Esta sinalização é usada pelo Google Cloud Endpoints para ignorar verificações de métodos internos, como métodos de verificação de integridade do serviço.