Skip to main content
Google Workspace
  • Google Workspace
Home Google Meet All products
  • Google Workspace apps
  • Admin console
  • Cloud Search
  • Gmail
  • Google Calendar
  • Google Chat
  • Google Classroom
  • Google Docs
  • Google Drive
  •  
  • Google Forms
  • Google Keep
  • Google Meet
  • Google Sheets
  • Google Sites
  • Google Slides
  • Google Tasks
  • Google Vault
  • Extend, automate & share
  • Add-ons
  • Apps Script
  • Chat apps
  • Drive apps
  • Marketplace
Resources
  • Tools
  • Admin console
  • Apps Script dashboard
  • Google Cloud console
  • APIs Explorer
  • Card Builder
  • Training & support
  • How to get started
  • Codelabs
  • Developer support
  • Updates
  • Blog
  • Developer Previews
  • Newsletter
  • X (Twitter)
  • YouTube
/
  • English
  • Deutsch
  • Español
  • Español – América Latina
  • Français
  • Indonesia
  • Italiano
  • Polski
  • Português – Brasil
  • Tiếng Việt
  • Türkçe
  • Русский
  • עברית
  • العربيّة
  • فارسی
  • हिंदी
  • বাংলা
  • ภาษาไทย
  • 中文 – 简体
  • 中文 – 繁體
  • 日本語
  • 한국어
  • Google Meet
