fcmdata

package
v0.195.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 28, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package fcmdata provides access to the Firebase Cloud Messaging Data API.

For product documentation, see: https://firebase.google.com/docs/cloud-messaging

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/fcmdata/v1beta1"
...
ctx := context.Background()
fcmdataService, err := fcmdata.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

fcmdataService, err := fcmdata.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
fcmdataService, err := fcmdata.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type GoogleFirebaseFcmDataV1beta1AndroidDeliveryData

type GoogleFirebaseFcmDataV1beta1AndroidDeliveryData struct {
	// AnalyticsLabel: The analytics label associated with the messages sent. All
	// messages sent without an analytics label will be grouped together in a
	// single entry.
	AnalyticsLabel string `json:"analyticsLabel,omitempty"`
	// AppId: The app ID to which the messages were sent.
	AppId string `json:"appId,omitempty"`
	// Data: The data for the specified appId, date, and analyticsLabel.
	Data *GoogleFirebaseFcmDataV1beta1Data `json:"data,omitempty"`
	// Date: The date represented by this entry.
	Date *GoogleTypeDate `json:"date,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:"-"`
}

GoogleFirebaseFcmDataV1beta1AndroidDeliveryData: Message delivery data for a given date, app, and analytics label combination.

func (GoogleFirebaseFcmDataV1beta1AndroidDeliveryData) MarshalJSON

type GoogleFirebaseFcmDataV1beta1Data

type GoogleFirebaseFcmDataV1beta1Data struct {
	// CountMessagesAccepted: Count of messages accepted by FCM intended for
	// Android devices. The targeted device must have opted in to the collection of
	// usage and diagnostic information.
	CountMessagesAccepted int64 `json:"countMessagesAccepted,omitempty,string"`
	// CountNotificationsAccepted: Count of notifications accepted by FCM intended
	// for Android devices. The targeted device must have opted in to the
	// collection of usage and diagnostic information.
	CountNotificationsAccepted int64 `json:"countNotificationsAccepted,omitempty,string"`
	// DeliveryPerformancePercents: Additional information about delivery
	// performance for messages that were successfully delivered.
	DeliveryPerformancePercents *GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents `json:"deliveryPerformancePercents,omitempty"`
	// MessageInsightPercents: Additional general insights about message delivery.
	MessageInsightPercents *GoogleFirebaseFcmDataV1beta1MessageInsightPercents `json:"messageInsightPercents,omitempty"`
	// MessageOutcomePercents: Mutually exclusive breakdown of message delivery
	// outcomes.
	MessageOutcomePercents *GoogleFirebaseFcmDataV1beta1MessageOutcomePercents `json:"messageOutcomePercents,omitempty"`
	// ProxyNotificationInsightPercents: Additional insights about proxy
	// notification delivery.
	ProxyNotificationInsightPercents *GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents `json:"proxyNotificationInsightPercents,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CountMessagesAccepted") 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. "CountMessagesAccepted") 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:"-"`
}

GoogleFirebaseFcmDataV1beta1Data: Data detailing messaging delivery

func (GoogleFirebaseFcmDataV1beta1Data) MarshalJSON

func (s GoogleFirebaseFcmDataV1beta1Data) MarshalJSON() ([]byte, error)

type GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents

type GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents struct {
	// DelayedDeviceDoze: The percentage of accepted messages that were delayed
	// because the device was in doze mode. Only normal priority messages
	// (https://firebase.google.com/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message)
	// should be delayed due to doze mode.
	DelayedDeviceDoze float64 `json:"delayedDeviceDoze,omitempty"`
	// DelayedDeviceOffline: The percentage of accepted messages that were delayed
	// because the target device was not connected at the time of sending. These
	// messages were eventually delivered when the device reconnected.
	DelayedDeviceOffline float64 `json:"delayedDeviceOffline,omitempty"`
	// DelayedMessageThrottled: The percentage of accepted messages that were
	// delayed due to message throttling, such as collapsible message throttling
	// (https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_throttling)
	// or maximum message rate throttling
	// (https://firebase.google.com/docs/cloud-messaging/concept-options#device_throttling).
	DelayedMessageThrottled float64 `json:"delayedMessageThrottled,omitempty"`
	// DelayedUserStopped: The percentage of accepted messages that were delayed
	// because the intended device user-profile was stopped
	// (https://firebase.google.com/docs/cloud-messaging/android/receive#handling_messages)
	// on the target device at the time of the send. The messages were eventually
	// delivered when the user-profile was started again.
	DelayedUserStopped float64 `json:"delayedUserStopped,omitempty"`
	// DeliveredNoDelay: The percentage of accepted messages that were delivered to
	// the device without delay from the FCM system.
	DeliveredNoDelay float64 `json:"deliveredNoDelay,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DelayedDeviceDoze") 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. "DelayedDeviceDoze") 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:"-"`
}

GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents: Overview of delivery performance for messages that were successfully delivered. All percentages are calculated with countMessagesAccepted as the denominator. These categories are not mutually exclusive; a message can be delayed for multiple reasons.

func (GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents) MarshalJSON

func (*GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents) UnmarshalJSON

type GoogleFirebaseFcmDataV1beta1ListAndroidDeliveryDataResponse

type GoogleFirebaseFcmDataV1beta1ListAndroidDeliveryDataResponse struct {
	// AndroidDeliveryData: The delivery data for the provided app. There will be
	// one entry per combination of app, date, and analytics label.
	AndroidDeliveryData []*GoogleFirebaseFcmDataV1beta1AndroidDeliveryData `json:"androidDeliveryData,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AndroidDeliveryData") 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. "AndroidDeliveryData") 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:"-"`
}

GoogleFirebaseFcmDataV1beta1ListAndroidDeliveryDataResponse: Response message for ListAndroidDeliveryData.

func (GoogleFirebaseFcmDataV1beta1ListAndroidDeliveryDataResponse) MarshalJSON

type GoogleFirebaseFcmDataV1beta1MessageInsightPercents

type GoogleFirebaseFcmDataV1beta1MessageInsightPercents struct {
	// PriorityLowered: The percentage of accepted messages that had their priority
	// lowered from high to normal. See documentation for setting message priority
	// (https://firebase.google.com/docs/cloud-messaging/android/message-priority).
	PriorityLowered float64 `json:"priorityLowered,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PriorityLowered") 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. "PriorityLowered") 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:"-"`
}

GoogleFirebaseFcmDataV1beta1MessageInsightPercents: Additional information about message delivery. All percentages are calculated with countMessagesAccepted as the denominator.

func (GoogleFirebaseFcmDataV1beta1MessageInsightPercents) MarshalJSON

func (*GoogleFirebaseFcmDataV1beta1MessageInsightPercents) UnmarshalJSON

type GoogleFirebaseFcmDataV1beta1MessageOutcomePercents

type GoogleFirebaseFcmDataV1beta1MessageOutcomePercents struct {
	// Collapsed: The percentage of accepted messages that were collapsed
	// (https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_and_non-collapsible_messages)
	// by another message.
	Collapsed float64 `json:"collapsed,omitempty"`
	// Delivered: The percentage of all accepted messages that were successfully
	// delivered to the device.
	Delivered float64 `json:"delivered,omitempty"`
	// DroppedAppForceStopped: The percentage of accepted messages that were
	// dropped because the application was force stopped on the device at the time
	// of delivery and retries were unsuccessful.
	DroppedAppForceStopped float64 `json:"droppedAppForceStopped,omitempty"`
	// DroppedDeviceInactive: The percentage of accepted messages that were dropped
	// because the target device is inactive. FCM will drop messages if the target
	// device is deemed inactive by our servers. If a device does reconnect, we
	// call OnDeletedMessages()
	// (https://firebase.google.com/docs/cloud-messaging/android/receive#override-ondeletedmessages)
	// in our SDK instead of delivering the messages.
	DroppedDeviceInactive float64 `json:"droppedDeviceInactive,omitempty"`
	// DroppedTooManyPendingMessages: The percentage of accepted messages that were
	// dropped due to too many undelivered non-collapsible messages
	// (https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_and_non-collapsible_messages).
	// Specifically, each app instance can only have 100 pending messages stored on
	// our servers for a device which is disconnected. When that device reconnects,
	// those messages are delivered. When there are more than the maximum pending
	// messages, we call OnDeletedMessages()
	// (https://firebase.google.com/docs/cloud-messaging/android/receive#override-ondeletedmessages)
	// in our SDK instead of delivering the messages.
	DroppedTooManyPendingMessages float64 `json:"droppedTooManyPendingMessages,omitempty"`
	// DroppedTtlExpired: The percentage of accepted messages that expired because
	// Time To Live (TTL)
	// (https://firebase.google.com/docs/cloud-messaging/concept-options#ttl)
	// elapsed before the target device reconnected.
	DroppedTtlExpired float64 `json:"droppedTtlExpired,omitempty"`
	// Pending: The percentage of messages accepted on this day that were not
	// dropped and not delivered, due to the device being disconnected (as of the
	// end of the America/Los_Angeles day when the message was sent to FCM). A
	// portion of these messages will be delivered the next day when the device
	// connects but others may be destined to devices that ultimately never
	// reconnect.
	Pending float64 `json:"pending,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Collapsed") 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. "Collapsed") 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:"-"`
}

GoogleFirebaseFcmDataV1beta1MessageOutcomePercents: Percentage breakdown of message delivery outcomes. These categories are mutually exclusive. All percentages are calculated with countMessagesAccepted as the denominator. These categories may not account for all message outcomes.

func (GoogleFirebaseFcmDataV1beta1MessageOutcomePercents) MarshalJSON

func (*GoogleFirebaseFcmDataV1beta1MessageOutcomePercents) UnmarshalJSON

type GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents added in v0.182.0

type GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents struct {
	// Failed: The percentage of accepted notifications that failed to be proxied.
	// This is usually caused by exceptions that occurred while calling
	// notifyAsPackage
	// (https://developer.android.com/reference/android/app/NotificationManager#notifyAsPackage%28java.lang.String,%20java.lang.String,%20int,%20android.app.Notification%29).
	Failed float64 `json:"failed,omitempty"`
	// Proxied: The percentage of accepted notifications that were successfully
	// proxied by Google Play services
	// (https://developers.google.com/android/guides/overview).
	Proxied float64 `json:"proxied,omitempty"`
	// SkippedNotThrottled: The percentage of accepted notifications that were
	// skipped because the messages were not throttled.
	SkippedNotThrottled float64 `json:"skippedNotThrottled,omitempty"`
	// SkippedOptedOut: The percentage of accepted notifications that were skipped
	// because the app disallowed these messages to be proxied.
	SkippedOptedOut float64 `json:"skippedOptedOut,omitempty"`
	// SkippedUnconfigured: The percentage of accepted notifications that were
	// skipped because configurations required for notifications to be proxied were
	// missing.
	SkippedUnconfigured float64 `json:"skippedUnconfigured,omitempty"`
	// SkippedUnsupported: The percentage of accepted notifications that were
	// skipped because proxy notification is unsupported for the recipient.
	SkippedUnsupported float64 `json:"skippedUnsupported,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Failed") 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. "Failed") 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:"-"`
}

GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents: Additional information about proxy notification (https://firebase.google.com/docs/cloud-messaging/android/message-priority#proxy) delivery. All percentages are calculated with countNotificationsAccepted as the denominator.

func (GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents) MarshalJSON added in v0.182.0

func (*GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents) UnmarshalJSON added in v0.182.0

type GoogleTypeDate

type GoogleTypeDate struct {
	// Day: Day of a month. Must be from 1 to 31 and valid for the year and month,
	// or 0 to specify a year by itself or a year and month where the day isn't
	// significant.
	Day int64 `json:"day,omitempty"`
	// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without
	// a month and day.
	Month int64 `json:"month,omitempty"`
	// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date
	// without a year.
	Year int64 `json:"year,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Day") 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. "Day") 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:"-"`
}

GoogleTypeDate: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

func (GoogleTypeDate) MarshalJSON

func (s GoogleTypeDate) MarshalJSON() ([]byte, error)

type ProjectsAndroidAppsDeliveryDataListCall

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

func (*ProjectsAndroidAppsDeliveryDataListCall) Context

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

func (*ProjectsAndroidAppsDeliveryDataListCall) Do

Do executes the "fcmdata.projects.androidApps.deliveryData.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseFcmDataV1beta1ListAndroidDeliveryDataResponse.ServerResponse.H eader 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 (*ProjectsAndroidAppsDeliveryDataListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAndroidAppsDeliveryDataListCall) Header

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

func (*ProjectsAndroidAppsDeliveryDataListCall) IfNoneMatch

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.

func (*ProjectsAndroidAppsDeliveryDataListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries to return. The service may return fewer than this value. If unspecified, at most 1,000 entries will be returned. The maximum value is 10,000; values above 10,000 will be capped to 10,000. This default may change over time.

func (*ProjectsAndroidAppsDeliveryDataListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListAndroidDeliveryDataRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAndroidDeliveryDataRequest` must match the call that provided the page token.

func (*ProjectsAndroidAppsDeliveryDataListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsAndroidAppsDeliveryDataService

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

func NewProjectsAndroidAppsDeliveryDataService

func NewProjectsAndroidAppsDeliveryDataService(s *Service) *ProjectsAndroidAppsDeliveryDataService

func (*ProjectsAndroidAppsDeliveryDataService) List

List: List aggregate delivery data for the given Android application.

  • parent: The application for which to list delivery data. Format: `projects/{project_id}/androidApps/{app_id}`.

type ProjectsAndroidAppsService

type ProjectsAndroidAppsService struct {
	DeliveryData *ProjectsAndroidAppsDeliveryDataService
	// contains filtered or unexported fields
}

func NewProjectsAndroidAppsService

func NewProjectsAndroidAppsService(s *Service) *ProjectsAndroidAppsService

type ProjectsService

type ProjectsService struct {
	AndroidApps *ProjectsAndroidAppsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

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

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

NewService creates a new Service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL