blob: 73c45cf7d8ad8e52fe1ab517253dd023603799ad [file]
// Copyright 2026 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package businessprofileperformance provides access to the Business Profile Performance API.
//
// For product documentation, see: https://developers.google.com/my-business/
//
// # 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/businessprofileperformance/v1"
// ...
// ctx := context.Background()
// businessprofileperformanceService, err := businessprofileperformance.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]:
//
// businessprofileperformanceService, err := businessprofileperformance.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, ...)
// businessprofileperformanceService, err := businessprofileperformance.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package businessprofileperformance // import "google.golang.org/api/businessprofileperformance/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"log/slog"
"net/http"
"net/url"
"strconv"
"strings"
"github.com/googleapis/gax-go/v2/internallog"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
var _ = internallog.New
const apiId = "businessprofileperformance:v1"
const apiName = "businessprofileperformance"
const apiVersion = "v1"
const basePath = "https://businessprofileperformance.googleapis.com/"
const basePathTemplate = "https://businessprofileperformance.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://businessprofileperformance.mtls.googleapis.com/"
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
opts = append(opts, internaloption.EnableNewAuthLibrary())
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s := &Service{client: client, BasePath: basePath, logger: internaloption.GetLogger(opts)}
s.Locations = NewLocationsService(s)
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// 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 New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
return NewService(context.TODO(), option.WithHTTPClient(client))
}
type Service struct {
client *http.Client
logger *slog.Logger
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Locations *LocationsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewLocationsService(s *Service) *LocationsService {
rs := &LocationsService{s: s}
rs.Searchkeywords = NewLocationsSearchkeywordsService(s)
return rs
}
type LocationsService struct {
s *Service
Searchkeywords *LocationsSearchkeywordsService
}
func NewLocationsSearchkeywordsService(s *Service) *LocationsSearchkeywordsService {
rs := &LocationsSearchkeywordsService{s: s}
rs.Impressions = NewLocationsSearchkeywordsImpressionsService(s)
return rs
}
type LocationsSearchkeywordsService struct {
s *Service
Impressions *LocationsSearchkeywordsImpressionsService
}
func NewLocationsSearchkeywordsImpressionsService(s *Service) *LocationsSearchkeywordsImpressionsService {
rs := &LocationsSearchkeywordsImpressionsService{s: s}
rs.Monthly = NewLocationsSearchkeywordsImpressionsMonthlyService(s)
return rs
}
type LocationsSearchkeywordsImpressionsService struct {
s *Service
Monthly *LocationsSearchkeywordsImpressionsMonthlyService
}
func NewLocationsSearchkeywordsImpressionsMonthlyService(s *Service) *LocationsSearchkeywordsImpressionsMonthlyService {
rs := &LocationsSearchkeywordsImpressionsMonthlyService{s: s}
return rs
}
type LocationsSearchkeywordsImpressionsMonthlyService struct {
s *Service
}
// DailyMetricTimeSeries: Represents a single datapoint, where each datapoint
// is a DailyMetric-DailySubEntityType-TimeSeries tuple.
type DailyMetricTimeSeries struct {
// DailyMetric: The DailyMetric that the TimeSeries represents.
//
// Possible values:
// "DAILY_METRIC_UNKNOWN" - Represents the default unknown value.
// "BUSINESS_IMPRESSIONS_DESKTOP_MAPS" - Business impressions on Google Maps
// on Desktop devices. Multiple impressions by a unique user within a single
// day are counted as a single impression.
// "BUSINESS_IMPRESSIONS_DESKTOP_SEARCH" - Business impressions on Google
// Search on Desktop devices. Multiple impressions by a unique user within a
// single day are counted as a single impression.
// "BUSINESS_IMPRESSIONS_MOBILE_MAPS" - Business impressions on Google Maps
// on Mobile devices. Multiple impressions by a unique user within a single day
// are counted as a single impression.
// "BUSINESS_IMPRESSIONS_MOBILE_SEARCH" - Business impressions on Google
// Search on Mobile devices. Multiple impressions by a unique user within a
// single day are counted as a single impression.
// "BUSINESS_CONVERSATIONS" - The number of message conversations received on
// the business profile.
// "BUSINESS_DIRECTION_REQUESTS" - The number of times a direction request
// was requested to the business location.
// "CALL_CLICKS" - The number of times the business profile call button was
// clicked.
// "WEBSITE_CLICKS" - The number of times the business profile website was
// clicked.
// "BUSINESS_BOOKINGS" - The number of bookings made from the business
// profile via Reserve with Google.
// "BUSINESS_FOOD_ORDERS" - The number of food orders received from the
// business profile.
// "BUSINESS_FOOD_MENU_CLICKS" - The number of clicks to view or interact
// with the menu content on the business profile. Multiple clicks by a unique
// user within a single day are counted as 1.
DailyMetric string `json:"dailyMetric,omitempty"`
// DailySubEntityType: The DailySubEntityType that the TimeSeries represents.
// Will not be present when breakdown does not exist.
DailySubEntityType *DailySubEntityType `json:"dailySubEntityType,omitempty"`
// TimeSeries: List of datapoints where each datapoint is a date-value pair.
TimeSeries *TimeSeries `json:"timeSeries,omitempty"`
// ForceSendFields is a list of field names (e.g. "DailyMetric") 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. "DailyMetric") 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 (s DailyMetricTimeSeries) MarshalJSON() ([]byte, error) {
type NoMethod DailyMetricTimeSeries
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// DailySubEntityType: Represents all possible subentity types that are
// associated with DailyMetrics. Note: Currently, all metrics are returned as
// daily aggregates and sub-entity breakdowns are not supported.
type DailySubEntityType struct {
// DayOfWeek: Represents the day of the week. Eg: MONDAY. Currently supported
// DailyMetrics = NONE.
//
// 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
DayOfWeek string `json:"dayOfWeek,omitempty"`
// TimeOfDay: Represents the time of the day in 24 hour format. Eg: 13:34:20
// Currently supported DailyMetrics = NONE.
TimeOfDay *TimeOfDay `json:"timeOfDay,omitempty"`
// ForceSendFields is a list of field names (e.g. "DayOfWeek") 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. "DayOfWeek") 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 (s DailySubEntityType) MarshalJSON() ([]byte, error) {
type NoMethod DailySubEntityType
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// 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
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. 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:"-"`
}
func (s Date) MarshalJSON() ([]byte, error) {
type NoMethod Date
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// DatedValue: Represents a single datapoint in the timeseries, where each
// datapoint is a date-value pair.
type DatedValue struct {
// Date: The date that the datapoint corresponds to. This represents a month
// value if the day field is not set.
Date *Date `json:"date,omitempty"`
// Value: The value of the datapoint. This will not be present when the value
// is zero.
Value int64 `json:"value,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "Date") 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. "Date") 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 (s DatedValue) MarshalJSON() ([]byte, error) {
type NoMethod DatedValue
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// FetchMultiDailyMetricsTimeSeriesResponse: Represents the response for
// FetchMultiDailyMetricsTimeSeries.
type FetchMultiDailyMetricsTimeSeriesResponse struct {
// MultiDailyMetricTimeSeries: DailyMetrics and their corresponding time
// series.
MultiDailyMetricTimeSeries []*MultiDailyMetricTimeSeries `json:"multiDailyMetricTimeSeries,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "MultiDailyMetricTimeSeries")
// 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. "MultiDailyMetricTimeSeries") 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 (s FetchMultiDailyMetricsTimeSeriesResponse) MarshalJSON() ([]byte, error) {
type NoMethod FetchMultiDailyMetricsTimeSeriesResponse
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// GetDailyMetricsTimeSeriesResponse: Represents the response for
// GetDailyMetricsTimeSeries.
type GetDailyMetricsTimeSeriesResponse struct {
// TimeSeries: The daily time series.
TimeSeries *TimeSeries `json:"timeSeries,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "TimeSeries") 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. "TimeSeries") 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 (s GetDailyMetricsTimeSeriesResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetDailyMetricsTimeSeriesResponse
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// InsightsValue: Represents an insights value.
type InsightsValue struct {
// Threshold: Represents the threshold below which the actual value falls.
Threshold int64 `json:"threshold,omitempty,string"`
// Value: Represents the actual value.
Value int64 `json:"value,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "Threshold") 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. "Threshold") 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 (s InsightsValue) MarshalJSON() ([]byte, error) {
type NoMethod InsightsValue
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// ListSearchKeywordImpressionsMonthlyResponse: Represents the response for
// ListSearchKeywordImpressionsMonthly.
type ListSearchKeywordImpressionsMonthlyResponse struct {
// NextPageToken: A token indicating the last paginated result returned. This
// can be used by succeeding requests to get the next "page" of keywords. It
// will only be present when there are more results to be returned.
NextPageToken string `json:"nextPageToken,omitempty"`
// SearchKeywordsCounts: Search terms which have been used to find a business.
SearchKeywordsCounts []*SearchKeywordCount `json:"searchKeywordsCounts,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") 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. "NextPageToken") 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 (s ListSearchKeywordImpressionsMonthlyResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListSearchKeywordImpressionsMonthlyResponse
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// MultiDailyMetricTimeSeries: Represents a list of tuples of
// DailyMetric-DailySubEntityType-TimeSeries.
type MultiDailyMetricTimeSeries struct {
// DailyMetricTimeSeries: List of DailyMetric-TimeSeries pairs.
DailyMetricTimeSeries []*DailyMetricTimeSeries `json:"dailyMetricTimeSeries,omitempty"`
// ForceSendFields is a list of field names (e.g. "DailyMetricTimeSeries") 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. "DailyMetricTimeSeries") 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 (s MultiDailyMetricTimeSeries) MarshalJSON() ([]byte, error) {
type NoMethod MultiDailyMetricTimeSeries
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// SearchKeywordCount: Represents a single search keyword and its value.
type SearchKeywordCount struct {
// InsightsValue: One of either: 1) The sum of the number of unique users that
// used the keyword in a month, aggregated for each month requested. 2) A
// threshold that indicates that the actual value is below this threshold.
InsightsValue *InsightsValue `json:"insightsValue,omitempty"`
// SearchKeyword: The lower-cased string that the user entered.
SearchKeyword string `json:"searchKeyword,omitempty"`
// ForceSendFields is a list of field names (e.g. "InsightsValue") 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. "InsightsValue") 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 (s SearchKeywordCount) MarshalJSON() ([]byte, error) {
type NoMethod SearchKeywordCount
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// TimeOfDay: Represents a time of day. The date and time zone are either not
// significant or are specified elsewhere. An API may choose to allow leap
// seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
type TimeOfDay struct {
// Hours: Hours of a day in 24 hour format. Must be greater than or equal to 0
// and typically must be less than or equal to 23. An API may choose to allow
// the value "24:00:00" for scenarios like business closing time.
Hours int64 `json:"hours,omitempty"`
// Minutes: Minutes of an hour. Must be greater than or equal to 0 and less
// than or equal to 59.
Minutes int64 `json:"minutes,omitempty"`
// Nanos: Fractions of seconds, in nanoseconds. Must be greater than or equal
// to 0 and less than or equal to 999,999,999.
Nanos int64 `json:"nanos,omitempty"`
// Seconds: Seconds of a minute. Must be greater than or equal to 0 and
// typically must be less than or equal to 59. An API may allow the value 60 if
// it allows leap-seconds.
Seconds int64 `json:"seconds,omitempty"`
// ForceSendFields is a list of field names (e.g. "Hours") 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. "Hours") 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 (s TimeOfDay) MarshalJSON() ([]byte, error) {
type NoMethod TimeOfDay
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// TimeSeries: Represents a timeseries.
type TimeSeries struct {
// DatedValues: List of datapoints in the timeseries, where each datapoint is a
// date-value pair.
DatedValues []*DatedValue `json:"datedValues,omitempty"`
// ForceSendFields is a list of field names (e.g. "DatedValues") 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. "DatedValues") 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 (s TimeSeries) MarshalJSON() ([]byte, error) {
type NoMethod TimeSeries
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
type LocationsFetchMultiDailyMetricsTimeSeriesCall struct {
s *Service
location string
urlParams_ gensupport.URLParams
ifNoneMatch_ string
ctx_ context.Context
header_ http.Header
}
// FetchMultiDailyMetricsTimeSeries: Returns the values for each date from a
// given time range that are associated with the specific daily metrics. Note:
// Only daily data is available. Hourly metrics are not supported. Example
// request: `GET
// https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`
//
// - location: The location for which the time series should be fetched.
// Format: locations/{location_id} where location_id is an unobfuscated
// listing id.
func (r *LocationsService) FetchMultiDailyMetricsTimeSeries(location string) *LocationsFetchMultiDailyMetricsTimeSeriesCall {
c := &LocationsFetchMultiDailyMetricsTimeSeriesCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.location = location
return c
}
// DailyMetrics sets the optional parameter "dailyMetrics": Required. The
// metrics to retrieve time series for.
//
// Possible values:
//
// "DAILY_METRIC_UNKNOWN" - Represents the default unknown value.
// "BUSINESS_IMPRESSIONS_DESKTOP_MAPS" - Business impressions on Google Maps
//
// on Desktop devices. Multiple impressions by a unique user within a single
// day are counted as a single impression.
//
// "BUSINESS_IMPRESSIONS_DESKTOP_SEARCH" - Business impressions on Google
//
// Search on Desktop devices. Multiple impressions by a unique user within a
// single day are counted as a single impression.
//
// "BUSINESS_IMPRESSIONS_MOBILE_MAPS" - Business impressions on Google Maps
//
// on Mobile devices. Multiple impressions by a unique user within a single day
// are counted as a single impression.
//
// "BUSINESS_IMPRESSIONS_MOBILE_SEARCH" - Business impressions on Google
//
// Search on Mobile devices. Multiple impressions by a unique user within a
// single day are counted as a single impression.
//
// "BUSINESS_CONVERSATIONS" - The number of message conversations received on
//
// the business profile.
//
// "BUSINESS_DIRECTION_REQUESTS" - The number of times a direction request
//
// was requested to the business location.
//
// "CALL_CLICKS" - The number of times the business profile call button was
//
// clicked.
//
// "WEBSITE_CLICKS" - The number of times the business profile website was
//
// clicked.
//
// "BUSINESS_BOOKINGS" - The number of bookings made from the business
//
// profile via Reserve with Google.
//
// "BUSINESS_FOOD_ORDERS" - The number of food orders received from the
//
// business profile.
//
// "BUSINESS_FOOD_MENU_CLICKS" - The number of clicks to view or interact
//
// with the menu content on the business profile. Multiple clicks by a unique
// user within a single day are counted as 1.
func (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) DailyMetrics(dailyMetrics ...string) *LocationsFetchMultiDailyMetricsTimeSeriesCall {
c.urlParams_.SetMulti("dailyMetrics", append([]string{}, dailyMetrics...))
return c
}
// DailyRangeEndDateDay sets the optional parameter "dailyRange.endDate.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.
func (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) DailyRangeEndDateDay(dailyRangeEndDateDay int64) *LocationsFetchMultiDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.endDate.day", fmt.Sprint(dailyRangeEndDateDay))
return c
}
// DailyRangeEndDateMonth sets the optional parameter
// "dailyRange.endDate.month": Month of a year. Must be from 1 to 12, or 0 to
// specify a year without a month and day.
func (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) DailyRangeEndDateMonth(dailyRangeEndDateMonth int64) *LocationsFetchMultiDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.endDate.month", fmt.Sprint(dailyRangeEndDateMonth))
return c
}
// DailyRangeEndDateYear sets the optional parameter "dailyRange.endDate.year":
// Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
// year.
func (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) DailyRangeEndDateYear(dailyRangeEndDateYear int64) *LocationsFetchMultiDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.endDate.year", fmt.Sprint(dailyRangeEndDateYear))
return c
}
// DailyRangeStartDateDay sets the optional parameter
// "dailyRange.startDate.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.
func (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) DailyRangeStartDateDay(dailyRangeStartDateDay int64) *LocationsFetchMultiDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.startDate.day", fmt.Sprint(dailyRangeStartDateDay))
return c
}
// DailyRangeStartDateMonth sets the optional parameter
// "dailyRange.startDate.month": Month of a year. Must be from 1 to 12, or 0 to
// specify a year without a month and day.
func (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) DailyRangeStartDateMonth(dailyRangeStartDateMonth int64) *LocationsFetchMultiDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.startDate.month", fmt.Sprint(dailyRangeStartDateMonth))
return c
}
// DailyRangeStartDateYear sets the optional parameter
// "dailyRange.startDate.year": Year of the date. Must be from 1 to 9999, or 0
// to specify a date without a year.
func (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) DailyRangeStartDateYear(dailyRangeStartDateYear int64) *LocationsFetchMultiDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.startDate.year", fmt.Sprint(dailyRangeStartDateYear))
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
// details.
func (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) Fields(s ...googleapi.Field) *LocationsFetchMultiDailyMetricsTimeSeriesCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// 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 (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) IfNoneMatch(entityTag string) *LocationsFetchMultiDailyMetricsTimeSeriesCall {
c.ifNoneMatch_ = entityTag
return c
}
// Context sets the context to be used in this call's Do method.
func (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) Context(ctx context.Context) *LocationsFetchMultiDailyMetricsTimeSeriesCall {
c.ctx_ = ctx
return c
}
// Header returns a http.Header that can be modified by the caller to add
// headers to the request.
func (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_)
if c.ifNoneMatch_ != "" {
reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
}
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+location}:fetchMultiDailyMetricsTimeSeries")
urls += "?" + c.urlParams_.Encode()
req, err := http.NewRequest("GET", urls, nil)
if err != nil {
return nil, err
}
req.Header = reqHeaders
googleapi.Expand(req.URL, map[string]string{
"location": c.location,
})
c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "businessprofileperformance.locations.fetchMultiDailyMetricsTimeSeries", "request", internallog.HTTPRequest(req, nil))
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "businessprofileperformance.locations.fetchMultiDailyMetricsTimeSeries" call.
// Any non-2xx status code is an error. Response headers are in either
// *FetchMultiDailyMetricsTimeSeriesResponse.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 (c *LocationsFetchMultiDailyMetricsTimeSeriesCall) Do(opts ...googleapi.CallOption) (*FetchMultiDailyMetricsTimeSeriesResponse, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, gensupport.WrapError(&googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
})
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, gensupport.WrapError(err)
}
ret := &FetchMultiDailyMetricsTimeSeriesResponse{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
b, err := gensupport.DecodeResponseBytes(target, res)
if err != nil {
return nil, err
}
c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "businessprofileperformance.locations.fetchMultiDailyMetricsTimeSeries", "response", internallog.HTTPResponse(res, b))
return ret, nil
}
type LocationsGetDailyMetricsTimeSeriesCall struct {
s *Service
name string
urlParams_ gensupport.URLParams
ifNoneMatch_ string
ctx_ context.Context
header_ http.Header
}
// GetDailyMetricsTimeSeries: Returns the values for each date from a given
// time range that are associated with the specific daily metric. Note: Only
// daily data is available. Hourly metrics are not supported. Example request:
// `GET
// https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`
//
// - name: The location for which the time series should be fetched. Format:
// locations/{location_id} where location_id is an unobfuscated listing id.
func (r *LocationsService) GetDailyMetricsTimeSeries(name string) *LocationsGetDailyMetricsTimeSeriesCall {
c := &LocationsGetDailyMetricsTimeSeriesCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
return c
}
// DailyMetric sets the optional parameter "dailyMetric": Required. The metric
// to retrieve time series.
//
// Possible values:
//
// "DAILY_METRIC_UNKNOWN" - Represents the default unknown value.
// "BUSINESS_IMPRESSIONS_DESKTOP_MAPS" - Business impressions on Google Maps
//
// on Desktop devices. Multiple impressions by a unique user within a single
// day are counted as a single impression.
//
// "BUSINESS_IMPRESSIONS_DESKTOP_SEARCH" - Business impressions on Google
//
// Search on Desktop devices. Multiple impressions by a unique user within a
// single day are counted as a single impression.
//
// "BUSINESS_IMPRESSIONS_MOBILE_MAPS" - Business impressions on Google Maps
//
// on Mobile devices. Multiple impressions by a unique user within a single day
// are counted as a single impression.
//
// "BUSINESS_IMPRESSIONS_MOBILE_SEARCH" - Business impressions on Google
//
// Search on Mobile devices. Multiple impressions by a unique user within a
// single day are counted as a single impression.
//
// "BUSINESS_CONVERSATIONS" - The number of message conversations received on
//
// the business profile.
//
// "BUSINESS_DIRECTION_REQUESTS" - The number of times a direction request
//
// was requested to the business location.
//
// "CALL_CLICKS" - The number of times the business profile call button was
//
// clicked.
//
// "WEBSITE_CLICKS" - The number of times the business profile website was
//
// clicked.
//
// "BUSINESS_BOOKINGS" - The number of bookings made from the business
//
// profile via Reserve with Google.
//
// "BUSINESS_FOOD_ORDERS" - The number of food orders received from the
//
// business profile.
//
// "BUSINESS_FOOD_MENU_CLICKS" - The number of clicks to view or interact
//
// with the menu content on the business profile. Multiple clicks by a unique
// user within a single day are counted as 1.
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyMetric(dailyMetric string) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyMetric", dailyMetric)
return c
}
// DailyRangeEndDateDay sets the optional parameter "dailyRange.endDate.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.
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateDay(dailyRangeEndDateDay int64) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.endDate.day", fmt.Sprint(dailyRangeEndDateDay))
return c
}
// DailyRangeEndDateMonth sets the optional parameter
// "dailyRange.endDate.month": Month of a year. Must be from 1 to 12, or 0 to
// specify a year without a month and day.
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateMonth(dailyRangeEndDateMonth int64) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.endDate.month", fmt.Sprint(dailyRangeEndDateMonth))
return c
}
// DailyRangeEndDateYear sets the optional parameter "dailyRange.endDate.year":
// Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
// year.
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateYear(dailyRangeEndDateYear int64) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.endDate.year", fmt.Sprint(dailyRangeEndDateYear))
return c
}
// DailyRangeStartDateDay sets the optional parameter
// "dailyRange.startDate.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.
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateDay(dailyRangeStartDateDay int64) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.startDate.day", fmt.Sprint(dailyRangeStartDateDay))
return c
}
// DailyRangeStartDateMonth sets the optional parameter
// "dailyRange.startDate.month": Month of a year. Must be from 1 to 12, or 0 to
// specify a year without a month and day.
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateMonth(dailyRangeStartDateMonth int64) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.startDate.month", fmt.Sprint(dailyRangeStartDateMonth))
return c
}
// DailyRangeStartDateYear sets the optional parameter
// "dailyRange.startDate.year": Year of the date. Must be from 1 to 9999, or 0
// to specify a date without a year.
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateYear(dailyRangeStartDateYear int64) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailyRange.startDate.year", fmt.Sprint(dailyRangeStartDateYear))
return c
}
// DailySubEntityTypeDayOfWeek sets the optional parameter
// "dailySubEntityType.dayOfWeek": Represents the day of the week. Eg: MONDAY.
// Currently supported DailyMetrics = NONE.
//
// 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
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeDayOfWeek(dailySubEntityTypeDayOfWeek string) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailySubEntityType.dayOfWeek", dailySubEntityTypeDayOfWeek)
return c
}
// DailySubEntityTypeTimeOfDayHours sets the optional parameter
// "dailySubEntityType.timeOfDay.hours": Hours of a day in 24 hour format. Must
// be greater than or equal to 0 and typically must be less than or equal to
// 23. An API may choose to allow the value "24:00:00" for scenarios like
// business closing time.
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayHours(dailySubEntityTypeTimeOfDayHours int64) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailySubEntityType.timeOfDay.hours", fmt.Sprint(dailySubEntityTypeTimeOfDayHours))
return c
}
// DailySubEntityTypeTimeOfDayMinutes sets the optional parameter
// "dailySubEntityType.timeOfDay.minutes": Minutes of an hour. Must be greater
// than or equal to 0 and less than or equal to 59.
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayMinutes(dailySubEntityTypeTimeOfDayMinutes int64) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailySubEntityType.timeOfDay.minutes", fmt.Sprint(dailySubEntityTypeTimeOfDayMinutes))
return c
}
// DailySubEntityTypeTimeOfDayNanos sets the optional parameter
// "dailySubEntityType.timeOfDay.nanos": Fractions of seconds, in nanoseconds.
// Must be greater than or equal to 0 and less than or equal to 999,999,999.
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayNanos(dailySubEntityTypeTimeOfDayNanos int64) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailySubEntityType.timeOfDay.nanos", fmt.Sprint(dailySubEntityTypeTimeOfDayNanos))
return c
}
// DailySubEntityTypeTimeOfDaySeconds sets the optional parameter
// "dailySubEntityType.timeOfDay.seconds": Seconds of a minute. Must be greater
// than or equal to 0 and typically must be less than or equal to 59. An API
// may allow the value 60 if it allows leap-seconds.
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDaySeconds(dailySubEntityTypeTimeOfDaySeconds int64) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("dailySubEntityType.timeOfDay.seconds", fmt.Sprint(dailySubEntityTypeTimeOfDaySeconds))
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
// details.
func (c *LocationsGetDailyMetricsTimeSeriesCall) Fields(s ...googleapi.Field) *LocationsGetDailyMetricsTimeSeriesCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// 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 (c *LocationsGetDailyMetricsTimeSeriesCall) IfNoneMatch(entityTag string) *LocationsGetDailyMetricsTimeSeriesCall {
c.ifNoneMatch_ = entityTag
return c
}
// Context sets the context to be used in this call's Do method.
func (c *LocationsGetDailyMetricsTimeSeriesCall) Context(ctx context.Context) *LocationsGetDailyMetricsTimeSeriesCall {
c.ctx_ = ctx
return c
}
// Header returns a http.Header that can be modified by the caller to add
// headers to the request.
func (c *LocationsGetDailyMetricsTimeSeriesCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *LocationsGetDailyMetricsTimeSeriesCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_)
if c.ifNoneMatch_ != "" {
reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
}
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:getDailyMetricsTimeSeries")
urls += "?" + c.urlParams_.Encode()
req, err := http.NewRequest("GET", urls, nil)
if err != nil {
return nil, err
}
req.Header = reqHeaders
googleapi.Expand(req.URL, map[string]string{
"name": c.name,
})
c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "businessprofileperformance.locations.getDailyMetricsTimeSeries", "request", internallog.HTTPRequest(req, nil))
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "businessprofileperformance.locations.getDailyMetricsTimeSeries" call.
// Any non-2xx status code is an error. Response headers are in either
// *GetDailyMetricsTimeSeriesResponse.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 (c *LocationsGetDailyMetricsTimeSeriesCall) Do(opts ...googleapi.CallOption) (*GetDailyMetricsTimeSeriesResponse, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, gensupport.WrapError(&googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
})
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, gensupport.WrapError(err)
}
ret := &GetDailyMetricsTimeSeriesResponse{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
b, err := gensupport.DecodeResponseBytes(target, res)
if err != nil {
return nil, err
}
c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "businessprofileperformance.locations.getDailyMetricsTimeSeries", "response", internallog.HTTPResponse(res, b))
return ret, nil
}
type LocationsSearchkeywordsImpressionsMonthlyListCall struct {
s *Service
parent string
urlParams_ gensupport.URLParams
ifNoneMatch_ string
ctx_ context.Context
header_ http.Header
}
// List: Returns the search keywords used to find a business in search or maps.
// Each search keyword is accompanied by impressions which are aggregated on a
// monthly basis. Example request: `GET
// https://businessprofileperformance.googleapis.com/v1/locations/12345/searchkeywords/impressions/monthly?monthly_range.start_month.year=2022&monthly_range.start_month.month=1&monthly_range.end_month.year=2022&monthly_range.end_month.month=3`
//
// - parent: The location for which the time series should be fetched. Format:
// locations/{location_id} where location_id is an unobfuscated listing id.
func (r *LocationsSearchkeywordsImpressionsMonthlyService) List(parent string) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c := &LocationsSearchkeywordsImpressionsMonthlyListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.parent = parent
return c
}
// MonthlyRangeEndMonthDay sets the optional parameter
// "monthlyRange.endMonth.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.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthDay(monthlyRangeEndMonthDay int64) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c.urlParams_.Set("monthlyRange.endMonth.day", fmt.Sprint(monthlyRangeEndMonthDay))
return c
}
// MonthlyRangeEndMonthMonth sets the optional parameter
// "monthlyRange.endMonth.month": Month of a year. Must be from 1 to 12, or 0
// to specify a year without a month and day.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthMonth(monthlyRangeEndMonthMonth int64) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c.urlParams_.Set("monthlyRange.endMonth.month", fmt.Sprint(monthlyRangeEndMonthMonth))
return c
}
// MonthlyRangeEndMonthYear sets the optional parameter
// "monthlyRange.endMonth.year": Year of the date. Must be from 1 to 9999, or 0
// to specify a date without a year.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthYear(monthlyRangeEndMonthYear int64) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c.urlParams_.Set("monthlyRange.endMonth.year", fmt.Sprint(monthlyRangeEndMonthYear))
return c
}
// MonthlyRangeStartMonthDay sets the optional parameter
// "monthlyRange.startMonth.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.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthDay(monthlyRangeStartMonthDay int64) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c.urlParams_.Set("monthlyRange.startMonth.day", fmt.Sprint(monthlyRangeStartMonthDay))
return c
}
// MonthlyRangeStartMonthMonth sets the optional parameter
// "monthlyRange.startMonth.month": Month of a year. Must be from 1 to 12, or 0
// to specify a year without a month and day.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthMonth(monthlyRangeStartMonthMonth int64) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c.urlParams_.Set("monthlyRange.startMonth.month", fmt.Sprint(monthlyRangeStartMonthMonth))
return c
}
// MonthlyRangeStartMonthYear sets the optional parameter
// "monthlyRange.startMonth.year": Year of the date. Must be from 1 to 9999, or
// 0 to specify a date without a year.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthYear(monthlyRangeStartMonthYear int64) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c.urlParams_.Set("monthlyRange.startMonth.year", fmt.Sprint(monthlyRangeStartMonthYear))
return c
}
// PageSize sets the optional parameter "pageSize": The number of results
// requested. The default page size is 100. Page size can be set to a maximum
// of 100.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) PageSize(pageSize int64) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
}
// PageToken sets the optional parameter "pageToken": A token indicating the
// next paginated result to be returned.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) PageToken(pageToken string) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c.urlParams_.Set("pageToken", pageToken)
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
// details.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Fields(s ...googleapi.Field) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// 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 (c *LocationsSearchkeywordsImpressionsMonthlyListCall) IfNoneMatch(entityTag string) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c.ifNoneMatch_ = entityTag
return c
}
// Context sets the context to be used in this call's Do method.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Context(ctx context.Context) *LocationsSearchkeywordsImpressionsMonthlyListCall {
c.ctx_ = ctx
return c
}
// Header returns a http.Header that can be modified by the caller to add
// headers to the request.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_)
if c.ifNoneMatch_ != "" {
reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
}
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/searchkeywords/impressions/monthly")
urls += "?" + c.urlParams_.Encode()
req, err := http.NewRequest("GET", urls, nil)
if err != nil {
return nil, err
}
req.Header = reqHeaders
googleapi.Expand(req.URL, map[string]string{
"parent": c.parent,
})
c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "businessprofileperformance.locations.searchkeywords.impressions.monthly.list", "request", internallog.HTTPRequest(req, nil))
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "businessprofileperformance.locations.searchkeywords.impressions.monthly.list" call.
// Any non-2xx status code is an error. Response headers are in either
// *ListSearchKeywordImpressionsMonthlyResponse.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 (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Do(opts ...googleapi.CallOption) (*ListSearchKeywordImpressionsMonthlyResponse, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, gensupport.WrapError(&googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
})
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, gensupport.WrapError(err)
}
ret := &ListSearchKeywordImpressionsMonthlyResponse{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
b, err := gensupport.DecodeResponseBytes(target, res)
if err != nil {
return nil, err
}
c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "businessprofileperformance.locations.searchkeywords.impressions.monthly.list", "response", internallog.HTTPResponse(res, b))
return ret, nil
}
// 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.
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Pages(ctx context.Context, f func(*ListSearchKeywordImpressionsMonthlyResponse) error) error {
c.ctx_ = ctx
defer c.PageToken(c.urlParams_.Get("pageToken"))
for {
x, err := c.Do()
if err != nil {
return err
}
if err := f(x); err != nil {
return err
}
if x.NextPageToken == "" {
return nil
}
c.PageToken(x.NextPageToken)
}
}