Overview Guides Reference Support Meet add-ons SDK for Android (Early access) Meet Live Sharing for iOS (Early access) Meet Embed SDK Web (Early access) Meet add-ons in Rooms (Early access)
Google Workspace
  • Google Workspace
  • Home
  • Google Meet
    • Overview
    • Guides
    • Reference
    • Support
    • Meet add-ons SDK for Android (Early access)
    • Meet Live Sharing for iOS (Early access)
    • Meet Embed SDK Web (Early access)
    • Meet add-ons in Rooms (Early access)
  • All products
    • More
  • Resources
    • More
  • Meet SDK and API reference
  • Meet add-ons SDK for Web
  • Summary (meet.addons.screenshare)
  • Interfaces
    • AddonScreenshareInfo
      • Overview
      • Property signatures
        • additionalData
        • cloudProjectNumber
        • mainStageUrl
        • sidePanelUrl
        • startActivityOnOpen
    • MeetAddonScreenshare
      • Overview
      • Method signatures
        • exposeToMeetWhenScreensharing
    • MeetAddonScreenshareExport
      • Overview
      • Property signatures
        • addon
  • Variables
    • meet
  • Summary (meet.addons)
  • Interfaces
    • ActivityStartingState
      • Overview
      • Property signatures
        • additionalData
        • mainStageUrl
        • sidePanelUrl
    • AddonCallbacks
      • Overview
      • Property signatures
        • frameToFrameMessage
    • AddonSession
      • Overview
      • Method signatures
        • createCoDoingClient
        • createCoWatchingClient
        • createMainStageClient
        • createSidePanelClient
    • AddonSessionOptions
      • Overview
      • Property signatures
        • cloudProjectNumber
    • FrameToFrameMessage
      • Overview
      • Property signatures
        • originator
        • payload
    • MeetAddon
      • Overview
      • Property signatures
        • createAddonSession
        • getFrameType
    • MeetAddonClient
      • Overview
      • Method signatures
        • closeAddon
        • endActivity
        • getActivityStartingState
        • getFrameOpenReason
        • getMeetingInfo
        • on
        • setActivityStartingState
        • startActivity
    • MeetAddonError
      • Overview
      • Property signatures
        • errorType
    • MeetAddonExport
      • Overview
      • Property signatures
        • addon
    • MeetingInfo
      • Overview
      • Property signatures
        • meetingCode
        • meetingId
    • MeetMainStageClient
      • Overview
      • Method signatures
        • loadSidePanel
        • notifySidePanel
        • unloadSidePanel
    • MeetSidePanelClient
      • Overview
      • Method signatures
        • notifyMainStage
  • Type aliases
    • ErrorType
    • FrameOpenReason
    • FrameType
  • Variables
    • meet
  • Summary (meet.addons.coactivity)
  • Interfaces
    • CoActivityDelegate
      • Overview
      • Property signatures
        • activityTitle
    • CoDoingClient
      • Overview
      • Method signatures
        • broadcastStateUpdate
    • CoDoingDelegate
      • Overview
      • Method signatures
        • onCoDoingStateChanged
    • CoDoingState
      • Overview
      • Property signatures
        • bytes
    • CoWatchingClient
      • Overview
      • Method signatures
        • notifyBuffering
        • notifyPauseState
        • notifyPlayoutRate
        • notifyReady
        • notifySeekToTimestamp
        • notifySwitchedToMedia
    • CoWatchingDelegate
      • Overview
      • Method signatures
        • onCoWatchingStateChanged
        • onCoWatchingStateQuery
    • CoWatchingState
      • Overview
      • Property signatures
        • mediaId
        • mediaPlayoutPosition
        • mediaPlayoutRate
        • playbackState
  • Type aliases
    • CoWatchingQueryResponse
    • PlaybackState
  • Meet REST API
  • v2
    • Overview
    • REST Resources
    • conferenceRecords
      • Overview
      • get
      • list
    • conferenceRecords.participants
      • Overview
      • get
      • list
    • conferenceRecords.participants.participantSessions
      • Overview
      • get
      • list
    • conferenceRecords.recordings
      • Overview
      • get
      • list
    • conferenceRecords.transcripts
      • Overview
      • get
      • list
    • conferenceRecords.transcripts.entries
      • Overview
      • get
      • list
    • spaces
      • Overview
      • create
      • endActiveConference
      • get
      • patch
  • Client libraries
    • Browser
    • Go
    • Java
      • Core library
      • API library
    • .NET
      • Core library
      • API library
    • Node.js
    • PHP
    • Python
      • Core library
      • API library
    • Ruby
  • Client library downloads
  • Usage limits
  • Meet Media API
  • C++ reference client
    • Quickstart
    • Classes
      • meet::MediaApiClientFactoryInterface
      • meet::MediaApiClientInterface
      • meet::MediaApiClientObserverInterface
    • Structs
      • meet::AnonymousUser
      • meet::AudioFrame
      • meet::CanvasDimensions
      • meet::LayoutModel
      • meet::LeaveRequest
      • meet::LeaveResponse
      • meet::MediaApiClientConfiguration
      • meet::MediaEntriesChannelToClient
      • meet::MediaEntriesDeletedResource
      • meet::MediaEntriesResourceSnapshot
      • meet::MediaEntry
      • meet::MediaStatsChannelFromClient
      • meet::MediaStatsChannelToClient
      • meet::MediaStatsConfiguration
      • meet::MediaStatsRequest
      • meet::MediaStatsResourceSnapshot
      • meet::MediaStatsResponse
      • meet::MediaStatsResponse::UploadMediaStatsResponse
      • meet::MediaStatsSection
      • meet::Participant
      • meet::ParticipantDeletedResource
      • meet::ParticipantResourceSnapshot
      • meet::ParticipantsChannelToClient
      • meet::PhoneUser
      • meet::SessionControlChannelFromClient
      • meet::SessionControlChannelToClient
      • meet::SessionControlRequest
      • meet::SessionControlResourceSnapshot
      • meet::SessionControlResponse
      • meet::SessionStatus
      • meet::SetVideoAssignmentRequest
      • meet::SignedInUser
      • meet::UploadMediaStatsRequest
      • meet::VideoAssignment
      • meet::VideoAssignmentChannelFromClient
      • meet::VideoAssignmentChannelToClient
      • meet::VideoAssignmentRequest
      • meet::VideoAssignmentResourceSnapshot
      • meet::VideoAssignmentResponse
      • meet::VideoAssignmentResponse::SetVideoAssignmentResponse
      • meet::VideoCanvas
      • meet::VideoCanvasAssignment
      • meet::VideoFrame
      • meet::VideoResolution
    • Namespaces
      • meet
  • TypeScript reference client
    • Quickstart
    • Resource summary
    • Interfaces
      • AnonymousUser
        • Overview
        • Property signatures
          • displayName
      • BaseParticipant
        • Overview
        • Property signatures
          • anonymousUser
          • name
          • participantKey
          • phoneUser
          • signedInUser
      • CanvasDimensions
        • Overview
        • Property signatures
          • height
          • width
      • LogEvent
        • Overview
        • Property signatures
          • level
          • logString
          • relevantObject
          • sourceType
      • MediaApiCommunicationProtocol
        • Overview
        • Method signatures
          • connectActiveConference
      • MediaApiCommunicationResponse
        • Overview
        • Property signatures
          • answer
      • MediaEntry
        • Overview
        • Property signatures
          • audioMeetStreamTrack
          • audioMuted
          • isPresenter
          • mediaLayout
          • participant
          • screenShare
          • session
          • sessionName
          • videoMeetStreamTrack
          • videoMuted
      • MediaLayout
        • Overview
        • Property signatures
          • canvasDimensions
          • mediaEntry
      • MediaLayoutRequest
        • Overview
        • Property signatures
          • mediaLayout
      • MeetMediaApiClient
        • Overview
        • Method signatures
          • applyLayout
          • createMediaLayout
          • joinMeeting
          • leaveMeeting
        • Property signatures
          • mediaEntries
          • meetStreamTracks
          • participants
          • presenter
          • screenshare
          • sessionStatus
      • MeetMediaClientRequiredConfiguration
        • Overview
        • Property signatures
          • accessToken
          • enableAudioStreams
          • logsCallback
          • meetingSpaceId
          • numberOfVideoStreams
      • MeetSessionStatus
        • Overview
        • Property signatures
          • connectionState
          • disconnectReason
      • MeetStreamTrack
        • Overview
        • Property signatures
          • mediaEntry
          • mediaStreamTrack
      • Participant
        • Overview
        • Property signatures
          • mediaEntries
          • participant
      • PhoneUser
        • Overview
        • Property signatures
          • displayName
      • SignedInUser
        • Overview
        • Property signatures
          • displayName
          • user
      • Subscribable
        • Overview
        • Method signatures
          • get
          • subscribe
          • unsubscribe
    • Type aliases
      • LogSourceType
  • Meet REST API
    • connectActiveConference
  • Meet Media API data channels
  • Resource summary
  • Interfaces
    • AnonymousUser
      • Overview
      • Property signatures
        • displayName
    • BaseParticipant
      • Overview
      • Property signatures
        • anonymousUser
        • name
        • participantId
        • participantKey
        • phoneUser
        • signedInUser
    • CanvasAssignment
      • Overview
      • Property signatures
        • canvasId
        • mediaEntryId
        • ssrc
    • CanvasDimensions
      • Overview
      • Property signatures
        • height
        • width
    • DeletedMediaEntry
      • Overview
      • Property signatures
        • mediaEntry
    • DeletedParticipant
      • Overview
      • Property signatures
        • participant
    • DeletedResource
      • Overview
      • Property signatures
        • id
    • LayoutModel
      • Overview
      • Property signatures
        • canvases
        • label
    • LeaveRequest
      • Overview
      • Property signatures
        • leave
    • LeaveResponse
      • Overview
      • Property signatures
        • leave
    • MediaApiCanvas
      • Overview
      • Property signatures
        • dimensions
        • id
        • relevant
    • MediaApiRequest
      • Overview
      • Property signatures
        • requestId
    • MediaApiResponse
      • Overview
      • Property signatures
        • requestId
        • status
    • MediaApiResponseStatus
      • Overview
      • Property signatures
        • code
        • details
        • message
    • MediaEntriesChannelToClient
      • Overview
      • Property signatures
        • deletedResources
        • resources
    • MediaEntry
      • Overview
      • Property signatures
        • audioCsrc
        • audioMuted
        • participant
        • participantId
        • participantKey
        • presenter
        • screenshare
        • session
        • sessionName
        • videoCsrcs
        • videoMuted
    • MediaEntryResource
      • Overview
      • Property signatures
        • mediaEntry
    • MediaStatsChannelFromClient
      • Overview
      • Property signatures
        • request
    • MediaStatsChannelToClient
      • Overview
      • Property signatures
        • resources
        • response
    • MediaStatsConfiguration
      • Overview
      • Property signatures
        • allowlist
        • uploadIntervalSeconds
    • MediaStatsResource
      • Overview
      • Property signatures
        • configuration
    • ParticipantResource
      • Overview
      • Property signatures
        • participant
    • ParticipantsChannelToClient
      • Overview
      • Property signatures
        • deletedResources
        • resources
    • PhoneUser
      • Overview
      • Property signatures
        • displayName
    • ResourceSnapshot
      • Overview
      • Property signatures
        • id
    • SessionControlChannelFromClient
      • Overview
      • Property signatures
        • request
    • SessionControlChannelToClient
      • Overview
      • Property signatures
        • resources
        • response
    • SessionStatus
      • Overview
      • Property signatures
        • connectionState
        • disconnectReason
    • SessionStatusResource
      • Overview
      • Property signatures
        • sessionStatus
    • SetVideoAssignmentRequest
      • Overview
      • Property signatures
        • setAssignment
    • SetVideoAssignmentResponse
      • Overview
      • Property signatures
        • setAssignment
    • SignedInUser
      • Overview
      • Property signatures
        • displayName
        • user
    • StatsSection
      • Overview
      • Property signatures
        • id
    • StatTypes
      • Overview
      • Property signatures
        • candidate_pair
        • codec
        • inbound_rtp
        • local_candidate
        • media_playout
        • remote_candidate
        • transport
    • UploadMediaStats
      • Overview
      • Property signatures
        • sections
    • UploadMediaStatsRequest
      • Overview
      • Property signatures
        • uploadMediaStats
    • UploadMediaStatsResponse
      • Overview
      • Property signatures
        • uploadMediaStats
    • VideoAssignmentChannelFromClient
      • Overview
      • Property signatures
        • request
    • VideoAssignmentChannelToClient
      • Overview
      • Property signatures
        • resources
        • response
    • VideoAssignmentLayoutModel
      • Overview
      • Property signatures
        • canvases
        • label
    • VideoAssignmentMaxResolution
      • Overview
      • Property signatures
        • frameRate
        • height
        • width
    • VideoAssignmentResource
      • Overview
      • Property signatures
        • videoAssignment
  • Type aliases
    • StatsSectionData
  • Google Workspace apps
  • Admin console
  • Cloud Search
  • Gmail
  • Google Calendar
  • Google Chat
  • Google Classroom
  • Google Docs
  • Google Drive
  •  
  • Google Forms
  • Google Keep
  • Google Meet
  • Google Sheets
  • Google Sites
  • Google Slides
  • Google Tasks
  • Google Vault
  • Extend, automate & share
  • Add-ons
  • Apps Script
  • Chat apps
  • Drive apps
  • Marketplace
  • Tools
  • Admin console
  • Apps Script dashboard
  • Google Cloud console
  • APIs Explorer
  • Card Builder
  • Training & support
  • How to get started
  • Codelabs
  • Developer support
  • Updates
  • Blog
  • Developer Previews
  • Newsletter
  • X (Twitter)
  • YouTube
  • Home
  • Google Workspace
  • Google Meet
  • Reference

Interface AddonSessionOptions

Parameters to retrieve the add-on session.

Signature

interface AddonSessionOptions

Property signatures

Name Description
cloudProjectNumber The Google Cloud project number of the add-on.

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

Last updated 2025-03-27 UTC.

  • Blog Blog
    Read the Google Workspace Developers blog
  • X (Twitter) X (Twitter)
    Follow @workspacedevs on X (Twitter)
  • Code Samples Code Samples
    Explore our sample apps or copy them to build your own
  • Codelabs Codelabs
    Try a guided, hands-on coding experience
  • Videos Videos
    Subscribe to our YouTube channel
  • Google Workspace for Developers

    • Platform overview
    • Developer products
    • Developer support
    • Terms of Service
  • Tools

    • Admin console
    • Apps Script Dashboard
    • Google Cloud console
    • APIs Explorer
  • Connect

    • Blog
    • Newsletter
    • X (Twitter)
    • YouTube
Google Developers
  • Android
  • Chrome
  • Firebase
  • Google Cloud Platform
  • All products
  • Terms
  • Privacy
  • ICP证合字B2-20070004号
  • Manage cookies
  • Sign up for the Google Developers newsletter Subscribe
  • English
  • Deutsch
  • Español
  • Español – América Latina
  • Français
  • Indonesia
  • Italiano
  • Polski
  • Português – Brasil
  • Tiếng Việt
  • Türkçe
  • Русский
  • עברית
  • العربيّة
  • فارسی
  • हिंदी
  • বাংলা
  • ภาษาไทย
  • 中文 – 简体
  • 中文 – 繁體
  • 日本語
  • 한국어