OAuth2 scopes used by this API.
const (
// See your primary Google Account email address
UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
// See your personal info, including any personal info you've made publicly
// available
UserinfoProfileScope = "https://www.googleapis.com/auth/userinfo.profile"
// Associate you with your personal info on Google
OpenIDScope = "openid"
)
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Userinfo *UserinfoService
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
func (s *Service) Tokeninfo() *TokeninfoCall
Tokeninfo:
type Tokeninfo struct {
// Audience: Who is the intended audience for this token. In general the same
// as issued_to.
Audience string `json:"audience,omitempty"`
// Email: The email address of the user. Present only if the email scope is
// present in the request.
Email string `json:"email,omitempty"`
// ExpiresIn: The expiry time of the token, as number of seconds left until
// expiry.
ExpiresIn int64 `json:"expires_in,omitempty"`
// IssuedTo: To whom was the token issued to. In general the same as audience.
IssuedTo string `json:"issued_to,omitempty"`
// Scope: The space separated list of scopes granted to this token.
Scope string `json:"scope,omitempty"`
// UserId: The obfuscated user id.
UserId string `json:"user_id,omitempty"`
// VerifiedEmail: Boolean flag which is true if the email address is verified.
// Present only if the email scope is present in the request.
VerifiedEmail bool `json:"verified_email,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Audience") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Audience") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Tokeninfo) MarshalJSON() ([]byte, error)
type TokeninfoCall struct {
// contains filtered or unexported fields
}
func (c *TokeninfoCall) AccessToken(accessToken string) *TokeninfoCall
AccessToken sets the optional parameter "access_token":
func (c *TokeninfoCall) Context(ctx context.Context) *TokeninfoCall
Context sets the context to be used in this call's Do method.
func (c *TokeninfoCall) Do(opts ...googleapi.CallOption) (*Tokeninfo, error)
Do executes the "oauth2.tokeninfo" call. Any non-2xx status code is an error. Response headers are in either *Tokeninfo.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *TokeninfoCall) Fields(s ...googleapi.Field) *TokeninfoCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *TokeninfoCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *TokeninfoCall) IdToken(idToken string) *TokeninfoCall
IdToken sets the optional parameter "id_token":
type Userinfo struct {
// Email: The user's email address.
Email string `json:"email,omitempty"`
// FamilyName: The user's last name.
FamilyName string `json:"family_name,omitempty"`
// Gender: The user's gender.
Gender string `json:"gender,omitempty"`
// GivenName: The user's first name.
GivenName string `json:"given_name,omitempty"`
// Hd: The hosted domain e.g. example.com if the user is Google apps user.
Hd string `json:"hd,omitempty"`
// Id: The obfuscated ID of the user.
Id string `json:"id,omitempty"`
// Link: URL of the profile page.
Link string `json:"link,omitempty"`
// Locale: The user's preferred locale.
Locale string `json:"locale,omitempty"`
// Name: The user's full name.
Name string `json:"name,omitempty"`
// Picture: URL of the user's picture image.
Picture string `json:"picture,omitempty"`
// VerifiedEmail: Boolean flag which is true if the email address is verified.
// Always verified because we only return the user's primary email address.
//
// Default: true
VerifiedEmail *bool `json:"verified_email,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Email") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Email") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Userinfo) MarshalJSON() ([]byte, error)
type UserinfoGetCall struct {
// contains filtered or unexported fields
}
func (c *UserinfoGetCall) Context(ctx context.Context) *UserinfoGetCall
Context sets the context to be used in this call's Do method.
func (c *UserinfoGetCall) Do(opts ...googleapi.CallOption) (*Userinfo, error)
Do executes the "oauth2.userinfo.get" call. Any non-2xx status code is an error. Response headers are in either *Userinfo.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *UserinfoGetCall) Fields(s ...googleapi.Field) *UserinfoGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *UserinfoGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *UserinfoGetCall) IfNoneMatch(entityTag string) *UserinfoGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type UserinfoService struct {
V2 *UserinfoV2Service
// contains filtered or unexported fields
}
func NewUserinfoService(s *Service) *UserinfoService
func (r *UserinfoService) Get() *UserinfoGetCall
Get:
type UserinfoV2MeGetCall struct {
// contains filtered or unexported fields
}
func (c *UserinfoV2MeGetCall) Context(ctx context.Context) *UserinfoV2MeGetCall
Context sets the context to be used in this call's Do method.
func (c *UserinfoV2MeGetCall) Do(opts ...googleapi.CallOption) (*Userinfo, error)
Do executes the "oauth2.userinfo.v2.me.get" call. Any non-2xx status code is an error. Response headers are in either *Userinfo.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *UserinfoV2MeGetCall) Fields(s ...googleapi.Field) *UserinfoV2MeGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *UserinfoV2MeGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *UserinfoV2MeGetCall) IfNoneMatch(entityTag string) *UserinfoV2MeGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type UserinfoV2MeService struct {
// contains filtered or unexported fields
}
func NewUserinfoV2MeService(s *Service) *UserinfoV2MeService
func (r *UserinfoV2MeService) Get() *UserinfoV2MeGetCall
Get:
type UserinfoV2Service struct {
Me *UserinfoV2MeService
// contains filtered or unexported fields
}
func NewUserinfoV2Service(s *Service) *UserinfoV2Service