Documentation

Overview

Package firebaseremoteconfig provides access to the Firebase Remote Config API.

For product documentation, see: https://firebase.google.com/docs/remote-config/

Creating a client

Usage example:

import "google.golang.org/api/firebaseremoteconfig/v1"
...
ctx := context.Background()
firebaseremoteconfigService, err := firebaseremoteconfig.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 option.WithAPIKey:

firebaseremoteconfigService, err := firebaseremoteconfig.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ProjectsGetRemoteConfigCall

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

func (*ProjectsGetRemoteConfigCall) Context

    Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

    func (*ProjectsGetRemoteConfigCall) Do

      Do executes the "firebaseremoteconfig.projects.getRemoteConfig" call. Exactly one of *RemoteConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RemoteConfig.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 (*ProjectsGetRemoteConfigCall) Fields

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

        func (*ProjectsGetRemoteConfigCall) Header

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

          func (*ProjectsGetRemoteConfigCall) IfNoneMatch

            IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

            type ProjectsService

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

            func NewProjectsService

            func NewProjectsService(s *Service) *ProjectsService

            func (*ProjectsService) GetRemoteConfig

            func (r *ProjectsService) GetRemoteConfig(projectid string) *ProjectsGetRemoteConfigCall

              GetRemoteConfig: Get the latest version Remote Configuration for a project. Returns the RemoteConfig as the payload, and also the eTag as a response header.

              func (*ProjectsService) UpdateRemoteConfig

              func (r *ProjectsService) UpdateRemoteConfig(projectid string, remoteconfig *RemoteConfig) *ProjectsUpdateRemoteConfigCall

                UpdateRemoteConfig: Update a RemoteConfig. We treat this as an always-existing resource (when it is not found in our data store, we treat it as version 0, a template with zero conditions and zero parameters). Hence there are no Create or Delete operations. Returns the updated template when successful (and the updated eTag as a response header), or an error if things go wrong. Possible error messages: * VALIDATION_ERROR (HTTP status 400) with additional details if the template being passed in can not be validated. * AUTHENTICATION_ERROR (HTTP status 401) if the request can not be authenticate (e.g. no access token, or invalid access token). * AUTHORIZATION_ERROR (HTTP status 403) if the request can not be authorized (e.g. the user has no access to the specified project id). * VERSION_MISMATCH (HTTP status 412) when trying to update when the expected eTag (passed in via the "If-match" header) is not specified, or is specified but does does not match the current eTag. * Internal error (HTTP status 500) for Database problems or other internal errors.

                type ProjectsUpdateRemoteConfigCall

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

                func (*ProjectsUpdateRemoteConfigCall) Context

                  Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

                  func (*ProjectsUpdateRemoteConfigCall) Do

                    Do executes the "firebaseremoteconfig.projects.updateRemoteConfig" call. Exactly one of *RemoteConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RemoteConfig.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 (*ProjectsUpdateRemoteConfigCall) Fields

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

                      func (*ProjectsUpdateRemoteConfigCall) Header

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

                        func (*ProjectsUpdateRemoteConfigCall) ValidateOnly

                          ValidateOnly sets the optional parameter "validateOnly": Defaults to <code>false</code> (UpdateRemoteConfig call should update the backend if there are no validation/interal errors). May be set to <code>true</code> to indicate that, should no validation errors occur, the call should return a "200 OK" instead of performing the update. Note that other error messages (500 Internal Error, 412 Version Mismatch, etc) may still result after flipping to <code>false</code>, even if getting a "200 OK" when calling with <code>true</code>.

                          type RemoteConfig

                          type RemoteConfig struct {
                          	// Conditions: The list of named conditions. The order *does* affect the
                          	// semantics.
                          	// The condition_name values of these entries must be unique.
                          	//
                          	// The resolved value of a config parameter P is determined as follow:
                          	// * Let Y be the set of values from the submap of P that refer to
                          	// conditions
                          	//   that evaluate to <code>true</code>.
                          	// * If Y is non empty, the value is taken from the specific submap in Y
                          	// whose
                          	//   condition_name is the earliest in this condition list.
                          	// * Else, if P has a default value option (condition_name is empty)
                          	// then
                          	//   the value is taken from that option.
                          	// * Else, parameter P has no value and is omitted from the config
                          	// result.
                          	//
                          	// Example: parameter key "p1", default value "v1", submap specified
                          	// as
                          	// {"c1": v2, "c2": v3} where "c1" and "c2" are names of conditions in
                          	// the
                          	// condition list (where "c1" in this example appears before "c2").
                          	// The
                          	// value of p1 would be v2 as long as c1 is true.  Otherwise, if c2 is
                          	// true,
                          	// p1 would evaluate to v3, and if c1 and c2 are both false, p1 would
                          	// evaluate
                          	// to v1.  If no default value was specified, and c1 and c2 were both
                          	// false,
                          	// no value for p1 would be generated.
                          	Conditions []*RemoteConfigCondition `json:"conditions,omitempty"`
                          
                          	// Parameters: Map of parameter keys to their optional default values
                          	// and optional submap
                          	// of (condition name : value). Order doesn't affect semantics, and so
                          	// is
                          	// sorted by the server. The 'key' values of the params must be unique.
                          	Parameters map[string]RemoteConfigParameter `json:"parameters,omitempty"`
                          
                          	// ServerResponse contains the HTTP response code and headers from the
                          	// server.
                          	googleapi.ServerResponse `json:"-"`
                          
                          	// ForceSendFields is a list of field names (e.g. "Conditions") to
                          	// unconditionally include in API requests. By default, fields with
                          	// empty values are omitted from API requests. However, any non-pointer,
                          	// non-interface field appearing in ForceSendFields will be sent to the
                          	// server regardless of whether the field is empty or not. This may be
                          	// used to include empty fields in Patch requests.
                          	ForceSendFields []string `json:"-"`
                          
                          	// NullFields is a list of field names (e.g. "Conditions") to include in
                          	// API requests with the JSON null value. By default, fields with empty
                          	// values are omitted from API requests. However, any field with an
                          	// empty value appearing in NullFields will be sent to the server as
                          	// null. It is an error if a field in this list has a non-empty value.
                          	// This may be used to include null fields in Patch requests.
                          	NullFields []string `json:"-"`
                          }

                            RemoteConfig: * The RemoteConfig consists of a list of conditions (which can be thought of as named "if" statements) and a map of parameters (parameter key to a structure containing an optional default value, as well as a optional submap of (condition name to value when that condition is true).

                            func (*RemoteConfig) MarshalJSON

                            func (s *RemoteConfig) MarshalJSON() ([]byte, error)

                            type RemoteConfigCondition

                            type RemoteConfigCondition struct {
                            	// Description: DO NOT USE. Implementation removed and will not be added
                            	// unless requested.
                            	// A description for this Condition. Length must be less than or equal
                            	// to
                            	// 100 characters (or more precisely, unicode code points, which is
                            	// defined
                            	// in
                            	// java/com/google/wireless/android/config/ConstsExporter.java).
                            	// A description may contain any Unicode characters
                            	Description string `json:"description,omitempty"`
                            
                            	// Expression: Required.
                            	Expression string `json:"expression,omitempty"`
                            
                            	// Name: Required.
                            	// A non empty and unique name of this condition.
                            	Name string `json:"name,omitempty"`
                            
                            	// TagColor: Optional.
                            	// The display (tag) color of this condition. This serves as part of a
                            	// tag
                            	// (in the future, we may add tag text as well as tag color, but that is
                            	// not
                            	// yet implemented in the UI).
                            	// This value has no affect on the semantics of the delivered config and
                            	// it
                            	// is ignored by the backend, except for passing it through
                            	// write/read
                            	// requests.
                            	// Not having this value or having the
                            	// "CONDITION_DISPLAY_COLOR_UNSPECIFIED"
                            	// value (0) have the same meaning:  Let the UI choose any valid color
                            	// when
                            	// displaying the condition.
                            	//
                            	// Possible values:
                            	//   "CONDITION_DISPLAY_COLOR_UNSPECIFIED"
                            	//   "BLUE" - Blue
                            	//   "BROWN" - Brown
                            	//   "CYAN" - Cyan
                            	//   "DEEP_ORANGE" - aka "Red Orange"
                            	//   "GREEN" - Green
                            	//   "INDIGO" - Indigo
                            	// *
                            	//   "LIME" - Lime - Approved deviation from Material color palette
                            	//   "ORANGE" - Orange
                            	//   "PINK" - Pink
                            	//   "PURPLE" - Purple
                            	//   "TEAL" - Teal
                            	TagColor string `json:"tagColor,omitempty"`
                            
                            	// ForceSendFields is a list of field names (e.g. "Description") to
                            	// unconditionally include in API requests. By default, fields with
                            	// empty values are omitted from API requests. However, any non-pointer,
                            	// non-interface field appearing in ForceSendFields will be sent to the
                            	// server regardless of whether the field is empty or not. This may be
                            	// used to include empty fields in Patch requests.
                            	ForceSendFields []string `json:"-"`
                            
                            	// NullFields is a list of field names (e.g. "Description") to include
                            	// in API requests with the JSON null value. By default, fields with
                            	// empty values are omitted from API requests. However, any field with
                            	// an empty value appearing in NullFields will be sent to the server as
                            	// null. It is an error if a field in this list has a non-empty value.
                            	// This may be used to include null fields in Patch requests.
                            	NullFields []string `json:"-"`
                            }

                              RemoteConfigCondition: A single RemoteConfig Condition. A list of these (because order matters) are part of a single RemoteConfig template.

                              func (*RemoteConfigCondition) MarshalJSON

                              func (s *RemoteConfigCondition) MarshalJSON() ([]byte, error)

                              type RemoteConfigParameter

                              type RemoteConfigParameter struct {
                              	// ConditionalValues: Optional - a map of (condition_name, value). The
                              	// condition_name of the
                              	// highest priority (the one listed first in the conditions array)
                              	// determines
                              	// the value of this parameter.
                              	ConditionalValues map[string]RemoteConfigParameterValue `json:"conditionalValues,omitempty"`
                              
                              	// DefaultValue: Optional - value to set the parameter to, when none of
                              	// the named conditions
                              	// evaluate to <code>true</code>.
                              	DefaultValue *RemoteConfigParameterValue `json:"defaultValue,omitempty"`
                              
                              	// Description: Optional.
                              	// A description for this Parameter. Length must be less than or equal
                              	// to
                              	// 100 characters (or more precisely, unicode code points, which is
                              	// defined
                              	// in
                              	// java/com/google/wireless/android/config/ConstsExporter.java).
                              	// A description may contain any Unicode characters
                              	Description string `json:"description,omitempty"`
                              
                              	// ForceSendFields is a list of field names (e.g. "ConditionalValues")
                              	// to unconditionally include in API requests. By default, fields with
                              	// empty values are omitted from API requests. However, any non-pointer,
                              	// non-interface field appearing in ForceSendFields will be sent to the
                              	// server regardless of whether the field is empty or not. This may be
                              	// used to include empty fields in Patch requests.
                              	ForceSendFields []string `json:"-"`
                              
                              	// NullFields is a list of field names (e.g. "ConditionalValues") to
                              	// include in API requests with the JSON null value. By default, fields
                              	// with empty values are omitted from API requests. However, any field
                              	// with an empty value appearing in NullFields will be sent to the
                              	// server as null. It is an error if a field in this list has a
                              	// non-empty value. This may be used to include null fields in Patch
                              	// requests.
                              	NullFields []string `json:"-"`
                              }

                                RemoteConfigParameter: While default_value and conditional_values are each optional, at least one of the two is required - otherwise, the parameter is meaningless (and an exception will be thrown by the validation logic).

                                func (*RemoteConfigParameter) MarshalJSON

                                func (s *RemoteConfigParameter) MarshalJSON() ([]byte, error)

                                type RemoteConfigParameterValue

                                type RemoteConfigParameterValue struct {
                                	// UseInAppDefault: if true, omit the parameter from the map of fetched
                                	// parameter values
                                	UseInAppDefault bool `json:"useInAppDefault,omitempty"`
                                
                                	// Value: the string to set the parameter to
                                	Value string `json:"value,omitempty"`
                                
                                	// ForceSendFields is a list of field names (e.g. "UseInAppDefault") to
                                	// unconditionally include in API requests. By default, fields with
                                	// empty values are omitted from API requests. However, any non-pointer,
                                	// non-interface field appearing in ForceSendFields will be sent to the
                                	// server regardless of whether the field is empty or not. This may be
                                	// used to include empty fields in Patch requests.
                                	ForceSendFields []string `json:"-"`
                                
                                	// NullFields is a list of field names (e.g. "UseInAppDefault") to
                                	// include in API requests with the JSON null value. By default, fields
                                	// with empty values are omitted from API requests. However, any field
                                	// with an empty value appearing in NullFields will be sent to the
                                	// server as null. It is an error if a field in this list has a
                                	// non-empty value. This may be used to include null fields in Patch
                                	// requests.
                                	NullFields []string `json:"-"`
                                }

                                  RemoteConfigParameterValue: A RemoteConfigParameter's "value" (either the default value, or the value associated with a condition name) is either a string, or the "use_in_app_default" indicator (which means to leave out the parameter from the returned <key, value> map that is the output of the parameter fetch). We represent the "use_in_app_default" as a bool, but (when using the boolean instead of the string) it should always be <code>true</code>.

                                  func (*RemoteConfigParameterValue) MarshalJSON

                                  func (s *RemoteConfigParameterValue) MarshalJSON() ([]byte, error)

                                  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

                                  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.