mybusinessbusinesscalls

package
v0.214.0 Latest Latest
Warning

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

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

Documentation

Overview

Package mybusinessbusinesscalls provides access to the My Business Business Calls API.

For product documentation, see: https://developers.google.com/my-business/

Creating a client

Usage example: 

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

mybusinessbusinesscallsService, err := mybusinessbusinesscalls.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, ...)
mybusinessbusinesscallsService, err := mybusinessbusinesscalls.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 AggregateMetrics 

type AggregateMetrics struct {
	// AnsweredCallsCount: Total count of answered calls.
	AnsweredCallsCount int64 `json:"answeredCallsCount,omitempty"`

	// EndDate: End date for this metric.
	EndDate *Date `json:"endDate,omitempty"`

	// HourlyMetrics: A list of metrics by hour of day.
	HourlyMetrics []*HourlyMetrics `json:"hourlyMetrics,omitempty"`

	// MissedCallsCount: Total count of missed calls.
	MissedCallsCount int64 `json:"missedCallsCount,omitempty"`

	// StartDate: Date for this metric. If metric is monthly, only year and
	// month are used.
	StartDate *Date `json:"startDate,omitempty"`

	// WeekdayMetrics: A list of metrics by day of week.
	WeekdayMetrics []*WeekDayMetrics `json:"weekdayMetrics,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AnsweredCallsCount")
	// to unconditionally include in API requests. By default, fields with
	// empty or default 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. "AnsweredCallsCount") 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:"-"`
}

AggregateMetrics: Metrics aggregated over the input time range.

func (*AggregateMetrics) MarshalJSON 

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

type BusinessCallsInsights 

type BusinessCallsInsights struct {
	// AggregateMetrics: Metric for the time range based on start_date and
	// end_date.
	AggregateMetrics *AggregateMetrics `json:"aggregateMetrics,omitempty"`

	// MetricType: The metric for which the value applies.
	//
	// Possible values:
	//   "METRIC_TYPE_UNSPECIFIED" - Type of metric is unspecified.
	//   "AGGREGATE_COUNT" - The metrics provided are counts aggregated over
	// the input time_range.
	MetricType string `json:"metricType,omitempty"`

	// Name: Required. The resource name of the calls insights. Format:
	// locations/{location}/businesscallsinsights
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AggregateMetrics") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "AggregateMetrics") 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:"-"`
}

BusinessCallsInsights: Insights for calls made to a location.

func (*BusinessCallsInsights) MarshalJSON 

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

type BusinessCallsSettings 

type BusinessCallsSettings struct {
	// CallsState: Required. The state of this location's enrollment in
	// Business calls.
	//
	// Possible values:
	//   "CALLS_STATE_UNSPECIFIED" - Unspecified.
	//   "ENABLED" - Business calls is enabled for the location.
	//   "DISABLED" - Business calls is disabled for the location.
	CallsState string `json:"callsState,omitempty"`

	// ConsentTime: Input only. Time when the end user provided consent to
	// the API user to enable business calls.
	ConsentTime string `json:"consentTime,omitempty"`

	// Name: Required. The resource name of the calls settings. Format:
	// locations/{location}/businesscallssettings
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CallsState") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "CallsState") 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:"-"`
}

BusinessCallsSettings: Business calls settings for a location.

func (*BusinessCallsSettings) MarshalJSON 

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

type Date 

type Date 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. 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. "Day") 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:"-"`
}

Date: 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 (*Date) MarshalJSON 

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

type HourlyMetrics 

type HourlyMetrics struct {
	// Hour: Hour of the day. Allowed values are 0-23.
	Hour int64 `json:"hour,omitempty"`

	// MissedCallsCount: Total count of missed calls for this hour.
	MissedCallsCount int64 `json:"missedCallsCount,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Hour") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "Hour") 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:"-"`
}

HourlyMetrics: Metrics for an hour.

func (*HourlyMetrics) MarshalJSON 

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

type ListBusinessCallsInsightsResponse 

type ListBusinessCallsInsightsResponse struct {
	// BusinessCallsInsights: A collection of business calls insights for
	// the location.
	BusinessCallsInsights []*BusinessCallsInsights `json:"businessCallsInsights,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. Some of the metric_types (e.g, AGGREGATE_COUNT) returns a
	// single page. For these metrics, the next_page_token will be empty.
	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.
	// "BusinessCallsInsights") to unconditionally include in API requests.
	// By default, fields with empty or default 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. "BusinessCallsInsights") 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:"-"`
}

