Class EventGuest

  • EventGuest represents a guest of an event.

  • The EventGuest object provides methods to retrieve information about a guest, including the number of additional guests, email address, guest status, and name.

  • ThegetStatus() method is deprecated and should not be used in new scripts;getGuestStatus() should be used instead.

EventGuest

Represents a guest of an event.

Methods

MethodReturn typeBrief description
getAdditionalGuests()IntegerGets the number of additional people that this guest has said are attending.
getEmail()StringGets the email address of the guest.
getGuestStatus()GuestStatusGets the status of the guest for the event.
getName()StringGets the name of the guest.

Deprecated methods

MethodReturn typeBrief description
getStatus()StringGets the status of the guest for the event.

Detailed documentation

getAdditionalGuests()

Gets the number of additional people that this guest has said are attending.

Return

Integer — the number of additional people this guest has said are attending

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEmail()

Gets the email address of the guest.

Return

String — the guest's email address

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getGuestStatus()

Gets the status of the guest for the event.

Return

GuestStatus — the status of this guest

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getName()

Gets the name of the guest. If the name of the guest is not available, this method returns theguest's email address.

Return

String — the guest's name, or the guest's email address if the name is not available

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

Deprecated methods

getStatus()

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the status of the guest for the event.

Return

String — the status of this guest

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-11 UTC.