Documentation
¶
Overview ¶
Package businessprofileperformance provides access to the Business Profile Performance API.
For product documentation, see: https://developers.google.com/my-business/
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 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 option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) businessprofileperformanceService, err := businessprofileperformance.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- type Date
- type DatedValue
- type GetDailyMetricsTimeSeriesResponse
- type InsightsValue
- type ListSearchKeywordImpressionsMonthlyResponse
- type LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) Context(ctx context.Context) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyMetric(dailyMetric string) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateDay(dailyRangeEndDateDay int64) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateMonth(dailyRangeEndDateMonth int64) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateYear(dailyRangeEndDateYear int64) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateDay(dailyRangeStartDateDay int64) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateMonth(dailyRangeStartDateMonth int64) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateYear(dailyRangeStartDateYear int64) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeDayOfWeek(dailySubEntityTypeDayOfWeek string) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayHours(dailySubEntityTypeTimeOfDayHours int64) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayMinutes(dailySubEntityTypeTimeOfDayMinutes int64) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayNanos(dailySubEntityTypeTimeOfDayNanos int64) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDaySeconds(dailySubEntityTypeTimeOfDaySeconds int64) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) Do(opts ...googleapi.CallOption) (*GetDailyMetricsTimeSeriesResponse, error)
- func (c *LocationsGetDailyMetricsTimeSeriesCall) Fields(s ...googleapi.Field) *LocationsGetDailyMetricsTimeSeriesCall
- func (c *LocationsGetDailyMetricsTimeSeriesCall) Header() http.Header
- func (c *LocationsGetDailyMetricsTimeSeriesCall) IfNoneMatch(entityTag string) *LocationsGetDailyMetricsTimeSeriesCall
- type LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Context(ctx context.Context) *LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Do(opts ...googleapi.CallOption) (*ListSearchKeywordImpressionsMonthlyResponse, error)
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Fields(s ...googleapi.Field) *LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Header() http.Header
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) IfNoneMatch(entityTag string) *LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthDay(monthlyRangeEndMonthDay int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthMonth(monthlyRangeEndMonthMonth int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthYear(monthlyRangeEndMonthYear int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthDay(monthlyRangeStartMonthDay int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthMonth(monthlyRangeStartMonthMonth int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthYear(monthlyRangeStartMonthYear int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) PageSize(pageSize int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) PageToken(pageToken string) *LocationsSearchkeywordsImpressionsMonthlyListCall
- func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Pages(ctx context.Context, ...) error
- type LocationsSearchkeywordsImpressionsMonthlyService
- type LocationsSearchkeywordsImpressionsService
- type LocationsSearchkeywordsService
- type LocationsService
- type SearchKeywordCount
- type Service
- type TimeSeries
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Date ¶
type Date struct { // Day: Day of a month. Must be from 1 to 31 and valid for the year and // month, or 0 to specify a year by itself or a year and month where the // day isn't significant. Day int64 `json:"day,omitempty"` // Month: Month of a year. Must be from 1 to 12, or 0 to specify a year // without a month and day. Month int64 `json:"month,omitempty"` // Year: Year of the date. Must be from 1 to 9999, or 0 to specify a // date without a year. Year int64 `json:"year,omitempty"` // ForceSendFields is a list of field names (e.g. "Day") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Day") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Date: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
func (*Date) MarshalJSON ¶
type DatedValue ¶
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. 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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Date") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DatedValue: Represents a single datapoint in the timeseries, where each datapoint is a date-value pair.
func (*DatedValue) MarshalJSON ¶
func (s *DatedValue) MarshalJSON() ([]byte, error)
type GetDailyMetricsTimeSeriesResponse ¶
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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "TimeSeries") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GetDailyMetricsTimeSeriesResponse: Represents the response for GetDailyMetricsTimeSeries.
func (*GetDailyMetricsTimeSeriesResponse) MarshalJSON ¶
func (s *GetDailyMetricsTimeSeriesResponse) MarshalJSON() ([]byte, error)
type InsightsValue ¶
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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Threshold") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
InsightsValue: Represents an insights value.
func (*InsightsValue) MarshalJSON ¶
func (s *InsightsValue) MarshalJSON() ([]byte, error)
type ListSearchKeywordImpressionsMonthlyResponse ¶
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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListSearchKeywordImpressionsMonthlyResponse: Represents the response for ListSearchKeywordImpressionsMonthly.
func (*ListSearchKeywordImpressionsMonthlyResponse) MarshalJSON ¶
func (s *ListSearchKeywordImpressionsMonthlyResponse) MarshalJSON() ([]byte, error)
type LocationsGetDailyMetricsTimeSeriesCall ¶
type LocationsGetDailyMetricsTimeSeriesCall struct {
// contains filtered or unexported fields
}
func (*LocationsGetDailyMetricsTimeSeriesCall) Context ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) Context(ctx context.Context) *LocationsGetDailyMetricsTimeSeriesCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*LocationsGetDailyMetricsTimeSeriesCall) DailyMetric ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyMetric(dailyMetric string) *LocationsGetDailyMetricsTimeSeriesCall
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 received from the
business profile.
"BUSINESS_FOOD_ORDERS" - The number of food orders received from
the business profile.
func (*LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateDay ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateDay(dailyRangeEndDateDay int64) *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 0 to specify a year by itself or a year and month where the day isn't significant.
func (*LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateMonth ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateMonth(dailyRangeEndDateMonth int64) *LocationsGetDailyMetricsTimeSeriesCall
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 (*LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateYear ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeEndDateYear(dailyRangeEndDateYear int64) *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 a year.
func (*LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateDay ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateDay(dailyRangeStartDateDay int64) *LocationsGetDailyMetricsTimeSeriesCall
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 (*LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateMonth ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateMonth(dailyRangeStartDateMonth int64) *LocationsGetDailyMetricsTimeSeriesCall
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 (*LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateYear ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailyRangeStartDateYear(dailyRangeStartDateYear int64) *LocationsGetDailyMetricsTimeSeriesCall
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 (*LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeDayOfWeek ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeDayOfWeek(dailySubEntityTypeDayOfWeek string) *LocationsGetDailyMetricsTimeSeriesCall
DailySubEntityTypeDayOfWeek sets the optional parameter "dailySubEntityType.dayOfWeek": Represents the day of the week. Eg: MONDAY.
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(dailySubEntityTypeTimeOfDayHours int64) *LocationsGetDailyMetricsTimeSeriesCall
DailySubEntityTypeTimeOfDayHours sets the optional parameter "dailySubEntityType.timeOfDay.hours": Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
func (*LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayMinutes ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayMinutes(dailySubEntityTypeTimeOfDayMinutes int64) *LocationsGetDailyMetricsTimeSeriesCall
DailySubEntityTypeTimeOfDayMinutes sets the optional parameter "dailySubEntityType.timeOfDay.minutes": Minutes of hour of day. Must be from 0 to 59.
func (*LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayNanos ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDayNanos(dailySubEntityTypeTimeOfDayNanos int64) *LocationsGetDailyMetricsTimeSeriesCall
DailySubEntityTypeTimeOfDayNanos sets the optional parameter "dailySubEntityType.timeOfDay.nanos": Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
func (*LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDaySeconds ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) DailySubEntityTypeTimeOfDaySeconds(dailySubEntityTypeTimeOfDaySeconds int64) *LocationsGetDailyMetricsTimeSeriesCall
DailySubEntityTypeTimeOfDaySeconds sets the optional parameter "dailySubEntityType.timeOfDay.seconds": Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
func (*LocationsGetDailyMetricsTimeSeriesCall) Do ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) Do(opts ...googleapi.CallOption) (*GetDailyMetricsTimeSeriesResponse, error)
Do executes the "businessprofileperformance.locations.getDailyMetricsTimeSeries" call. Exactly one of *GetDailyMetricsTimeSeriesResponse or error will be non-nil. 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 (*LocationsGetDailyMetricsTimeSeriesCall) Fields ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) Fields(s ...googleapi.Field) *LocationsGetDailyMetricsTimeSeriesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*LocationsGetDailyMetricsTimeSeriesCall) Header ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*LocationsGetDailyMetricsTimeSeriesCall) IfNoneMatch ¶
func (c *LocationsGetDailyMetricsTimeSeriesCall) IfNoneMatch(entityTag string) *LocationsGetDailyMetricsTimeSeriesCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type LocationsSearchkeywordsImpressionsMonthlyListCall ¶
type LocationsSearchkeywordsImpressionsMonthlyListCall struct {
// contains filtered or unexported fields
}
func (*LocationsSearchkeywordsImpressionsMonthlyListCall) Context ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Context(ctx context.Context) *LocationsSearchkeywordsImpressionsMonthlyListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*LocationsSearchkeywordsImpressionsMonthlyListCall) Do ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Do(opts ...googleapi.CallOption) (*ListSearchKeywordImpressionsMonthlyResponse, error)
Do executes the "businessprofileperformance.locations.searchkeywords.impressions.monthly.list" call. Exactly one of *ListSearchKeywordImpressionsMonthlyResponse or error will be non-nil. 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 (*LocationsSearchkeywordsImpressionsMonthlyListCall) Fields ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Fields(s ...googleapi.Field) *LocationsSearchkeywordsImpressionsMonthlyListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*LocationsSearchkeywordsImpressionsMonthlyListCall) Header ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*LocationsSearchkeywordsImpressionsMonthlyListCall) IfNoneMatch ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) IfNoneMatch(entityTag string) *LocationsSearchkeywordsImpressionsMonthlyListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthDay ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthDay(monthlyRangeEndMonthDay int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
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 (*LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthMonth ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthMonth(monthlyRangeEndMonthMonth int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
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 (*LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthYear ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeEndMonthYear(monthlyRangeEndMonthYear int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
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 (*LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthDay ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthDay(monthlyRangeStartMonthDay int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
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 (*LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthMonth ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthMonth(monthlyRangeStartMonthMonth int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
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 (*LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthYear ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) MonthlyRangeStartMonthYear(monthlyRangeStartMonthYear int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
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 (*LocationsSearchkeywordsImpressionsMonthlyListCall) PageSize ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) PageSize(pageSize int64) *LocationsSearchkeywordsImpressionsMonthlyListCall
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 (*LocationsSearchkeywordsImpressionsMonthlyListCall) PageToken ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) PageToken(pageToken string) *LocationsSearchkeywordsImpressionsMonthlyListCall
PageToken sets the optional parameter "pageToken": A token indicating the next paginated result to be returned.
func (*LocationsSearchkeywordsImpressionsMonthlyListCall) Pages ¶
func (c *LocationsSearchkeywordsImpressionsMonthlyListCall) Pages(ctx context.Context, f func(*ListSearchKeywordImpressionsMonthlyResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type LocationsSearchkeywordsImpressionsMonthlyService ¶
type LocationsSearchkeywordsImpressionsMonthlyService struct {
// contains filtered or unexported fields
}
func NewLocationsSearchkeywordsImpressionsMonthlyService ¶
func NewLocationsSearchkeywordsImpressionsMonthlyService(s *Service) *LocationsSearchkeywordsImpressionsMonthlyService
func (*LocationsSearchkeywordsImpressionsMonthlyService) List ¶
func (r *LocationsSearchkeywordsImpressionsMonthlyService) List(parent string) *LocationsSearchkeywordsImpressionsMonthlyListCall
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.
type LocationsSearchkeywordsImpressionsService ¶
type LocationsSearchkeywordsImpressionsService struct { Monthly *LocationsSearchkeywordsImpressionsMonthlyService // contains filtered or unexported fields }
func NewLocationsSearchkeywordsImpressionsService ¶
func NewLocationsSearchkeywordsImpressionsService(s *Service) *LocationsSearchkeywordsImpressionsService
type LocationsSearchkeywordsService ¶
type LocationsSearchkeywordsService struct { Impressions *LocationsSearchkeywordsImpressionsService // contains filtered or unexported fields }
func NewLocationsSearchkeywordsService ¶
func NewLocationsSearchkeywordsService(s *Service) *LocationsSearchkeywordsService
type LocationsService ¶
type LocationsService struct { Searchkeywords *LocationsSearchkeywordsService // contains filtered or unexported fields }
func NewLocationsService ¶
func NewLocationsService(s *Service) *LocationsService
func (*LocationsService) GetDailyMetricsTimeSeries ¶
func (r *LocationsService) GetDailyMetricsTimeSeries(name string) *LocationsGetDailyMetricsTimeSeriesCall
GetDailyMetricsTimeSeries: Returns the values for each date from a given time range that are associated with the specific daily metric. 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.
type SearchKeywordCount ¶
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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "InsightsValue") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SearchKeywordCount: Represents a single search keyword and its value.
func (*SearchKeywordCount) MarshalJSON ¶
func (s *SearchKeywordCount) MarshalJSON() ([]byte, error)
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Locations *LocationsService // contains filtered or unexported fields }
func New
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶
NewService creates a new Service.
type 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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DatedValues") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TimeSeries: Represents a timeseries.
func (*TimeSeries) MarshalJSON ¶
func (s *TimeSeries) MarshalJSON() ([]byte, error)