ListBusinessCallsInsightsResponse: Response message for ListBusinessCallsInsights.

func (*ListBusinessCallsInsightsResponse) MarshalJSON 

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

type LocationsBusinesscallsinsightsListCall 

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

func (*LocationsBusinesscallsinsightsListCall) Context 

func (c *LocationsBusinesscallsinsightsListCall) Context(ctx context.Context) *LocationsBusinesscallsinsightsListCall

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 (*LocationsBusinesscallsinsightsListCall) Do 

func (c *LocationsBusinesscallsinsightsListCall) Do(opts ...googleapi.CallOption) (*ListBusinessCallsInsightsResponse, error)

Do executes the "mybusinessbusinesscalls.locations.businesscallsinsights.list" call. Exactly one of *ListBusinessCallsInsightsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBusinessCallsInsightsResponse.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 (*LocationsBusinesscallsinsightsListCall) Fields 

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

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

func (*LocationsBusinesscallsinsightsListCall) Filter 

func (c *LocationsBusinesscallsinsightsListCall) Filter(filter string) *LocationsBusinesscallsinsightsListCall

Filter sets the optional parameter "filter": A filter constraining the calls insights to return. The response includes only entries that match the filter. If the MetricType is not provided, AGGREGATE_COUNT is returned. If no end_date is provided, the last date for which data is available is used. If no start_date is provided, we will default to the first date for which data is available, which is currently 6 months. If start_date is before the date when data is available, data is returned starting from the date when it is available. At this time we support following filters. 1. start_date="DATE" where date is in YYYY-MM-DD format. 2. end_date="DATE" where date is in YYYY-MM-DD format. 3. metric_type=XYZ where XYZ is a valid MetricType. 4. Conjunctions(AND) of all of the above. e.g., "start_date=2021-08-01 AND end_date=2021-08-10 AND metric_type=AGGREGATE_COUNT" The AGGREGATE_COUNT metric_type ignores the DD part of the date.

func (*LocationsBusinesscallsinsightsListCall) Header 

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

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

func (*LocationsBusinesscallsinsightsListCall) IfNoneMatch 

func (c *LocationsBusinesscallsinsightsListCall) IfNoneMatch(entityTag string) *LocationsBusinesscallsinsightsListCall

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.

func (*LocationsBusinesscallsinsightsListCall) PageSize 

func (c *LocationsBusinesscallsinsightsListCall) PageSize(pageSize int64) *LocationsBusinesscallsinsightsListCall

PageSize sets the optional parameter "pageSize": The maximum number of BusinessCallsInsights to return. If unspecified, at most 20 will be returned. Some of the metric_types(e.g, AGGREGATE_COUNT) returns a single page. For these metrics, the page_size is ignored.

func (*LocationsBusinesscallsinsightsListCall) PageToken 

func (c *LocationsBusinesscallsinsightsListCall) PageToken(pageToken string) *LocationsBusinesscallsinsightsListCall

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListBusinessCallsInsights` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBusinessCallsInsights` must match the call that provided the page token. Some of the metric_types (e.g, AGGREGATE_COUNT) returns a single page. For these metrics, the pake_token is ignored.

func (*LocationsBusinesscallsinsightsListCall) Pages 

func (c *LocationsBusinesscallsinsightsListCall) Pages(ctx context.Context, f func(*ListBusinessCallsInsightsResponse) error) error

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 LocationsBusinesscallsinsightsService 

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

func NewLocationsBusinesscallsinsightsService 

func NewLocationsBusinesscallsinsightsService(s *Service) *LocationsBusinesscallsinsightsService

func (*LocationsBusinesscallsinsightsService) List 

func (r *LocationsBusinesscallsinsightsService) List(parent string) *LocationsBusinesscallsinsightsListCall

