Movatterモバイル変換

[0]ホーム
URL:

businessprofileperformance

package
v0.257.0Latest Latest
Warning

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

Go to latest Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:0

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

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, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany 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 forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.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 OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

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

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

typeDailyMetricTimeSeriesadded inv0.112.0

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.DailyMetricstring `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:"-"`}

DailyMetricTimeSeries: Represents a single datapoint, where each datapointis a DailyMetric-DailySubEntityType-TimeSeries tuple.

func (DailyMetricTimeSeries)MarshalJSONadded inv0.112.0

func (sDailyMetricTimeSeries) MarshalJSON() ([]byte,error)

typeDailySubEntityTypeadded inv0.112.0

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" - SundayDayOfWeekstring `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:"-"`}

DailySubEntityType: Represents all possible subentity types that areassociated with DailyMetrics.

func (DailySubEntityType)MarshalJSONadded inv0.112.0

func (sDailySubEntityType) MarshalJSON() ([]byte,error)

typeDate

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.Dayint64 `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.Monthint64 `json:"month,omitempty"`// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date// without a year.Yearint64 `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:"-"`}

Date: Represents a whole or partial calendar date, such as a birthday. Thetime of day and time zone are either specified elsewhere or areinsignificant. The date is relative to the Gregorian Calendar. This canrepresent 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, ananniversary). * A year on its own, with a zero month and a zero day. * Ayear and month, with a zero day (for example, a credit card expirationdate). Related types: * google.type.TimeOfDay * google.type.DateTime *google.protobuf.Timestamp

func (Date)MarshalJSON

func (sDate) MarshalJSON() ([]byte,error)

typeDatedValue

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.Valueint64 `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:"-"`}

DatedValue: Represents a single datapoint in the timeseries, where eachdatapoint is a date-value pair.

func (DatedValue)MarshalJSON

func (sDatedValue) MarshalJSON() ([]byte,error)

typeFetchMultiDailyMetricsTimeSeriesResponseadded inv0.112.0

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:"-"`}

FetchMultiDailyMetricsTimeSeriesResponse: Represents the response forFetchMultiDailyMetricsTimeSeries.

func (FetchMultiDailyMetricsTimeSeriesResponse)MarshalJSONadded inv0.112.0

