type AndroidConfig struct {// BandwidthConstrainedOk: Optional. If set to true, messages will be allowed// to be delivered to the app while the device is in bandwidth constrained// mode. This should only be enabled when the app has been tested to properly// handle messages in bandwidth constrained mode.BandwidthConstrainedOkbool `json:"bandwidthConstrainedOk,omitempty"`// CollapseKey: An identifier of a group of messages that can be collapsed, so// that only the last message gets sent when delivery can be resumed. A maximum// of 4 different collapse keys is allowed at any given time.CollapseKeystring `json:"collapseKey,omitempty"`// Data: Arbitrary key/value payload. If present, it will override// google.firebase.fcm.v1.Message.data.Data map[string]string `json:"data,omitempty"`// DirectBootOk: Optional. If set to true, messages will be allowed to be// delivered to the app while the device is in direct boot mode. See Support// Direct Boot mode// (https://developer.android.com/training/articles/direct-boot).DirectBootOkbool `json:"directBootOk,omitempty"`// FcmOptions: Options for features provided by the FCM SDK for Android.FcmOptions *AndroidFcmOptions `json:"fcmOptions,omitempty"`// Notification: Notification to send to android devices.Notification *AndroidNotification `json:"notification,omitempty"`// Priority: Message priority. Can take "normal" and "high" values. For more// information, see Setting the priority of a message (https://goo.gl/GjONJv).//// Possible values://   "NORMAL" - Default priority for data messages. Normal priority messages// won't open network connections on a sleeping device, and their delivery may// be delayed to conserve the battery. For less time-sensitive messages, such// as notifications of new email or other data to sync, choose normal delivery// priority.//   "HIGH" - Default priority for notification messages. FCM attempts to// deliver high priority messages immediately, allowing the FCM service to wake// a sleeping device when possible and open a network connection to your app// server. Apps with instant messaging, chat, or voice call alerts, for// example, generally need to open a network connection and make sure FCM// delivers the message to the device without delay. Set high priority if the// message is time-critical and requires the user's immediate interaction, but// beware that setting your messages to high priority contributes more to// battery drain compared with normal priority messages.Prioritystring `json:"priority,omitempty"`// RestrictedPackageName: Package name of the application where the// registration token must match in order to receive the message.RestrictedPackageNamestring `json:"restrictedPackageName,omitempty"`// RestrictedSatelliteOk: Optional. If set to true, messages will be allowed to// be delivered to the app while the device is connected over a restricted// satellite network. This should only be enabled for messages that can be// handled over a restricted satellite network and only for apps that are// enabled to work over a restricted satellite network. Note that the ability// of the app to connect to a restricted satellite network is dependent on the// carrier's settings and the device model.RestrictedSatelliteOkbool `json:"restrictedSatelliteOk,omitempty"`// Ttl: How long (in seconds) the message should be kept in FCM storage if the// device is offline. The maximum time to live supported is 4 weeks, and the// default value is 4 weeks if not set. Set it to 0 if want to send the message// immediately. In JSON format, the Duration type is encoded as a string rather// than an object, where the string ends in the suffix "s" (indicating seconds)// and is preceded by the number of seconds, with nanoseconds expressed as// fractional seconds. For example, 3 seconds with 0 nanoseconds should be// encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be// expressed in JSON format as "3.000000001s". The ttl will be rounded down to// the nearest second.Ttlstring `json:"ttl,omitempty"`// ForceSendFields is a list of field names (e.g. "BandwidthConstrainedOk") 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. "BandwidthConstrainedOk") 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 (AndroidConfig)MarshalJSON¶

func (sAndroidConfig) MarshalJSON() ([]byte,error)

type AndroidFcmOptions struct {// AnalyticsLabel: Label associated with the message's analytics data.AnalyticsLabelstring `json:"analyticsLabel,omitempty"`// ForceSendFields is a list of field names (e.g. "AnalyticsLabel") 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. "AnalyticsLabel") 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 (AndroidFcmOptions)MarshalJSON¶added inv0.7.0

func (sAndroidFcmOptions) MarshalJSON() ([]byte,error)

type AndroidNotification struct {// Body: The notification's body text. If present, it will override// google.firebase.fcm.v1.Notification.body.Bodystring `json:"body,omitempty"`// BodyLocArgs: Variable string values to be used in place of the format// specifiers in body_loc_key to use to localize the body text to the user's// current localization. See Formatting and Styling (https://goo.gl/MalYE3) for// more information.BodyLocArgs []string `json:"bodyLocArgs,omitempty"`// BodyLocKey: The key to the body string in the app's string resources to use// to localize the body text to the user's current localization. See String// Resources (https://goo.gl/NdFZGI) for more information.BodyLocKeystring `json:"bodyLocKey,omitempty"`// BypassProxyNotification: If set, display notifications delivered to the// device will be handled by the app instead of the proxy.BypassProxyNotificationbool `json:"bypassProxyNotification,omitempty"`// ChannelId: The notification's channel id// (https://developer.android.com/guide/topics/ui/notifiers/notifications#ManageChannels)// (new in Android O). The app must create a channel with this channel ID// before any notification with this channel ID is received. If you don't send// this channel ID in the request, or if the channel ID provided has not yet// been created by the app, FCM uses the channel ID specified in the app// manifest.ChannelIdstring `json:"channelId,omitempty"`// ClickAction: The action associated with a user click on the notification. If// specified, an activity with a matching intent filter is launched when a user// clicks on the notification.ClickActionstring `json:"clickAction,omitempty"`// Color: The notification's icon color, expressed in #rrggbb format.Colorstring `json:"color,omitempty"`// DefaultLightSettings: If set to true, use the Android framework's default// LED light settings for the notification. Default values are specified in// config.xml// (https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml).// If `default_light_settings` is set to true and `light_settings` is also set,// the user-specified `light_settings` is used instead of the default value.DefaultLightSettingsbool `json:"defaultLightSettings,omitempty"`// DefaultSound: If set to true, use the Android framework's default sound for// the notification. Default values are specified in config.xml// (https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml).DefaultSoundbool `json:"defaultSound,omitempty"`// DefaultVibrateTimings: If set to true, use the Android framework's default// vibrate pattern for the notification. Default values are specified in// config.xml// (https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml).// If `default_vibrate_timings` is set to true and `vibrate_timings` is also// set, the default value is used instead of the user-specified// `vibrate_timings`.DefaultVibrateTimingsbool `json:"defaultVibrateTimings,omitempty"`// EventTime: Set the time that the event in the notification occurred.// Notifications in the panel are sorted by this time. A point in time is// represented using protobuf.Timestamp// (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Timestamp).EventTimestring `json:"eventTime,omitempty"`// Icon: The notification's icon. Sets the notification icon to myicon for// drawable resource myicon. If you don't send this key in the request, FCM// displays the launcher icon specified in your app manifest.Iconstring `json:"icon,omitempty"`// Image: Contains the URL of an image that is going to be displayed in a// notification. If present, it will override// google.firebase.fcm.v1.Notification.image.Imagestring `json:"image,omitempty"`// LightSettings: Settings to control the notification's LED blinking rate and// color if LED is available on the device. The total blinking time is// controlled by the OS.LightSettings *LightSettings `json:"lightSettings,omitempty"`// LocalOnly: Set whether or not this notification is relevant only to the// current device. Some notifications can be bridged to other devices for// remote display, such as a Wear OS watch. This hint can be set to recommend// this notification not be bridged. See Wear OS guides// (https://developer.android.com/training/wearables/notifications/bridger#existing-method-of-preventing-bridging)LocalOnlybool `json:"localOnly,omitempty"`// NotificationCount: Sets the number of items this notification represents.// May be displayed as a badge count for launchers that support badging.See// Notification Badge// (https://developer.android.com/training/notify-user/badges). For example,// this might be useful if you're using just one notification to represent// multiple new messages but you want the count here to represent the number of// total new messages. If zero or unspecified, systems that support badging use// the default, which is to increment a number displayed on the long-press menu// each time a new notification arrives.NotificationCountint64 `json:"notificationCount,omitempty"`// NotificationPriority: Set the relative priority for this notification.// Priority is an indication of how much of the user's attention should be// consumed by this notification. Low-priority notifications may be hidden from// the user in certain situations, while the user might be interrupted for a// higher-priority notification. The effect of setting the same priorities may// differ slightly on different platforms. Note this priority differs from// `AndroidMessagePriority`. This priority is processed by the client after the// message has been delivered, whereas AndroidMessagePriority// (https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority)// is an FCM concept that controls when the message is delivered.//// Possible values://   "PRIORITY_UNSPECIFIED" - If priority is unspecified, notification priority// is set to `PRIORITY_DEFAULT`.//   "PRIORITY_MIN" - Lowest notification priority. Notifications with this// `PRIORITY_MIN` might not be shown to the user except under special// circumstances, such as detailed notification logs.//   "PRIORITY_LOW" - Lower notification priority. The UI may choose to show// the notifications smaller, or at a different position in the list, compared// with notifications with `PRIORITY_DEFAULT`.//   "PRIORITY_DEFAULT" - Default notification priority. If the application// does not prioritize its own notifications, use this value for all// notifications.//   "PRIORITY_HIGH" - Higher notification priority. Use this for more// important notifications or alerts. The UI may choose to show these// notifications larger, or at a different position in the notification lists,// compared with notifications with `PRIORITY_DEFAULT`.//   "PRIORITY_MAX" - Highest notification priority. Use this for the// application's most important items that require the user's prompt attention// or input.NotificationPrioritystring `json:"notificationPriority,omitempty"`// Proxy: Setting to control when a notification may be proxied.//// Possible values://   "PROXY_UNSPECIFIED" - If unspecified, default to// `Proxy.IF_PRIORITY_LOWERED`.//   "ALLOW" - Try to proxy this notification.//   "DENY" - Do not proxy this notification.//   "IF_PRIORITY_LOWERED" - Only try to proxy this notification if its// `AndroidMessagePriority` was lowered from `HIGH` to `NORMAL` on the device.Proxystring `json:"proxy,omitempty"`// Sound: The sound to play when the device receives the notification. Supports// "default" or the filename of a sound resource bundled in the app. Sound// files must reside in /res/raw/.Soundstring `json:"sound,omitempty"`// Sticky: When set to false or unset, the notification is automatically// dismissed when the user clicks it in the panel. When set to true, the// notification persists even when the user clicks it.Stickybool `json:"sticky,omitempty"`// Tag: Identifier used to replace existing notifications in the notification// drawer. If not specified, each request creates a new notification. If// specified and a notification with the same tag is already being shown, the// new notification replaces the existing one in the notification drawer.Tagstring `json:"tag,omitempty"`// Ticker: Sets the "ticker" text, which is sent to accessibility services.// Prior to API level 21 (`Lollipop`), sets the text that is displayed in the// status bar when the notification first arrives.Tickerstring `json:"ticker,omitempty"`// Title: The notification's title. If present, it will override// google.firebase.fcm.v1.Notification.title.Titlestring `json:"title,omitempty"`// TitleLocArgs: Variable string values to be used in place of the format// specifiers in title_loc_key to use to localize the title text to the user's// current localization. See Formatting and Styling (https://goo.gl/MalYE3) for// more information.TitleLocArgs []string `json:"titleLocArgs,omitempty"`// TitleLocKey: The key to the title string in the app's string resources to// use to localize the title text to the user's current localization. See// String Resources (https://goo.gl/NdFZGI) for more information.TitleLocKeystring `json:"titleLocKey,omitempty"`// VibrateTimings: Set the vibration pattern to use. Pass in an array of// protobuf.Duration// (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration)// to turn on or off the vibrator. The first value indicates the `Duration` to// wait before turning the vibrator on. The next value indicates the `Duration`// to keep the vibrator on. Subsequent values alternate between `Duration` to// turn the vibrator off and to turn the vibrator on. If `vibrate_timings` is// set and `default_vibrate_timings` is set to `true`, the default value is// used instead of the user-specified `vibrate_timings`.VibrateTimings []string `json:"vibrateTimings,omitempty"`// Visibility: Set the Notification.visibility// (https://developer.android.com/reference/android/app/Notification.html#visibility)// of the notification.//// Possible values://   "VISIBILITY_UNSPECIFIED" - If unspecified, default to// `Visibility.PRIVATE`.//   "PRIVATE" - Show this notification on all lockscreens, but conceal// sensitive or private information on secure lockscreens.//   "PUBLIC" - Show this notification in its entirety on all lockscreens.//   "SECRET" - Do not reveal any part of this notification on a secure// lockscreen.Visibilitystring `json:"visibility,omitempty"`// ForceSendFields is a list of field names (e.g. "Body") 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. "Body") 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 (AndroidNotification)MarshalJSON¶

func (sAndroidNotification) MarshalJSON() ([]byte,error)

type ApnsConfig struct {// FcmOptions: Options for features provided by the FCM SDK for iOS.FcmOptions *ApnsFcmOptions `json:"fcmOptions,omitempty"`// Headers: HTTP request headers defined in Apple Push Notification Service.// Refer to APNs request headers// (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns)// for supported headers such as `apns-expiration` and `apns-priority`. The// backend sets a default value for `apns-expiration` of 30 days and a default// value for `apns-priority` of 10 if not explicitly set.Headers map[string]string `json:"headers,omitempty"`// LiveActivityToken: Optional. Apple Live Activity// (https://developer.apple.com/design/human-interface-guidelines/live-activities)// token to send updates to. This token can either be a push token or// push-to-start// (https://developer.apple.com/documentation/activitykit/activity/pushtostarttoken)// token from Apple. To start, update, or end a live activity remotely using// FCM, construct an `aps payload`// (https://developer.apple.com/documentation/activitykit/starting-and-updating-live-activities-with-activitykit-push-notifications#Construct-the-payload-that-starts-a-Live-Activity)// and put it in the `apns.payload`// (https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#ApnsConfig)// field.LiveActivityTokenstring `json:"liveActivityToken,omitempty"`// Payload: APNs payload as a JSON object, including both `aps` dictionary and// custom payload. See Payload Key Reference// (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification).// If present, it overrides google.firebase.fcm.v1.Notification.title and// google.firebase.fcm.v1.Notification.body.Payloadgoogleapi.RawMessage `json:"payload,omitempty"`// ForceSendFields is a list of field names (e.g. "FcmOptions") 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. "FcmOptions") 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 (ApnsConfig)MarshalJSON¶

func (sApnsConfig) MarshalJSON() ([]byte,error)

type ApnsFcmOptions struct {// AnalyticsLabel: Label associated with the message's analytics data.AnalyticsLabelstring `json:"analyticsLabel,omitempty"`// Image: Contains the URL of an image that is going to be displayed in a// notification. If present, it will override// google.firebase.fcm.v1.Notification.image.Imagestring `json:"image,omitempty"`// ForceSendFields is a list of field names (e.g. "AnalyticsLabel") 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. "AnalyticsLabel") 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 (ApnsFcmOptions)MarshalJSON¶added inv0.7.0

func (sApnsFcmOptions) MarshalJSON() ([]byte,error)

type Color struct {// Alpha: The fraction of this color that should be applied to the pixel. That// is, the final pixel color is defined by the equation: `pixel color = alpha *// (this color) + (1.0 - alpha) * (background color)` This means that a value// of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a// completely transparent color. This uses a wrapper message rather than a// simple float scalar so that it is possible to distinguish between a default// value and the value being unset. If omitted, this color object is rendered// as a solid color (as if the alpha value had been explicitly given a value of// 1.0).Alphafloat64 `json:"alpha,omitempty"`// Blue: The amount of blue in the color as a value in the interval [0, 1].Bluefloat64 `json:"blue,omitempty"`// Green: The amount of green in the color as a value in the interval [0, 1].Greenfloat64 `json:"green,omitempty"`// Red: The amount of red in the color as a value in the interval [0, 1].Redfloat64 `json:"red,omitempty"`// ForceSendFields is a list of field names (e.g. "Alpha") 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. "Alpha") 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 (Color)MarshalJSON¶added inv0.10.0

func (sColor) MarshalJSON() ([]byte,error)

func (*Color)UnmarshalJSON¶added inv0.10.0

func (s *Color) UnmarshalJSON(data []byte)error

type FcmOptions struct {// AnalyticsLabel: Label associated with the message's analytics data.AnalyticsLabelstring `json:"analyticsLabel,omitempty"`// ForceSendFields is a list of field names (e.g. "AnalyticsLabel") 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. "AnalyticsLabel") 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 (FcmOptions)MarshalJSON¶added inv0.7.0

func (sFcmOptions) MarshalJSON() ([]byte,error)

type LightSettings struct {// Color: Required. Set `color` of the LED with google.type.Color// (https://github.com/googleapis/googleapis/blob/master/google/type/color.proto).Color *Color `json:"color,omitempty"`// LightOffDuration: Required. Along with `light_on_duration `, define the// blink rate of LED flashes. Resolution defined by proto.Duration// (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration)LightOffDurationstring `json:"lightOffDuration,omitempty"`// LightOnDuration: Required. Along with `light_off_duration`, define the blink// rate of LED flashes. Resolution defined by proto.Duration// (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration)LightOnDurationstring `json:"lightOnDuration,omitempty"`// ForceSendFields is a list of field names (e.g. "Color") 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. "Color") 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 (LightSettings)MarshalJSON¶added inv0.10.0

func (sLightSettings) MarshalJSON() ([]byte,error)

type Message struct {// Android: Input only. Android specific options for messages sent through FCM// connection server (https://goo.gl/4GLdUl).Android *AndroidConfig `json:"android,omitempty"`// Apns: Input only. Apple Push Notification Service (https://goo.gl/MXRTPa)// specific options.Apns *ApnsConfig `json:"apns,omitempty"`// Condition: Condition to send a message to, e.g. "'foo' in topics && 'bar' in// topics".Conditionstring `json:"condition,omitempty"`// Data: Input only. Arbitrary key/value payload, which must be UTF-8 encoded.// The key should not be a reserved word ("from", "message_type", or any word// starting with "google." or "gcm.notification."). When sending payloads// containing only data fields to iOS devices, only normal priority// ("apns-priority": "5") is allowed in `ApnsConfig`// (/docs/reference/fcm/rest/v1/projects.messages#apnsconfig).Data map[string]string `json:"data,omitempty"`// FcmOptions: Input only. Template for FCM SDK feature options to use across// all platforms.FcmOptions *FcmOptions `json:"fcmOptions,omitempty"`// Name: Output Only. The identifier of the message sent, in the format of// `projects/*/messages/{message_id}`.Namestring `json:"name,omitempty"`// Notification: Input only. Basic notification template to use across all// platforms.Notification *Notification `json:"notification,omitempty"`// Token: Registration token to send a message to.Tokenstring `json:"token,omitempty"`// Topic: Topic name to send a message to, e.g. "weather". Note: "/topics/"// prefix should not be provided.Topicstring `json:"topic,omitempty"`// Webpush: Input only. Webpush protocol (https://tools.ietf.org/html/rfc8030)// options.Webpush *WebpushConfig `json:"webpush,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Android") 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. "Android") 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 (Message)MarshalJSON¶

func (sMessage) MarshalJSON() ([]byte,error)

type Notification struct {// Body: The notification's body text.Bodystring `json:"body,omitempty"`// Image: Contains the URL of an image that is going to be downloaded on the// device and displayed in a notification. JPEG, PNG, BMP have full support// across platforms. Animated GIF and video only work on iOS. WebP and HEIF// have varying levels of support across platforms and platform versions.// Android has 1MB image size limit. Quota usage and implications/costs for// hosting image on Firebase Storage:https://firebase.google.com/pricingImagestring `json:"image,omitempty"`// Title: The notification's title.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Body") 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. "Body") 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 (Notification)MarshalJSON¶

func (sNotification) MarshalJSON() ([]byte,error)

type ProjectsMessagesSendCall struct {// contains filtered or unexported fields}

func (*ProjectsMessagesSendCall)Context¶

func (c *ProjectsMessagesSendCall) Context(ctxcontext.Context) *ProjectsMessagesSendCall

Context sets the context to be used in this call's Do method.

func (*ProjectsMessagesSendCall)Do¶

func (c *ProjectsMessagesSendCall) Do(opts ...googleapi.CallOption) (*Message,error)

Do executes the "fcm.projects.messages.send" call.Any non-2xx status code is an error. Response headers are in either*Message.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsMessagesSendCall)Fields¶

func (c *ProjectsMessagesSendCall) Fields(s ...googleapi.Field) *ProjectsMessagesSendCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsMessagesSendCall)Header¶

func (c *ProjectsMessagesSendCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

type ProjectsMessagesService struct {// contains filtered or unexported fields}

funcNewProjectsMessagesService¶

func NewProjectsMessagesService(s *Service) *ProjectsMessagesService

func (*ProjectsMessagesService)Send¶

func (r *ProjectsMessagesService) Send(parentidstring, sendmessagerequest *SendMessageRequest) *ProjectsMessagesSendCall

Send: Send a message to specified target (a registration token, topic orcondition).

• parent: It contains the Firebase project id (i.e. the unique identifierfor your Firebase project), in the format of `projects/{project_id}`. Thenumeric project number with no padding is also supported in the format of`projects/{project_number}`.

type ProjectsService struct {Messages *ProjectsMessagesService// contains filtered or unexported fields}

funcNewProjectsService¶

func NewProjectsService(s *Service) *ProjectsService

type SendMessageRequest struct {// Message: Required. Message to send.Message *Message `json:"message,omitempty"`// ValidateOnly: Flag for testing the request without actually delivering the// message.ValidateOnlybool `json:"validateOnly,omitempty"`// ForceSendFields is a list of field names (e.g. "Message") 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. "Message") 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 (SendMessageRequest)MarshalJSON¶

func (sSendMessageRequest) MarshalJSON() ([]byte,error)

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields}

funcNewService¶

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

type WebpushConfig struct {// Data: Arbitrary key/value payload. If present, it will override// google.firebase.fcm.v1.Message.data.Data map[string]string `json:"data,omitempty"`// FcmOptions: Options for features provided by the FCM SDK for Web.FcmOptions *WebpushFcmOptions `json:"fcmOptions,omitempty"`// Headers: HTTP headers defined in webpush protocol. Refer to Webpush protocol// (https://tools.ietf.org/html/rfc8030#section-5) for supported headers, e.g.// "TTL": "15".Headers map[string]string `json:"headers,omitempty"`// Notification: Web Notification options as a JSON object. Supports// Notification instance properties as defined in Web Notification API// (https://developer.mozilla.org/en-US/docs/Web/API/Notification). If present,// "title" and "body" fields override// [google.firebase.fcm.v1.Notification.title] and// [google.firebase.fcm.v1.Notification.body].Notificationgoogleapi.RawMessage `json:"notification,omitempty"`// ForceSendFields is a list of field names (e.g. "Data") 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. "Data") 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 (WebpushConfig)MarshalJSON¶

func (sWebpushConfig) MarshalJSON() ([]byte,error)

type WebpushFcmOptions struct {// AnalyticsLabel: Label associated with the message's analytics data.AnalyticsLabelstring `json:"analyticsLabel,omitempty"`// Link: The link to open when the user clicks on the notification. For all URL// values, HTTPS is required.Linkstring `json:"link,omitempty"`// ForceSendFields is a list of field names (e.g. "AnalyticsLabel") 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. "AnalyticsLabel") 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 (WebpushFcmOptions)MarshalJSON¶

func (sWebpushFcmOptions) MarshalJSON() ([]byte,error)