List: Returns insights for Business calls for a location.

  • parent: The parent location to fetch calls insights for. Format: locations/{location_id}.

type LocationsGetBusinesscallssettingsCall 

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

func (*LocationsGetBusinesscallssettingsCall) Context 

func (c *LocationsGetBusinesscallssettingsCall) Context(ctx context.Context) *LocationsGetBusinesscallssettingsCall

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 (*LocationsGetBusinesscallssettingsCall) Do 

func (c *LocationsGetBusinesscallssettingsCall) Do(opts ...googleapi.CallOption) (*BusinessCallsSettings, error)

Do executes the "mybusinessbusinesscalls.locations.getBusinesscallssettings" call. Exactly one of *BusinessCallsSettings or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BusinessCallsSettings.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 (*LocationsGetBusinesscallssettingsCall) Fields 

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

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

func (*LocationsGetBusinesscallssettingsCall) Header 

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

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

func (*LocationsGetBusinesscallssettingsCall) IfNoneMatch 

func (c *LocationsGetBusinesscallssettingsCall) IfNoneMatch(entityTag string) *LocationsGetBusinesscallssettingsCall

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 LocationsService 

type LocationsService struct {
	Businesscallsinsights *LocationsBusinesscallsinsightsService
	// contains filtered or unexported fields
}

func NewLocationsService 

func NewLocationsService(s *Service) *LocationsService

func (*LocationsService) GetBusinesscallssettings 

func (r *LocationsService) GetBusinesscallssettings(name string) *LocationsGetBusinesscallssettingsCall

GetBusinesscallssettings: Returns the Business calls settings resource for the given location.

  • name: The BusinessCallsSettings to get. The `name` field is used to identify the business call settings to get. Format: locations/{location_id}/businesscallssettings.

func (*LocationsService) UpdateBusinesscallssettings 

func (r *LocationsService) UpdateBusinesscallssettings(name string, businesscallssettings *BusinessCallsSettings) *LocationsUpdateBusinesscallssettingsCall

UpdateBusinesscallssettings: Updates the Business call settings for the specified location.

  • name: The resource name of the calls settings. Format: locations/{location}/businesscallssettings.

type LocationsUpdateBusinesscallssettingsCall 

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

func (*LocationsUpdateBusinesscallssettingsCall) Context 

func (c *LocationsUpdateBusinesscallssettingsCall) Context(ctx context.Context) *LocationsUpdateBusinesscallssettingsCall

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 (*LocationsUpdateBusinesscallssettingsCall) Do 

func (c *LocationsUpdateBusinesscallssettingsCall) Do(opts ...googleapi.CallOption) (*BusinessCallsSettings, error)

Do executes the "mybusinessbusinesscalls.locations.updateBusinesscallssettings" call. Exactly one of *BusinessCallsSettings or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BusinessCallsSettings.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 (*LocationsUpdateBusinesscallssettingsCall) Fields 

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

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

func (*LocationsUpdateBusinesscallssettingsCall) Header 

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

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

func (*LocationsUpdateBusinesscallssettingsCall) UpdateMask 

func (c *LocationsUpdateBusinesscallssettingsCall) UpdateMask(updateMask string) *LocationsUpdateBusinesscallssettingsCall

UpdateMask sets the optional parameter "updateMask": Required. The list of fields to update.

type Service 

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

	Locations *LocationsService
	// 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.

type WeekDayMetrics 

type WeekDayMetrics struct {
	// Day: Day of the week. Allowed values are Sunday - Saturday.
	//
	// Possible values:
	//   "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified.
	//   "MONDAY" - Monday
	//   "TUESDAY" - Tuesday
	//   "WEDNESDAY" - Wednesday
	//   "THURSDAY" - Thursday
	//   "FRIDAY" - Friday
	//   "SATURDAY" - Saturday
	//   "SUNDAY" - Sunday
	Day string `json:"day,omitempty"`

	// MissedCallsCount: Total count of missed calls for this hour.
	MissedCallsCount int64 `json:"missedCallsCount,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. 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. "Day") 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:"-"`
}

WeekDayMetrics: Metrics for a week day.

func (*WeekDayMetrics) MarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.