Console
    Contact Us Start free

    REST Resource: services

    Resource: ServiceState

    Information about the state of a service with respect to a consumer resource.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "state" 
 : 
 { 
 object (  State 
 
) 
 } 
 , 
 "service" 
 : 
 { 
 object (  Service 
 
) 
 } 
 }
    Fields
    name

    string

    Output only. The resource name of the service state.
    state

    object ( State )

    Output only. The state of this service with respect to the consumer parent.
    service

    object ( Service )

    Output only. The service referenced by this state.

    State

    State objects represent the state of a service, group, or category with respect to a consumer.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "enableRules" 
 : 
 [ 
 { 
 object (  EnableRule 
 
) 
 } 
 ] 
 }
    Fields
    name

    string

    Output only. The resource whose state is being represented. Format: projects/100/services/hello.googleapis.com , folders/101/services/hello.googleapis.com , organizations/102/services/hello.googleapis.com .
    enableRules[]

    object ( EnableRule )

    Output only. Enable rules, grouped by any associated conditions, that provide access to this resource.

    If the enableRules field is empty, then the named resource is not enabled.

    Service

    The Service object represents

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "requirements" 
 : 
 { 
 object (  Requirements 
 
) 
 } 
 , 
 "documentation" 
 : 
 { 
 object (  Documentation 
 
) 
 } 
 , 
 "mcpServer" 
 : 
 { 
 object (  McpServer 
 
) 
 } 
 }
    Fields
    name

    string

    The name of the service.
    displayName

    string

    The display name of the service.
    description

    string

    The description of the service.
    requirements

    object ( Requirements )

    The requirements to use a service, such as its Terms of Service.
    documentation

    object ( Documentation )

    Documentation links providing more information about a service.
    mcpServer

    object ( McpServer )

    The MCP server details of a service.

    Requirements

    Provides information about requirements to use the service.

    JSON representation 
     { 
 "tos" 
 : 
 [ 
 { 
 object (  TermsOfService 
 
) 
 } 
 ] 
 }
    Fields
    tos[]

    object ( TermsOfService )

    Terms of Service required for a service.

    TermsOfService

    TermsOfService captures the metadata about a given terms of service.

    JSON representation 
     { 
 "url" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    url

    string

    URL at which the terms of service can be viewed.
    displayName

    string

    Display name of the terms of service.

    Documentation

    Provides more detailed information about a service, such as tutorials and pricing information.

    JSON representation 
     { 
 "learnmoreUrl" 
 : 
 string 
 , 
 "pricingUrl" 
 : 
 string 
 }
    Fields
    learnmoreUrl

    string

    Provides a URL where service consumers can learn more about the product.
    pricingUrl

    string

    Provides a link to pricing information for the service, such as https://cloud.google.com/bigquery/pricing .

    McpServer

    Configuration for MCP server. Reference: google3/google/api/mcp.proto

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "urls" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    name

    string

    Name of the server.
    description

    string

    Description of the server.
    urls[]

    string

    Addresses of the server. There are typically multiple addresses for a server, e.g. one for each region.

    Methods

    batchGet

    		Get the details of a collection of services.

    get

    		Get the details of a service.

    list

    		List public services.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: