mobileanalytics

Documentation

Overview

Package mobileanalytics provides a client for Amazon Mobile Analytics.

Index

• type Event
  • func (s Event) GoString() string
  • func (s Event) String() string
• type MobileAnalytics
  • func New(config *aws.Config) *MobileAnalytics
  • func (c *MobileAnalytics) PutEvents(input *PutEventsInput) (*PutEventsOutput, error)
  • func (c *MobileAnalytics) PutEventsRequest(input *PutEventsInput) (req *service.Request, output *PutEventsOutput)
• type PutEventsInput
  • func (s PutEventsInput) GoString() string
  • func (s PutEventsInput) String() string
• type PutEventsOutput
  • func (s PutEventsOutput) GoString() string
  • func (s PutEventsOutput) String() string
• type Session
  • func (s Session) GoString() string
  • func (s Session) String() string

Examples

• MobileAnalytics.PutEvents

Types

type Event

type Event struct {
	// A collection of key-value pairs that give additional context to the event.
	// The key-value pairs are specified by the developer.
	//
	// This collection can be empty or the attribute object can be omitted.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// A name signifying an event that occurred in your app. This is used for grouping
	// and aggregating like events together for reporting purposes.
	EventType *string `locationName:"eventType" type:"string" required:"true"`

	// A collection of key-value pairs that gives additional, measurable context
	// to the event. The key-value pairs are specified by the developer.
	//
	// This collection can be empty or the attribute object can be omitted.
	Metrics map[string]*float64 `locationName:"metrics" type:"map"`

	// The session the event occured within.
	Session *Session `locationName:"session" type:"structure"`

	// The time the event occurred in ISO 8601 standard date time format. For example,
	// 2014-06-30T19:07:47.885Z
	Timestamp *string `locationName:"timestamp" type:"string" required:"true"`

	// The version of the event.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

A JSON object representing a batch of unique event occurrences in your app.

func (Event) GoString

func (s Event) GoString() string

GoString returns the string representation

func (Event) String

func (s Event) String() string

String returns the string representation

type MobileAnalytics

type MobileAnalytics struct {
	*service.Service
}

Amazon Mobile Analytics is a service for collecting, visualizing, and understanding app usage data at scale.

func New

func New(config *aws.Config) *MobileAnalytics

New returns a new MobileAnalytics client.

func (*MobileAnalytics) PutEvents

func (c *MobileAnalytics) PutEvents(input *PutEventsInput) (*PutEventsOutput, error)

The PutEvents operation records one or more events. You can have up to 1,500 unique custom events per app, any combination of up to 40 attributes and metrics per custom event, and any number of attribute or metric values.

Example

// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.

package main

import (
	"bytes"
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/mobileanalytics"
)

var _ time.Duration
var _ bytes.Buffer

func main() {
	svc := mobileanalytics.New(nil)

	params := &mobileanalytics.PutEventsInput{
		ClientContext: aws.String("String"), // Required
		Events: []*mobileanalytics.Event{ // Required
			{ // Required
				EventType: aws.String("String50Chars"),    // Required
				Timestamp: aws.String("ISO8601Timestamp"), // Required
				Attributes: map[string]*string{
					"Key": aws.String("String0to1000Chars"), // Required
					// More values...
				},
				Metrics: map[string]*float64{
					"Key": aws.Float64(1.0), // Required
					// More values...
				},
				Session: &mobileanalytics.Session{
					Duration:       aws.Int64(1),
					ID:             aws.String("String50Chars"),
					StartTimestamp: aws.String("ISO8601Timestamp"),
					StopTimestamp:  aws.String("ISO8601Timestamp"),
				},
				Version: aws.String("String10Chars"),
			},
			// More values...
		},
		ClientContextEncoding: aws.String("String"),
	}
	resp, err := svc.PutEvents(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}

func (*MobileAnalytics) PutEventsRequest

func (c *MobileAnalytics) PutEventsRequest(input *PutEventsInput) (req *service.Request, output *PutEventsOutput)

PutEventsRequest generates a request for the PutEvents operation.

type PutEventsInput

type PutEventsInput struct {
	// The client context including the client ID, app title, app version and package
	// name.
	ClientContext *string `location:"header" locationName:"x-amz-Client-Context" type:"string" required:"true"`

	// The encoding used for the client context.
	ClientContextEncoding *string `location:"header" locationName:"x-amz-Client-Context-Encoding" type:"string"`

	// An array of Event JSON objects
	Events []*Event `locationName:"events" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A container for the data needed for a PutEvent operation

func (PutEventsInput) GoString

func (s PutEventsInput) GoString() string

GoString returns the string representation

func (PutEventsInput) String

func (s PutEventsInput) String() string

String returns the string representation

type PutEventsOutput

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

func (PutEventsOutput) GoString

func (s PutEventsOutput) GoString() string

GoString returns the string representation

func (PutEventsOutput) String

func (s PutEventsOutput) String() string

String returns the string representation

type Session

type Session struct {
	// The duration of the session.
	Duration *int64 `locationName:"duration" type:"long"`

	// A unique identifier for the session
	ID *string `locationName:"id" type:"string"`

	// The time the event started in ISO 8601 standard date time format. For example,
	// 2014-06-30T19:07:47.885Z
	StartTimestamp *string `locationName:"startTimestamp" type:"string"`

	// The time the event terminated in ISO 8601 standard date time format. For
	// example, 2014-06-30T19:07:47.885Z
	StopTimestamp *string `locationName:"stopTimestamp" type:"string"`
	// contains filtered or unexported fields
}

Describes the session. Session information is required on ALL events.

func (Session) GoString

func (s Session) GoString() string

GoString returns the string representation

func (Session) String

func (s Session) String() string

String returns the string representation