typeGetDailyMetricsTimeSeriesResponse

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:"-"`}

GetDailyMetricsTimeSeriesResponse: Represents the response forGetDailyMetricsTimeSeries.

func (GetDailyMetricsTimeSeriesResponse)MarshalJSON

func (sGetDailyMetricsTimeSeriesResponse) MarshalJSON() ([]byte,error)

typeInsightsValue

type InsightsValue struct {// Threshold: Represents the threshold below which the actual value falls.Thresholdint64 `json:"threshold,omitempty,string"`// Value: Represents the actual value.Valueint64 `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:"-"`}

InsightsValue: Represents an insights value.

func (InsightsValue)MarshalJSON

func (sInsightsValue) MarshalJSON() ([]byte,error)

typeListSearchKeywordImpressionsMonthlyResponse

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.NextPageTokenstring `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:"-"`}

ListSearchKeywordImpressionsMonthlyResponse: Represents the response forListSearchKeywordImpressionsMonthly.

func (ListSearchKeywordImpressionsMonthlyResponse)MarshalJSON

typeLocationsFetchMultiDailyMetricsTimeSeriesCalladded inv0.112.0

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

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)Contextadded inv0.112.0

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

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)DailyMetricsadded inv0.112.0

DailyMetrics sets the optional parameter "dailyMetrics": Required. Themetrics 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 singleday 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 asingle 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 dayare counted as a single impression.

"BUSINESS_IMPRESSIONS_MOBILE_SEARCH" - Business impressions on Google

Search on Mobile devices. Multiple impressions by a unique user within asingle 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 uniqueuser within a single day are counted as 1.

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)DailyRangeEndDateDayadded inv0.112.0

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 0to specify a year by itself or a year and month where the day isn'tsignificant.

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)DailyRangeEndDateMonthadded inv0.112.0

DailyRangeEndDateMonth sets the optional parameter"dailyRange.endDate.month": Month of a year. Must be from 1 to 12, or 0 tospecify a year without a month and day.

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)DailyRangeEndDateYearadded inv0.112.0

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 ayear.

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)DailyRangeStartDateDayadded inv0.112.0

DailyRangeStartDateDay sets the optional parameter"dailyRange.startDate.day": Day of a month. Must be from 1 to 31 and validfor the year and month, or 0 to specify a year by itself or a year and monthwhere the day isn't significant.

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)DailyRangeStartDateMonthadded inv0.112.0

DailyRangeStartDateMonth sets the optional parameter"dailyRange.startDate.month": Month of a year. Must be from 1 to 12, or 0 tospecify a year without a month and day.

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)DailyRangeStartDateYearadded inv0.112.0

DailyRangeStartDateYear sets the optional parameter"dailyRange.startDate.year": Year of the date. Must be from 1 to 9999, or 0to specify a date without a year.

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)Doadded inv0.112.0

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 aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)Fieldsadded inv0.112.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)Headeradded inv0.112.0

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

func (*LocationsFetchMultiDailyMetricsTimeSeriesCall)IfNoneMatchadded inv0.112.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeLocationsGetDailyMetricsTimeSeriesCall

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

func (*LocationsGetDailyMetricsTimeSeriesCall)Context

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

func (*LocationsGetDailyMetricsTimeSeriesCall)DailyMetric

DailyMetric sets the optional parameter "dailyMetric": Required. The metricto 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 singleday 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 asingle 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 dayare counted as a single impression.

"BUSINESS_IMPRESSIONS_MOBILE_SEARCH" - Business impressions on Google

Search on Mobile devices. Multiple impressions by a unique user within asingle 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 uniqueuser within a single day are counted as 1.

func (*LocationsGetDailyMetricsTimeSeriesCall)DailyRangeEndDateDay

func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateDay(dailyRangeEndDateDayint64) *LocationsGetDailyMetricsTimeSeriesCall

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 0to specify a year by itself or a year and month where the day isn'tsignificant.

func (*LocationsGetDailyMetricsTimeSeriesCall)DailyRangeEndDateMonth

func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateMonth(dailyRangeEndDateMonthint64) *LocationsGetDailyMetricsTimeSeriesCall

DailyRangeEndDateMonth sets the optional parameter"dailyRange.endDate.month": Month of a year. Must be from 1 to 12, or 0 tospecify a year without a month and day.

func (*LocationsGetDailyMetricsTimeSeriesCall)DailyRangeEndDateYear

func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateYear(dailyRangeEndDateYearint64) *LocationsGetDailyMetricsTimeSeriesCall

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 ayear.

func (*LocationsGetDailyMetricsTimeSeriesCall)DailyRangeStartDateDay

func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateDay(dailyRangeStartDateDayint64) *LocationsGetDailyMetricsTimeSeriesCall

DailyRangeStartDateDay sets the optional parameter"dailyRange.startDate.day": Day of a month. Must be from 1 to 31 and validfor the year and month, or 0 to specify a year by itself or a year and monthwhere the day isn't significant.

func (*LocationsGetDailyMetricsTimeSeriesCall)DailyRangeStartDateMonth

func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateMonth(dailyRangeStartDateMonthint64) *LocationsGetDailyMetricsTimeSeriesCall

DailyRangeStartDateMonth sets the optional parameter"dailyRange.startDate.month": Month of a year. Must be from 1 to 12, or 0 tospecify a year without a month and day.

func (*LocationsGetDailyMetricsTimeSeriesCall)DailyRangeStartDateYear

func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateYear(dailyRangeStartDateYearint64) *LocationsGetDailyMetricsTimeSeriesCall

DailyRangeStartDateYear sets the optional parameter"dailyRange.startDate.year": Year of the date. Must be from 1 to 9999, or 0to specify a date without a year.

func (*LocationsGetDailyMetricsTimeSeriesCall)DailySubEntityTypeDayOfWeek

func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeDayOfWeek(dailySubEntityTypeDayOfWeekstring) *LocationsGetDailyMetricsTimeSeriesCall

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 (*LocationsGetDailyMetricsTimeSeriesCall)DailySubEntityTypeTimeOfDayHours

func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayHours(dailySubEntityTypeTimeOfDayHoursint64) *LocationsGetDailyMetricsTimeSeriesCall

DailySubEntityTypeTimeOfDayHours sets the optional parameter"dailySubEntityType.timeOfDay.hours": Hours of a day in 24 hour format. Mustbe greater than or equal to 0 and typically must be less than or equal to23. An API may choose to allow the value "24:00:00" for scenarios likebusiness closing time.

func (*LocationsGetDailyMetricsTimeSeriesCall)DailySubEntityTypeTimeOfDayMinutes

func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayMinutes(dailySubEntityTypeTimeOfDayMinutesint64) *LocationsGetDailyMetricsTimeSeriesCall

DailySubEntityTypeTimeOfDayMinutes sets the optional parameter"dailySubEntityType.timeOfDay.minutes": Minutes of an hour. Must be greaterthan or equal to 0 and less than or equal to 59.

func (*LocationsGetDailyMetricsTimeSeriesCall)DailySubEntityTypeTimeOfDayNanos

func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayNanos(dailySubEntityTypeTimeOfDayNanosint64) *LocationsGetDailyMetricsTimeSeriesCall

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 (*LocationsGetDailyMetricsTimeSeriesCall)DailySubEntityTypeTimeOfDaySeconds

func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDaySeconds(dailySubEntityTypeTimeOfDaySecondsint64) *LocationsGetDailyMetricsTimeSeriesCall

DailySubEntityTypeTimeOfDaySeconds sets the optional parameter"dailySubEntityType.timeOfDay.seconds": Seconds of a minute. Must be greaterthan or equal to 0 and typically must be less than or equal to 59. An APImay allow the value 60 if it allows leap-seconds.

func (*LocationsGetDailyMetricsTimeSeriesCall)Do

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 responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*LocationsGetDailyMetricsTimeSeriesCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*LocationsGetDailyMetricsTimeSeriesCall)Header

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

func (*LocationsGetDailyMetricsTimeSeriesCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeLocationsSearchkeywordsImpressionsMonthlyListCall

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

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)Context

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

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)Do

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 aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)Header

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

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)MonthlyRangeEndMonthDay

MonthlyRangeEndMonthDay sets the optional parameter"monthlyRange.endMonth.day": Day of a month. Must be from 1 to 31 and validfor the year and month, or 0 to specify a year by itself or a year and monthwhere the day isn't significant.

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)MonthlyRangeEndMonthMonth

MonthlyRangeEndMonthMonth sets the optional parameter"monthlyRange.endMonth.month": Month of a year. Must be from 1 to 12, or 0to specify a year without a month and day.

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)MonthlyRangeEndMonthYear

MonthlyRangeEndMonthYear sets the optional parameter"monthlyRange.endMonth.year": Year of the date. Must be from 1 to 9999, or 0to specify a date without a year.

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)MonthlyRangeStartMonthDay

MonthlyRangeStartMonthDay sets the optional parameter"monthlyRange.startMonth.day": Day of a month. Must be from 1 to 31 andvalid for the year and month, or 0 to specify a year by itself or a year andmonth where the day isn't significant.

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)MonthlyRangeStartMonthMonth

func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthMonth(monthlyRangeStartMonthMonthint64) *LocationsSearchkeywordsImpressionsMonthlyListCall

MonthlyRangeStartMonthMonth sets the optional parameter"monthlyRange.startMonth.month": Month of a year. Must be from 1 to 12, or 0to specify a year without a month and day.

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)MonthlyRangeStartMonthYear

MonthlyRangeStartMonthYear sets the optional parameter"monthlyRange.startMonth.year": Year of the date. Must be from 1 to 9999, or0 to specify a date without a year.

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)PageSize

PageSize sets the optional parameter "pageSize": The number of resultsrequested. The default page size is 100. Page size can be set to a maximumof 100.

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)PageToken

PageToken sets the optional parameter "pageToken": A token indicating thenext paginated result to be returned.

func (*LocationsSearchkeywordsImpressionsMonthlyListCall)Pages

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

typeLocationsSearchkeywordsImpressionsMonthlyService

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

func (*LocationsSearchkeywordsImpressionsMonthlyService)List

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 amonthly basis. Example request: `GEThttps://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.

typeLocationsSearchkeywordsImpressionsService

type LocationsSearchkeywordsImpressionsService struct {Monthly *LocationsSearchkeywordsImpressionsMonthlyService// contains filtered or unexported fields}

typeLocationsSearchkeywordsService

type LocationsSearchkeywordsService struct {Impressions *LocationsSearchkeywordsImpressionsService// contains filtered or unexported fields}

funcNewLocationsSearchkeywordsService

func NewLocationsSearchkeywordsService(s *Service) *LocationsSearchkeywordsService

typeLocationsService

type LocationsService struct {Searchkeywords *LocationsSearchkeywordsService// contains filtered or unexported fields}

funcNewLocationsService

func NewLocationsService(s *Service) *LocationsService

func (*LocationsService)FetchMultiDailyMetricsTimeSeriesadded inv0.112.0

func (r *LocationsService) FetchMultiDailyMetricsTimeSeries(locationstring) *LocationsFetchMultiDailyMetricsTimeSeriesCall

FetchMultiDailyMetricsTimeSeries: Returns the values for each date from agiven time range and optionally the sub entity type, where applicable, thatare associated with the specific daily metrics. Example request: `GEThttps://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 unobfuscatedlisting id.

func (*LocationsService)GetDailyMetricsTimeSeries

func (r *LocationsService) GetDailyMetricsTimeSeries(namestring) *LocationsGetDailyMetricsTimeSeriesCall

GetDailyMetricsTimeSeries: Returns the values for each date from a giventime range that are associated with the specific daily metric. Examplerequest: `GEThttps://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.

typeMultiDailyMetricTimeSeriesadded inv0.112.0

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:"-"`}

MultiDailyMetricTimeSeries: Represents a list of tuples ofDailyMetric-DailySubEntityType-TimeSeries.

func (MultiDailyMetricTimeSeries)MarshalJSONadded inv0.112.0

func (sMultiDailyMetricTimeSeries) MarshalJSON() ([]byte,error)

typeSearchKeywordCount

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.SearchKeywordstring `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:"-"`}

SearchKeywordCount: Represents a single search keyword and its value.

func (SearchKeywordCount)MarshalJSON

func (sSearchKeywordCount) MarshalJSON() ([]byte,error)

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentLocations *LocationsService// contains filtered or unexported fields}

funcNewdeprecated

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.

funcNewService

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

NewService creates a new Service.

typeTimeOfDayadded inv0.112.0

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.Hoursint64 `json:"hours,omitempty"`// Minutes: Minutes of an hour. Must be greater than or equal to 0 and less// than or equal to 59.Minutesint64 `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.Nanosint64 `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.Secondsint64 `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:"-"`}

TimeOfDay: Represents a time of day. The date and time zone are either notsignificant or are specified elsewhere. An API may choose to allow leapseconds. Related types are google.type.Date and `google.protobuf.Timestamp`.

func (TimeOfDay)MarshalJSONadded inv0.112.0

func (sTimeOfDay) MarshalJSON() ([]byte,error)

typeTimeSeries

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:"-"`}

TimeSeries: Represents a timeseries.

func (TimeSeries)MarshalJSON

func (sTimeSeries) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.
[8]ページ先頭
©2009-2025 Movatter.jp