mybusinessbusinessinformation
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package mybusinessbusinessinformation provides access to the My Business Business Information 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/mybusinessbusinessinformation/v1"...ctx := context.Background()mybusinessbusinessinformationService, err := mybusinessbusinessinformation.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:
mybusinessbusinessinformationService, err := mybusinessbusinessinformation.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, ...)mybusinessbusinessinformationService, err := mybusinessbusinessinformation.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- type AccountsLocationsCreateCall
- func (c *AccountsLocationsCreateCall) Context(ctx context.Context) *AccountsLocationsCreateCall
- func (c *AccountsLocationsCreateCall) Do(opts ...googleapi.CallOption) (*Location, error)
- func (c *AccountsLocationsCreateCall) Fields(s ...googleapi.Field) *AccountsLocationsCreateCall
- func (c *AccountsLocationsCreateCall) Header() http.Header
- func (c *AccountsLocationsCreateCall) RequestId(requestId string) *AccountsLocationsCreateCall
- func (c *AccountsLocationsCreateCall) ValidateOnly(validateOnly bool) *AccountsLocationsCreateCall
- type AccountsLocationsListCall
- func (c *AccountsLocationsListCall) Context(ctx context.Context) *AccountsLocationsListCall
- func (c *AccountsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)
- func (c *AccountsLocationsListCall) Fields(s ...googleapi.Field) *AccountsLocationsListCall
- func (c *AccountsLocationsListCall) Filter(filter string) *AccountsLocationsListCall
- func (c *AccountsLocationsListCall) Header() http.Header
- func (c *AccountsLocationsListCall) IfNoneMatch(entityTag string) *AccountsLocationsListCall
- func (c *AccountsLocationsListCall) OrderBy(orderBy string) *AccountsLocationsListCall
- func (c *AccountsLocationsListCall) PageSize(pageSize int64) *AccountsLocationsListCall
- func (c *AccountsLocationsListCall) PageToken(pageToken string) *AccountsLocationsListCall
- func (c *AccountsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error
- func (c *AccountsLocationsListCall) ReadMask(readMask string) *AccountsLocationsListCall
- type AccountsLocationsService
- type AccountsService
- type AdWordsLocationExtensions
- type Attribute
- type AttributeMetadata
- type AttributeValueMetadata
- type Attributes
- type AttributesListCall
- func (c *AttributesListCall) CategoryName(categoryName string) *AttributesListCall
- func (c *AttributesListCall) Context(ctx context.Context) *AttributesListCall
- func (c *AttributesListCall) Do(opts ...googleapi.CallOption) (*ListAttributeMetadataResponse, error)
- func (c *AttributesListCall) Fields(s ...googleapi.Field) *AttributesListCall
- func (c *AttributesListCall) Header() http.Header
- func (c *AttributesListCall) IfNoneMatch(entityTag string) *AttributesListCall
- func (c *AttributesListCall) LanguageCode(languageCode string) *AttributesListCall
- func (c *AttributesListCall) PageSize(pageSize int64) *AttributesListCall
- func (c *AttributesListCall) PageToken(pageToken string) *AttributesListCall
- func (c *AttributesListCall) Pages(ctx context.Context, f func(*ListAttributeMetadataResponse) error) error
- func (c *AttributesListCall) Parent(parent string) *AttributesListCall
- func (c *AttributesListCall) RegionCode(regionCode string) *AttributesListCall
- func (c *AttributesListCall) ShowAll(showAll bool) *AttributesListCall
- type AttributesService
- type BatchGetCategoriesResponse
- type BusinessHours
- type Categories
- type CategoriesBatchGetCall
- func (c *CategoriesBatchGetCall) Context(ctx context.Context) *CategoriesBatchGetCall
- func (c *CategoriesBatchGetCall) Do(opts ...googleapi.CallOption) (*BatchGetCategoriesResponse, error)
- func (c *CategoriesBatchGetCall) Fields(s ...googleapi.Field) *CategoriesBatchGetCall
- func (c *CategoriesBatchGetCall) Header() http.Header
- func (c *CategoriesBatchGetCall) IfNoneMatch(entityTag string) *CategoriesBatchGetCall
- func (c *CategoriesBatchGetCall) LanguageCode(languageCode string) *CategoriesBatchGetCall
- func (c *CategoriesBatchGetCall) Names(names ...string) *CategoriesBatchGetCall
- func (c *CategoriesBatchGetCall) RegionCode(regionCode string) *CategoriesBatchGetCall
- func (c *CategoriesBatchGetCall) View(view string) *CategoriesBatchGetCall
- type CategoriesListCall
- func (c *CategoriesListCall) Context(ctx context.Context) *CategoriesListCall
- func (c *CategoriesListCall) Do(opts ...googleapi.CallOption) (*ListCategoriesResponse, error)
- func (c *CategoriesListCall) Fields(s ...googleapi.Field) *CategoriesListCall
- func (c *CategoriesListCall) Filter(filter string) *CategoriesListCall
- func (c *CategoriesListCall) Header() http.Header
- func (c *CategoriesListCall) IfNoneMatch(entityTag string) *CategoriesListCall
- func (c *CategoriesListCall) LanguageCode(languageCode string) *CategoriesListCall
- func (c *CategoriesListCall) PageSize(pageSize int64) *CategoriesListCall
- func (c *CategoriesListCall) PageToken(pageToken string) *CategoriesListCall
- func (c *CategoriesListCall) Pages(ctx context.Context, f func(*ListCategoriesResponse) error) error
- func (c *CategoriesListCall) RegionCode(regionCode string) *CategoriesListCall
- func (c *CategoriesListCall) View(view string) *CategoriesListCall
- type CategoriesService
- type Category
- type Chain
- type ChainName
- type ChainUri
- type ChainsGetCall
- func (c *ChainsGetCall) Context(ctx context.Context) *ChainsGetCall
- func (c *ChainsGetCall) Do(opts ...googleapi.CallOption) (*Chain, error)
- func (c *ChainsGetCall) Fields(s ...googleapi.Field) *ChainsGetCall
- func (c *ChainsGetCall) Header() http.Header
- func (c *ChainsGetCall) IfNoneMatch(entityTag string) *ChainsGetCall
- type ChainsSearchCall
- func (c *ChainsSearchCall) ChainName(chainName string) *ChainsSearchCall
- func (c *ChainsSearchCall) Context(ctx context.Context) *ChainsSearchCall
- func (c *ChainsSearchCall) Do(opts ...googleapi.CallOption) (*SearchChainsResponse, error)
- func (c *ChainsSearchCall) Fields(s ...googleapi.Field) *ChainsSearchCall
- func (c *ChainsSearchCall) Header() http.Header
- func (c *ChainsSearchCall) IfNoneMatch(entityTag string) *ChainsSearchCall
- func (c *ChainsSearchCall) PageSize(pageSize int64) *ChainsSearchCall
- type ChainsService
- type Date
- type Empty
- type FreeFormServiceItem
- type GoogleLocation
- type GoogleLocationsSearchCall
- func (c *GoogleLocationsSearchCall) Context(ctx context.Context) *GoogleLocationsSearchCall
- func (c *GoogleLocationsSearchCall) Do(opts ...googleapi.CallOption) (*SearchGoogleLocationsResponse, error)
- func (c *GoogleLocationsSearchCall) Fields(s ...googleapi.Field) *GoogleLocationsSearchCall
- func (c *GoogleLocationsSearchCall) Header() http.Header
- type GoogleLocationsService
- type GoogleUpdatedLocation
- type Label
- type LatLng
- type ListAttributeMetadataResponse
- type ListCategoriesResponse
- type ListLocationsResponse
- type Location
- type LocationsAttributesGetGoogleUpdatedCall
- func (c *LocationsAttributesGetGoogleUpdatedCall) Context(ctx context.Context) *LocationsAttributesGetGoogleUpdatedCall
- func (c *LocationsAttributesGetGoogleUpdatedCall) Do(opts ...googleapi.CallOption) (*Attributes, error)
- func (c *LocationsAttributesGetGoogleUpdatedCall) Fields(s ...googleapi.Field) *LocationsAttributesGetGoogleUpdatedCall
- func (c *LocationsAttributesGetGoogleUpdatedCall) Header() http.Header
- func (c *LocationsAttributesGetGoogleUpdatedCall) IfNoneMatch(entityTag string) *LocationsAttributesGetGoogleUpdatedCall
- type LocationsAttributesService
- type LocationsDeleteCall
- type LocationsGetAttributesCall
- func (c *LocationsGetAttributesCall) Context(ctx context.Context) *LocationsGetAttributesCall
- func (c *LocationsGetAttributesCall) Do(opts ...googleapi.CallOption) (*Attributes, error)
- func (c *LocationsGetAttributesCall) Fields(s ...googleapi.Field) *LocationsGetAttributesCall
- func (c *LocationsGetAttributesCall) Header() http.Header
- func (c *LocationsGetAttributesCall) IfNoneMatch(entityTag string) *LocationsGetAttributesCall
- type LocationsGetCall
- func (c *LocationsGetCall) Context(ctx context.Context) *LocationsGetCall
- func (c *LocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)
- func (c *LocationsGetCall) Fields(s ...googleapi.Field) *LocationsGetCall
- func (c *LocationsGetCall) Header() http.Header
- func (c *LocationsGetCall) IfNoneMatch(entityTag string) *LocationsGetCall
- func (c *LocationsGetCall) ReadMask(readMask string) *LocationsGetCall
- type LocationsGetGoogleUpdatedCall
- func (c *LocationsGetGoogleUpdatedCall) Context(ctx context.Context) *LocationsGetGoogleUpdatedCall
- func (c *LocationsGetGoogleUpdatedCall) Do(opts ...googleapi.CallOption) (*GoogleUpdatedLocation, error)
- func (c *LocationsGetGoogleUpdatedCall) Fields(s ...googleapi.Field) *LocationsGetGoogleUpdatedCall
- func (c *LocationsGetGoogleUpdatedCall) Header() http.Header
- func (c *LocationsGetGoogleUpdatedCall) IfNoneMatch(entityTag string) *LocationsGetGoogleUpdatedCall
- func (c *LocationsGetGoogleUpdatedCall) ReadMask(readMask string) *LocationsGetGoogleUpdatedCall
- type LocationsPatchCall
- func (c *LocationsPatchCall) Context(ctx context.Context) *LocationsPatchCall
- func (c *LocationsPatchCall) Do(opts ...googleapi.CallOption) (*Location, error)
- func (c *LocationsPatchCall) Fields(s ...googleapi.Field) *LocationsPatchCall
- func (c *LocationsPatchCall) Header() http.Header
- func (c *LocationsPatchCall) UpdateMask(updateMask string) *LocationsPatchCall
- func (c *LocationsPatchCall) ValidateOnly(validateOnly bool) *LocationsPatchCall
- type LocationsService
- func (r *LocationsService) Delete(name string) *LocationsDeleteCall
- func (r *LocationsService) Get(name string) *LocationsGetCall
- func (r *LocationsService) GetAttributes(nameid string) *LocationsGetAttributesCall
- func (r *LocationsService) GetGoogleUpdated(name string) *LocationsGetGoogleUpdatedCall
- func (r *LocationsService) Patch(nameid string, location *Location) *LocationsPatchCall
- func (r *LocationsService) UpdateAttributes(nameid string, attributes *Attributes) *LocationsUpdateAttributesCall
- type LocationsUpdateAttributesCall
- func (c *LocationsUpdateAttributesCall) AttributeMask(attributeMask string) *LocationsUpdateAttributesCall
- func (c *LocationsUpdateAttributesCall) Context(ctx context.Context) *LocationsUpdateAttributesCall
- func (c *LocationsUpdateAttributesCall) Do(opts ...googleapi.CallOption) (*Attributes, error)
- func (c *LocationsUpdateAttributesCall) Fields(s ...googleapi.Field) *LocationsUpdateAttributesCall
- func (c *LocationsUpdateAttributesCall) Header() http.Header
- type Metadata
- type Money
- type MoreHours
- type MoreHoursType
- type OpenInfo
- type PhoneNumbers
- type PlaceInfo
- type Places
- type PostalAddress
- type Profile
- type RelationshipData
- type RelevantLocation
- type RepeatedEnumAttributeValue
- type SearchChainsResponse
- type SearchGoogleLocationsRequest
- type SearchGoogleLocationsResponse
- type Service
- type ServiceAreaBusiness
- type ServiceItem
- type ServiceType
- type SpecialHourPeriod
- type SpecialHours
- type StructuredServiceItem
- type TimeOfDay
- type TimePeriod
- type UriAttributeValue
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAccountsLocationsCreateCall¶
type AccountsLocationsCreateCall struct {// contains filtered or unexported fields}func (*AccountsLocationsCreateCall)Context¶
func (c *AccountsLocationsCreateCall) Context(ctxcontext.Context) *AccountsLocationsCreateCall
Context sets the context to be used in this call's Do method.
func (*AccountsLocationsCreateCall)Do¶
func (c *AccountsLocationsCreateCall) Do(opts ...googleapi.CallOption) (*Location,error)
Do executes the "mybusinessbusinessinformation.accounts.locations.create" call.Any non-2xx status code is an error. Response headers are in either*Location.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*AccountsLocationsCreateCall)Fields¶
func (c *AccountsLocationsCreateCall) Fields(s ...googleapi.Field) *AccountsLocationsCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*AccountsLocationsCreateCall)Header¶
func (c *AccountsLocationsCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*AccountsLocationsCreateCall)RequestId¶
func (c *AccountsLocationsCreateCall) RequestId(requestIdstring) *AccountsLocationsCreateCall
RequestId sets the optional parameter "requestId": A unique request ID forthe server to detect duplicated requests. We recommend using UUIDs. Maxlength is 50 characters.
func (*AccountsLocationsCreateCall)ValidateOnly¶
func (c *AccountsLocationsCreateCall) ValidateOnly(validateOnlybool) *AccountsLocationsCreateCall
ValidateOnly sets the optional parameter "validateOnly": If true, therequest is validated without actually creating the location.
typeAccountsLocationsListCall¶
type AccountsLocationsListCall struct {// contains filtered or unexported fields}func (*AccountsLocationsListCall)Context¶
func (c *AccountsLocationsListCall) Context(ctxcontext.Context) *AccountsLocationsListCall
Context sets the context to be used in this call's Do method.
func (*AccountsLocationsListCall)Do¶
func (c *AccountsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse,error)
Do executes the "mybusinessbusinessinformation.accounts.locations.list" call.Any non-2xx status code is an error. Response headers are in either*ListLocationsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*AccountsLocationsListCall)Fields¶
func (c *AccountsLocationsListCall) Fields(s ...googleapi.Field) *AccountsLocationsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*AccountsLocationsListCall)Filter¶
func (c *AccountsLocationsListCall) Filter(filterstring) *AccountsLocationsListCall
Filter sets the optional parameter "filter": A filter constraining thelocations to return. The response includes only entries that match thefilter. If `filter` is empty, then constraints are applied and all locations(paginated) are retrieved for the requested account. For more informationabout valid fields and example usage, see Work with Location Data Guide(https://developers.google.com/my-business/content/location-data#filter_results_when_you_list_locations).
func (*AccountsLocationsListCall)Header¶
func (c *AccountsLocationsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*AccountsLocationsListCall)IfNoneMatch¶
func (c *AccountsLocationsListCall) IfNoneMatch(entityTagstring) *AccountsLocationsListCall
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 (*AccountsLocationsListCall)OrderBy¶
func (c *AccountsLocationsListCall) OrderBy(orderBystring) *AccountsLocationsListCall
OrderBy sets the optional parameter "orderBy": Sorting order for therequest. Multiple fields should be comma-separated, following SQL syntax.The default sorting order is ascending. To specify descending order, asuffix " desc" should be added. Valid fields to order_by are title andstore_code. For example: "title, store_code desc" or "title" or "store_codedesc"
func (*AccountsLocationsListCall)PageSize¶
func (c *AccountsLocationsListCall) PageSize(pageSizeint64) *AccountsLocationsListCall
PageSize sets the optional parameter "pageSize": How many locations to fetchper page. Default value is 10 if not set. Minimum is 1, and maximum pagesize is 100.
func (*AccountsLocationsListCall)PageToken¶
func (c *AccountsLocationsListCall) PageToken(pageTokenstring) *AccountsLocationsListCall
PageToken sets the optional parameter "pageToken": If specified, it fetchesthe next `page` of locations. The page token is returned by previous callsto `ListLocations` when there were more locations than could fit in therequested page size.
func (*AccountsLocationsListCall)Pages¶
func (c *AccountsLocationsListCall) Pages(ctxcontext.Context, f func(*ListLocationsResponse)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.
func (*AccountsLocationsListCall)ReadMask¶
func (c *AccountsLocationsListCall) ReadMask(readMaskstring) *AccountsLocationsListCall
ReadMask sets the optional parameter "readMask": Required. Read mask tospecify what fields will be returned in the response.
typeAccountsLocationsService¶
type AccountsLocationsService struct {// contains filtered or unexported fields}funcNewAccountsLocationsService¶
func NewAccountsLocationsService(s *Service) *AccountsLocationsService
func (*AccountsLocationsService)Create¶
func (r *AccountsLocationsService) Create(parentstring, location *Location) *AccountsLocationsCreateCall
Create: Creates a new Location that will be owned by the logged in user.
- parent: The name of the account in which to create this location.
func (*AccountsLocationsService)List¶
func (r *AccountsLocationsService) List(parentstring) *AccountsLocationsListCall
List: Lists the locations for the specified account.
- parent: The name of the account to fetch locations from. If the parentAccount is of AccountType PERSONAL, only Locations that are directly ownedby the Account are returned, otherwise it will return all accessiblelocations from the Account, either directly or indirectly.
typeAccountsService¶
type AccountsService struct {Locations *AccountsLocationsService// contains filtered or unexported fields}funcNewAccountsService¶
func NewAccountsService(s *Service) *AccountsService
typeAdWordsLocationExtensions¶
type AdWordsLocationExtensions struct {// AdPhone: Required. An alternate phone number to display on AdWords location// extensions instead of the location's primary phone number.AdPhonestring `json:"adPhone,omitempty"`// ForceSendFields is a list of field names (e.g. "AdPhone") 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. "AdPhone") 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:"-"`}AdWordsLocationExtensions: Additional information that is surfaced inAdWords.
func (AdWordsLocationExtensions)MarshalJSON¶
func (sAdWordsLocationExtensions) MarshalJSON() ([]byte,error)
typeAttribute¶
type Attribute struct {// Name: Required. The resource name for this attribute.Namestring `json:"name,omitempty"`// RepeatedEnumValue: When the attribute value type is REPEATED_ENUM, this// contains the attribute value, and the other values fields must be empty.RepeatedEnumValue *RepeatedEnumAttributeValue `json:"repeatedEnumValue,omitempty"`// UriValues: When the attribute value type is URL, this field contains the// value(s) for this attribute, and the other values fields must be empty.UriValues []*UriAttributeValue `json:"uriValues,omitempty"`// ValueType: Output only. The type of value that this attribute contains. This// should be used to determine how to interpret the value.//// Possible values:// "ATTRIBUTE_VALUE_TYPE_UNSPECIFIED" - Not specified.// "BOOL" - The values for this attribute are boolean values.// "ENUM" - The attribute has a predetermined list of available values that// can be used. Metadata for this attribute will list these values.// "URL" - The values for this attribute are URLs.// "REPEATED_ENUM" - The attribute value is an enum with multiple possible// values that can be explicitly set or unset.ValueTypestring `json:"valueType,omitempty"`// Values: The values for this attribute. The type of the values supplied must// match that expected for that attribute. This is a repeated field where// multiple attribute values may be provided. Attribute types only support one// value.Values []interface{} `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") 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. "Name") 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:"-"`}Attribute: A location attribute. Attributes provide additional informationabout a location. The attributes that can be set on a location may varybased on the properties of that location (for example, category). Availableattributes are determined by Google and may be added and removed without APIchanges.
func (Attribute)MarshalJSON¶
typeAttributeMetadata¶
type AttributeMetadata struct {// Deprecated -- If true, the attribute is deprecated and should no longer be// used. If deprecated, updating this attribute will not result in an error,// but updates will not be saved. At some point after being deprecated, the// attribute will be removed entirely and it will become an error.Deprecatedbool `json:"deprecated,omitempty"`// DisplayName: The localized display name for the attribute, if available;// otherwise, the English display name.DisplayNamestring `json:"displayName,omitempty"`// GroupDisplayName: The localized display name of the group that contains this// attribute, if available; otherwise, the English group name. Related// attributes are collected into a group and should be displayed together under// the heading given here.GroupDisplayNamestring `json:"groupDisplayName,omitempty"`// Parent: The unique identifier for the attribute.Parentstring `json:"parent,omitempty"`// Repeatable: If true, the attribute supports multiple values. If false, only// a single value should be provided.Repeatablebool `json:"repeatable,omitempty"`// ValueMetadata: For some types of attributes (for example, enums), a list of// supported values and corresponding display names for those values is// provided.ValueMetadata []*AttributeValueMetadata `json:"valueMetadata,omitempty"`// ValueType: The value type for the attribute. Values set and retrieved should// be expected to be of this type.//// Possible values:// "ATTRIBUTE_VALUE_TYPE_UNSPECIFIED" - Not specified.// "BOOL" - The values for this attribute are boolean values.// "ENUM" - The attribute has a predetermined list of available values that// can be used. Metadata for this attribute will list these values.// "URL" - The values for this attribute are URLs.// "REPEATED_ENUM" - The attribute value is an enum with multiple possible// values that can be explicitly set or unset.ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "Deprecated") 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. "Deprecated") 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:"-"`}AttributeMetadata: Metadata for an attribute. Contains display informationfor the attribute, including a localized name and a heading for groupingrelated attributes together.
func (AttributeMetadata)MarshalJSON¶
func (sAttributeMetadata) MarshalJSON() ([]byte,error)
typeAttributeValueMetadata¶
type AttributeValueMetadata struct {// DisplayName: The display name for this value, localized where available;// otherwise, in English. The value display name is intended to be used in// context with the attribute display name. For example, for a "WiFi" enum// attribute, this could contain "Paid" to represent paid Wi-Fi.DisplayNamestring `json:"displayName,omitempty"`// Value: The attribute value.Value interface{} `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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:"-"`}AttributeValueMetadata: Metadata for supported attribute values.
func (AttributeValueMetadata)MarshalJSON¶
func (sAttributeValueMetadata) MarshalJSON() ([]byte,error)
typeAttributes¶
type Attributes struct {// Attributes: A collection of attributes that need to be updated.Attributes []*Attribute `json:"attributes,omitempty"`// Name: Required. Google identifier for this location in the form of// `locations/{location_id}/attributes`.Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Attributes") 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. "Attributes") 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:"-"`}Attributes: A container for all the attributes for a given location.
func (Attributes)MarshalJSON¶
func (sAttributes) MarshalJSON() ([]byte,error)
typeAttributesListCall¶
type AttributesListCall struct {// contains filtered or unexported fields}func (*AttributesListCall)CategoryName¶
func (c *AttributesListCall) CategoryName(categoryNamestring) *AttributesListCall
CategoryName sets the optional parameter "categoryName": The primarycategory stable ID to find available attributes. Must be of the formatcategories/{category_id}.
func (*AttributesListCall)Context¶
func (c *AttributesListCall) Context(ctxcontext.Context) *AttributesListCall
Context sets the context to be used in this call's Do method.
func (*AttributesListCall)Do¶
func (c *AttributesListCall) Do(opts ...googleapi.CallOption) (*ListAttributeMetadataResponse,error)
Do executes the "mybusinessbusinessinformation.attributes.list" call.Any non-2xx status code is an error. Response headers are in either*ListAttributeMetadataResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*AttributesListCall)Fields¶
func (c *AttributesListCall) Fields(s ...googleapi.Field) *AttributesListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*AttributesListCall)Header¶
func (c *AttributesListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*AttributesListCall)IfNoneMatch¶
func (c *AttributesListCall) IfNoneMatch(entityTagstring) *AttributesListCall
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 (*AttributesListCall)LanguageCode¶
func (c *AttributesListCall) LanguageCode(languageCodestring) *AttributesListCall
LanguageCode sets the optional parameter "languageCode": The BCP 47 code oflanguage to get attribute display names in. If this language is notavailable, they will be provided in English.
func (*AttributesListCall)PageSize¶
func (c *AttributesListCall) PageSize(pageSizeint64) *AttributesListCall
PageSize sets the optional parameter "pageSize": How many attributes toinclude per page. Default is 200, minimum is 1.
func (*AttributesListCall)PageToken¶
func (c *AttributesListCall) PageToken(pageTokenstring) *AttributesListCall
PageToken sets the optional parameter "pageToken": If specified, the nextpage of attribute metadata is retrieved.
func (*AttributesListCall)Pages¶
func (c *AttributesListCall) Pages(ctxcontext.Context, f func(*ListAttributeMetadataResponse)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.
func (*AttributesListCall)Parent¶
func (c *AttributesListCall) Parent(parentstring) *AttributesListCall
Parent sets the optional parameter "parent": Resource name of the locationto look up available attributes. If this field is set, category_name,region_code, language_code and show_all are not required and must not beset.
func (*AttributesListCall)RegionCode¶
func (c *AttributesListCall) RegionCode(regionCodestring) *AttributesListCall
RegionCode sets the optional parameter "regionCode": The ISO 3166-1 alpha-2country code to find available attributes.
func (*AttributesListCall)ShowAll¶
func (c *AttributesListCall) ShowAll(showAllbool) *AttributesListCall
ShowAll sets the optional parameter "showAll": Metadata for all availableattributes are returned when this field is set to true, disregarding parentand category_name fields. language_code and region_code are required whenshow_all is set to true.
typeAttributesService¶
type AttributesService struct {// contains filtered or unexported fields}funcNewAttributesService¶
func NewAttributesService(s *Service) *AttributesService
func (*AttributesService)List¶
func (r *AttributesService) List() *AttributesListCall
List: Returns the list of attributes that would be available for a locationwith the given primary category and country.
typeBatchGetCategoriesResponse¶
type BatchGetCategoriesResponse struct {// Categories: Categories that match the GConcept ids provided in the request.// They will not come in the same order as category ids in the request.Categories []*Category `json:"categories,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Categories") 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. "Categories") 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:"-"`}BatchGetCategoriesResponse: Response message forBusinessCategories.BatchGetBusinessCategories.
func (BatchGetCategoriesResponse)MarshalJSON¶
func (sBatchGetCategoriesResponse) MarshalJSON() ([]byte,error)
typeBusinessHours¶
type BusinessHours struct {// Periods: Required. A collection of times that this location is open for// business. Each period represents a range of hours when the location is open// during the week.Periods []*TimePeriod `json:"periods,omitempty"`// ForceSendFields is a list of field names (e.g. "Periods") 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. "Periods") 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:"-"`}BusinessHours: Represents the time periods that this location is open forbusiness. Holds a collection of TimePeriod instances.
func (BusinessHours)MarshalJSON¶
func (sBusinessHours) MarshalJSON() ([]byte,error)
typeCategories¶
type Categories struct {// AdditionalCategories: Optional. Additional categories to describe your// business. Categories help your customers find accurate, specific results for// services they're interested in. To keep your business information accurate// and live, make sure that you use as few categories as possible to describe// your overall core business. Choose categories that are as specific as// possible, but representative of your main business.AdditionalCategories []*Category `json:"additionalCategories,omitempty"`// PrimaryCategory: Required. Category that best describes the core business// this location engages in.PrimaryCategory *Category `json:"primaryCategory,omitempty"`// ForceSendFields is a list of field names (e.g. "AdditionalCategories") 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. "AdditionalCategories") 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:"-"`}Categories: A collection of categories that describes the business. Duringupdates, both fields must be set. Clients are prohibited from individuallyupdating the primary or additional categories using the update mask.
func (Categories)MarshalJSON¶
func (sCategories) MarshalJSON() ([]byte,error)
typeCategoriesBatchGetCall¶
type CategoriesBatchGetCall struct {// contains filtered or unexported fields}func (*CategoriesBatchGetCall)Context¶
func (c *CategoriesBatchGetCall) Context(ctxcontext.Context) *CategoriesBatchGetCall
Context sets the context to be used in this call's Do method.
func (*CategoriesBatchGetCall)Do¶
func (c *CategoriesBatchGetCall) Do(opts ...googleapi.CallOption) (*BatchGetCategoriesResponse,error)
Do executes the "mybusinessbusinessinformation.categories.batchGet" call.Any non-2xx status code is an error. Response headers are in either*BatchGetCategoriesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*CategoriesBatchGetCall)Fields¶
func (c *CategoriesBatchGetCall) Fields(s ...googleapi.Field) *CategoriesBatchGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CategoriesBatchGetCall)Header¶
func (c *CategoriesBatchGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*CategoriesBatchGetCall)IfNoneMatch¶
func (c *CategoriesBatchGetCall) IfNoneMatch(entityTagstring) *CategoriesBatchGetCall
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 (*CategoriesBatchGetCall)LanguageCode¶
func (c *CategoriesBatchGetCall) LanguageCode(languageCodestring) *CategoriesBatchGetCall
LanguageCode sets the optional parameter "languageCode": Required. The BCP47 code of language that the category names should be returned in.
func (*CategoriesBatchGetCall)Names¶
func (c *CategoriesBatchGetCall) Names(names ...string) *CategoriesBatchGetCall
Names sets the optional parameter "names": Required. At least one name mustbe set. The GConcept ids the localized category names should be returnedfor. To return details for more than one category, repeat this parameter inthe request.
func (*CategoriesBatchGetCall)RegionCode¶
func (c *CategoriesBatchGetCall) RegionCode(regionCodestring) *CategoriesBatchGetCall
RegionCode sets the optional parameter "regionCode": The ISO 3166-1 alpha-2country code used to infer non-standard language.
func (*CategoriesBatchGetCall)View¶
func (c *CategoriesBatchGetCall) View(viewstring) *CategoriesBatchGetCall
View sets the optional parameter "view": Required. Specifies which parts tothe Category resource should be returned in the response.
Possible values:
"CATEGORY_VIEW_UNSPECIFIED" - Not specified, equivalent to
CATEGORY_METADATA_ONLY.
"BASIC" - The server response will only include Category fields
display_name, category_id and language_code. It omits any service typemetadata related fields.
"FULL" - Returns all the fields in the response.
typeCategoriesListCall¶
type CategoriesListCall struct {// contains filtered or unexported fields}func (*CategoriesListCall)Context¶
func (c *CategoriesListCall) Context(ctxcontext.Context) *CategoriesListCall
Context sets the context to be used in this call's Do method.
func (*CategoriesListCall)Do¶
func (c *CategoriesListCall) Do(opts ...googleapi.CallOption) (*ListCategoriesResponse,error)
Do executes the "mybusinessbusinessinformation.categories.list" call.Any non-2xx status code is an error. Response headers are in either*ListCategoriesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*CategoriesListCall)Fields¶
func (c *CategoriesListCall) Fields(s ...googleapi.Field) *CategoriesListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CategoriesListCall)Filter¶
func (c *CategoriesListCall) Filter(filterstring) *CategoriesListCall
Filter sets the optional parameter "filter": Filter string from user. Theonly field that supported is `displayName`. Eg: `filter=displayName=foo`.
func (*CategoriesListCall)Header¶
func (c *CategoriesListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*CategoriesListCall)IfNoneMatch¶
func (c *CategoriesListCall) IfNoneMatch(entityTagstring) *CategoriesListCall
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 (*CategoriesListCall)LanguageCode¶
func (c *CategoriesListCall) LanguageCode(languageCodestring) *CategoriesListCall
LanguageCode sets the optional parameter "languageCode": Required. The BCP47 code of language.
func (*CategoriesListCall)PageSize¶
func (c *CategoriesListCall) PageSize(pageSizeint64) *CategoriesListCall
PageSize sets the optional parameter "pageSize": How many categories tofetch per page. Default is 100, minimum is 1, and maximum page size is 100.
func (*CategoriesListCall)PageToken¶
func (c *CategoriesListCall) PageToken(pageTokenstring) *CategoriesListCall
PageToken sets the optional parameter "pageToken": If specified, the nextpage of categories will be fetched.
func (*CategoriesListCall)Pages¶
func (c *CategoriesListCall) Pages(ctxcontext.Context, f func(*ListCategoriesResponse)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.
func (*CategoriesListCall)RegionCode¶
func (c *CategoriesListCall) RegionCode(regionCodestring) *CategoriesListCall
RegionCode sets the optional parameter "regionCode": Required. The ISO3166-1 alpha-2 country code.
func (*CategoriesListCall)View¶
func (c *CategoriesListCall) View(viewstring) *CategoriesListCall
View sets the optional parameter "view": Required. Specifies which parts tothe Category resource should be returned in the response.
Possible values:
"CATEGORY_VIEW_UNSPECIFIED" - Not specified, equivalent to
CATEGORY_METADATA_ONLY.
"BASIC" - The server response will only include Category fields
display_name, category_id and language_code. It omits any service typemetadata related fields.
"FULL" - Returns all the fields in the response.
typeCategoriesService¶
type CategoriesService struct {// contains filtered or unexported fields}funcNewCategoriesService¶
func NewCategoriesService(s *Service) *CategoriesService
func (*CategoriesService)BatchGet¶
func (r *CategoriesService) BatchGet() *CategoriesBatchGetCall
BatchGet: Returns a list of business categories for the provided languageand GConcept ids.
func (*CategoriesService)List¶
func (r *CategoriesService) List() *CategoriesListCall
List: Returns a list of business categories. Search will match the categoryname but not the category ID. Search only matches the front of a categoryname (that is, 'food' may return 'Food Court' but not 'Fast FoodRestaurant').
typeCategory¶
type Category struct {// DisplayName: Output only. The human-readable name of the category. This is// set when reading the location. When modifying the location, `category_id`// must be set.DisplayNamestring `json:"displayName,omitempty"`// MoreHoursTypes: Output only. More hours types that are available for this// business category.MoreHoursTypes []*MoreHoursType `json:"moreHoursTypes,omitempty"`// Name: Required. A stable ID (provided by Google) for this category. The// value must be specified when modifying the category (when creating or// updating a location).Namestring `json:"name,omitempty"`// ServiceTypes: Output only. A list of all the service types that are// available for this business category.ServiceTypes []*ServiceType `json:"serviceTypes,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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:"-"`}Category: A category describing what this business is (not what it does).For a list of valid category IDs, and the mappings to their human-readablenames, see `categories.list`.
func (Category)MarshalJSON¶
typeChain¶
type Chain struct {// ChainNames: Names of the chain.ChainNames []*ChainName `json:"chainNames,omitempty"`// LocationCount: Number of locations that are part of this chain.LocationCountint64 `json:"locationCount,omitempty"`// Name: Required. The chain's resource name, in the format// `chains/{chain_id}`.Namestring `json:"name,omitempty"`// Websites: Websites of the chain.Websites []*ChainUri `json:"websites,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ChainNames") 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. "ChainNames") 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:"-"`}Chain: A chain is a brand that your business's locations can be affiliatedwith.
func (Chain)MarshalJSON¶
typeChainName¶
type ChainName struct {// DisplayName: The display name for this chain.DisplayNamestring `json:"displayName,omitempty"`// LanguageCode: The BCP 47 code of language of the name.LanguageCodestring `json:"languageCode,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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:"-"`}ChainName: Name to be used when displaying the chain.
func (ChainName)MarshalJSON¶
typeChainUri¶
type ChainUri struct {// Uri: The uri for this chain.Uristring `json:"uri,omitempty"`// ForceSendFields is a list of field names (e.g. "Uri") 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. "Uri") 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:"-"`}ChainUri: Url to be used when displaying the chain.
func (ChainUri)MarshalJSON¶
typeChainsGetCall¶
type ChainsGetCall struct {// contains filtered or unexported fields}func (*ChainsGetCall)Context¶
func (c *ChainsGetCall) Context(ctxcontext.Context) *ChainsGetCall
Context sets the context to be used in this call's Do method.
func (*ChainsGetCall)Do¶
func (c *ChainsGetCall) Do(opts ...googleapi.CallOption) (*Chain,error)
Do executes the "mybusinessbusinessinformation.chains.get" call.Any non-2xx status code is an error. Response headers are in either*Chain.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ChainsGetCall)Fields¶
func (c *ChainsGetCall) Fields(s ...googleapi.Field) *ChainsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ChainsGetCall)Header¶
func (c *ChainsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ChainsGetCall)IfNoneMatch¶
func (c *ChainsGetCall) IfNoneMatch(entityTagstring) *ChainsGetCall
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.
typeChainsSearchCall¶
type ChainsSearchCall struct {// contains filtered or unexported fields}func (*ChainsSearchCall)ChainName¶
func (c *ChainsSearchCall) ChainName(chainNamestring) *ChainsSearchCall
ChainName sets the optional parameter "chainName": Required. Search for achain by its name. Exact/partial/fuzzy/related queries are supported.Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"
func (*ChainsSearchCall)Context¶
func (c *ChainsSearchCall) Context(ctxcontext.Context) *ChainsSearchCall
Context sets the context to be used in this call's Do method.
func (*ChainsSearchCall)Do¶
func (c *ChainsSearchCall) Do(opts ...googleapi.CallOption) (*SearchChainsResponse,error)
Do executes the "mybusinessbusinessinformation.chains.search" call.Any non-2xx status code is an error. Response headers are in either*SearchChainsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*ChainsSearchCall)Fields¶
func (c *ChainsSearchCall) Fields(s ...googleapi.Field) *ChainsSearchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ChainsSearchCall)Header¶
func (c *ChainsSearchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ChainsSearchCall)IfNoneMatch¶
func (c *ChainsSearchCall) IfNoneMatch(entityTagstring) *ChainsSearchCall
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 (*ChainsSearchCall)PageSize¶
func (c *ChainsSearchCall) PageSize(pageSizeint64) *ChainsSearchCall
PageSize sets the optional parameter "pageSize": The maximum number ofmatched chains to return from this query. The default is 10. The maximumpossible value is 500.
typeChainsService¶
type ChainsService struct {// contains filtered or unexported fields}funcNewChainsService¶
func NewChainsService(s *Service) *ChainsService
func (*ChainsService)Get¶
func (r *ChainsService) Get(namestring) *ChainsGetCall
Get: Gets the specified chain. Returns `NOT_FOUND` if the chain does notexist.
- name: The chain's resource name, in the format `chains/{chain_place_id}`.
func (*ChainsService)Search¶
func (r *ChainsService) Search() *ChainsSearchCall
Search: Searches the chain based on chain name.
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¶
typeEmpty¶
type Empty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}Empty: A generic empty message that you can re-use to avoid definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
typeFreeFormServiceItem¶
type FreeFormServiceItem struct {// Category: Required. This field represents the category name (i.e. the// category's stable ID). The `category` and `service_type_id` should match the// possible combinations provided in the `Category` message.Categorystring `json:"category,omitempty"`// Label: Required. Language-tagged labels for the item. We recommend that item// names be 140 characters or less, and descriptions 250 characters or less.// This field should only be set if the input is a custom service item.// Standardized service types should be updated via service_type_id.Label *Label `json:"label,omitempty"`// ForceSendFields is a list of field names (e.g. "Category") 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. "Category") 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:"-"`}FreeFormServiceItem: Represents a free-form service offered by the merchant.These are services that are not exposed as part of our structure servicedata. The merchant manually enters the names for of such services via ageomerchant surface.
func (FreeFormServiceItem)MarshalJSON¶
func (sFreeFormServiceItem) MarshalJSON() ([]byte,error)
typeGoogleLocation¶
type GoogleLocation struct {// Location: The sparsely populated Location information. This field can be// re-used in CreateLocation if it is not currently claimed by a user.Location *Location `json:"location,omitempty"`// Name: Resource name of this GoogleLocation, in the format// `googleLocations/{googleLocationId}`.Namestring `json:"name,omitempty"`// RequestAdminRightsUri: A URL that will redirect the user to the request// admin rights UI. This field is only present if the location has already been// claimed by any user, including the current user.RequestAdminRightsUristring `json:"requestAdminRightsUri,omitempty"`// ForceSendFields is a list of field names (e.g. "Location") 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. "Location") 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:"-"`}GoogleLocation: Represents a Location that is present on Google. This can bea location that has been claimed by the user, someone else, or could beunclaimed.
func (GoogleLocation)MarshalJSON¶
func (sGoogleLocation) MarshalJSON() ([]byte,error)
typeGoogleLocationsSearchCall¶
type GoogleLocationsSearchCall struct {// contains filtered or unexported fields}func (*GoogleLocationsSearchCall)Context¶
func (c *GoogleLocationsSearchCall) Context(ctxcontext.Context) *GoogleLocationsSearchCall
Context sets the context to be used in this call's Do method.
func (*GoogleLocationsSearchCall)Do¶
func (c *GoogleLocationsSearchCall) Do(opts ...googleapi.CallOption) (*SearchGoogleLocationsResponse,error)
Do executes the "mybusinessbusinessinformation.googleLocations.search" call.Any non-2xx status code is an error. Response headers are in either*SearchGoogleLocationsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*GoogleLocationsSearchCall)Fields¶
func (c *GoogleLocationsSearchCall) Fields(s ...googleapi.Field) *GoogleLocationsSearchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*GoogleLocationsSearchCall)Header¶
func (c *GoogleLocationsSearchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeGoogleLocationsService¶
type GoogleLocationsService struct {// contains filtered or unexported fields}funcNewGoogleLocationsService¶
func NewGoogleLocationsService(s *Service) *GoogleLocationsService
func (*GoogleLocationsService)Search¶
func (r *GoogleLocationsService) Search(searchgooglelocationsrequest *SearchGoogleLocationsRequest) *GoogleLocationsSearchCall
Search: Search all of the possible locations that are a match to thespecified request.
typeGoogleUpdatedLocation¶
type GoogleUpdatedLocation struct {// DiffMask: The fields that Google updated.DiffMaskstring `json:"diffMask,omitempty"`// Location: The Google-updated version of this location.Location *Location `json:"location,omitempty"`// PendingMask: The fields that have pending edits that haven't yet been pushed// to Maps and Search.PendingMaskstring `json:"pendingMask,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DiffMask") 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. "DiffMask") 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:"-"`}GoogleUpdatedLocation: Represents a location that was modified by Google.
func (GoogleUpdatedLocation)MarshalJSON¶
func (sGoogleUpdatedLocation) MarshalJSON() ([]byte,error)
typeLabel¶
type Label struct {// Description: Optional. Description of the price list, section, or item.Descriptionstring `json:"description,omitempty"`// DisplayName: Required. Display name for the price list, section, or item.DisplayNamestring `json:"displayName,omitempty"`// LanguageCode: Optional. The BCP-47 language code that these strings apply// for. Only one set of labels may be set per language.LanguageCodestring `json:"languageCode,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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:"-"`}Label: Label to be used when displaying the price list, section, or item.
func (Label)MarshalJSON¶
typeLatLng¶
type LatLng struct {// Latitude: The latitude in degrees. It must be in the range [-90.0, +90.0].Latitudefloat64 `json:"latitude,omitempty"`// Longitude: The longitude in degrees. It must be in the range [-180.0,// +180.0].Longitudefloat64 `json:"longitude,omitempty"`// ForceSendFields is a list of field names (e.g. "Latitude") 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. "Latitude") 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:"-"`}LatLng: An object that represents a latitude/longitude pair. This isexpressed as a pair of doubles to represent degrees latitude and degreeslongitude. Unless specified otherwise, this object must conform to the WGS84standard. Values must be within normalized ranges.
func (LatLng)MarshalJSON¶
func (*LatLng)UnmarshalJSON¶
typeListAttributeMetadataResponse¶
type ListAttributeMetadataResponse struct {// AttributeMetadata: A collection of attribute metadata for the available// attributes.AttributeMetadata []*AttributeMetadata `json:"attributeMetadata,omitempty"`// NextPageToken: If the number of attributes exceeded the requested page size,// this field will be populated with a token to fetch the next page of// attributes on a subsequent call to `attributes.list`. If there are no more// attributes, this field will not be present in the response.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AttributeMetadata") 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. "AttributeMetadata") 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:"-"`}ListAttributeMetadataResponse: Response forAttributesService.ListAttributeMetadata.
func (ListAttributeMetadataResponse)MarshalJSON¶
func (sListAttributeMetadataResponse) MarshalJSON() ([]byte,error)
typeListCategoriesResponse¶
type ListCategoriesResponse struct {// Categories: The matching categories based on the requested parameters.Categories []*Category `json:"categories,omitempty"`// NextPageToken: If the number of categories exceeded the requested page size,// this field will be populated with a token to fetch the next page of// categories on a subsequent call to `ListCategories`.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Categories") 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. "Categories") 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:"-"`}ListCategoriesResponse: Response message forBusinessCategories.ListCategories.
func (ListCategoriesResponse)MarshalJSON¶
func (sListCategoriesResponse) MarshalJSON() ([]byte,error)
typeListLocationsResponse¶
type ListLocationsResponse struct {// Locations: The locations.Locations []*Location `json:"locations,omitempty"`// NextPageToken: If the number of locations exceeded the requested page size,// this field is populated with a token to fetch the next page of locations on// a subsequent call to `ListLocations`. If there are no more locations, this// field is not present in the response.NextPageTokenstring `json:"nextPageToken,omitempty"`// TotalSize: The approximate number of Locations in the list irrespective of// pagination. This field will only be returned if `filter` is used as a query// parameter.TotalSizeint64 `json:"totalSize,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Locations") 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. "Locations") 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:"-"`}ListLocationsResponse: Response message for Locations.ListLocations.
func (ListLocationsResponse)MarshalJSON¶
func (sListLocationsResponse) MarshalJSON() ([]byte,error)
typeLocation¶
type Location struct {// AdWordsLocationExtensions: Optional. Additional information that is surfaced// in AdWords.AdWordsLocationExtensions *AdWordsLocationExtensions `json:"adWordsLocationExtensions,omitempty"`// Categories: Optional. The different categories that describe the business.Categories *Categories `json:"categories,omitempty"`// Labels: Optional. A collection of free-form strings to allow you to tag your// business. These labels are NOT user facing; only you can see them. Must be// between 1-255 characters per label.Labels []string `json:"labels,omitempty"`// LanguageCode: Immutable. The language of the location. Set during creation// and not updateable.LanguageCodestring `json:"languageCode,omitempty"`// Latlng: Optional. User-provided latitude and longitude. When creating a// location, this field is ignored if the provided address geocodes// successfully. This field is only returned on get requests if the// user-provided `latlng` value was accepted during create, or the `latlng`// value was updated through the Google Business Profile website. This field// can only be updated by approved clients.Latlng *LatLng `json:"latlng,omitempty"`// Metadata: Output only. Additional non-user-editable information.Metadata *Metadata `json:"metadata,omitempty"`// MoreHours: Optional. More hours for a business's different departments or// specific customers.MoreHours []*MoreHours `json:"moreHours,omitempty"`// Name: Google identifier for this location in the form:// `locations/{location_id}`.Namestring `json:"name,omitempty"`// OpenInfo: Optional. A flag that indicates whether the location is currently// open for business.OpenInfo *OpenInfo `json:"openInfo,omitempty"`// PhoneNumbers: Optional. The different phone numbers that customers can use// to get in touch with the business.PhoneNumbers *PhoneNumbers `json:"phoneNumbers,omitempty"`// Profile: Optional. Describes your business in your own voice and shares with// users the unique story of your business and offerings. This field is// required for all categories except lodging categories (e.g. hotels, motels,// inns).Profile *Profile `json:"profile,omitempty"`// RegularHours: Optional. Operating hours for the business.RegularHours *BusinessHours `json:"regularHours,omitempty"`// RelationshipData: Optional. All locations and chain related to this one.RelationshipData *RelationshipData `json:"relationshipData,omitempty"`// ServiceArea: Optional. Service area businesses provide their service at the// customer's location. If this business is a service area business, this field// describes the area(s) serviced by the business.ServiceArea *ServiceAreaBusiness `json:"serviceArea,omitempty"`// ServiceItems: Optional. List of services supported by merchants. A service// can be haircut, install water heater, etc. Duplicated service items will be// removed automatically.ServiceItems []*ServiceItem `json:"serviceItems,omitempty"`// SpecialHours: Optional. Special hours for the business. This typically// includes holiday hours, and other times outside of regular operating hours.// These override regular business hours. This field cannot be set without// regular hours.SpecialHours *SpecialHours `json:"specialHours,omitempty"`// StoreCode: Optional. External identifier for this location, which must be// unique within a given account. This is a means of associating the location// with your own records.StoreCodestring `json:"storeCode,omitempty"`// StorefrontAddress: Optional. A precise, accurate address to describe your// business location. PO boxes or mailboxes located at remote locations are not// acceptable. At this time, you can specify a maximum of five `address_lines`// values in the address. This field should only be set for businesses that// have a storefront. This field should not be set for locations of type// `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.StorefrontAddress *PostalAddress `json:"storefrontAddress,omitempty"`// Title: Required. Location name should reflect your business's real-world// name, as used consistently on your storefront, website, and stationery, and// as known to customers. Any additional information, when relevant, can be// included in other fields of the resource (for example, `Address`,// `Categories`). Don't add unnecessary information to your name (for example,// prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters").// Don't include marketing taglines, store codes, special characters, hours or// closed/open status, phone numbers, website URLs, service/product// information, location/address or directions, or containment information (for// example, "Chase ATM in Duane Reade").Titlestring `json:"title,omitempty"`// WebsiteUri: Optional. A URL for this business. If possible, use a URL that// represents this individual business location instead of a generic// website/URL that represents all locations, or the brand.WebsiteUristring `json:"websiteUri,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AdWordsLocationExtensions")// 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. "AdWordsLocationExtensions") 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:"-"`}Location: A location. See the [help center article](https://support.google.com/business/answer/3038177) for a detaileddescription of these fields, or the category endpoint(/my-business/reference/rest/v4/categories) for a list of valid businesscategories.
func (Location)MarshalJSON¶
typeLocationsAttributesGetGoogleUpdatedCall¶
type LocationsAttributesGetGoogleUpdatedCall struct {// contains filtered or unexported fields}func (*LocationsAttributesGetGoogleUpdatedCall)Context¶
func (c *LocationsAttributesGetGoogleUpdatedCall) Context(ctxcontext.Context) *LocationsAttributesGetGoogleUpdatedCall
Context sets the context to be used in this call's Do method.
func (*LocationsAttributesGetGoogleUpdatedCall)Do¶
func (c *LocationsAttributesGetGoogleUpdatedCall) Do(opts ...googleapi.CallOption) (*Attributes,error)
Do executes the "mybusinessbusinessinformation.locations.attributes.getGoogleUpdated" call.Any non-2xx status code is an error. Response headers are in either*Attributes.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*LocationsAttributesGetGoogleUpdatedCall)Fields¶
func (c *LocationsAttributesGetGoogleUpdatedCall) Fields(s ...googleapi.Field) *LocationsAttributesGetGoogleUpdatedCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*LocationsAttributesGetGoogleUpdatedCall)Header¶
func (c *LocationsAttributesGetGoogleUpdatedCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*LocationsAttributesGetGoogleUpdatedCall)IfNoneMatch¶
func (c *LocationsAttributesGetGoogleUpdatedCall) IfNoneMatch(entityTagstring) *LocationsAttributesGetGoogleUpdatedCall
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.
typeLocationsAttributesService¶
type LocationsAttributesService struct {// contains filtered or unexported fields}funcNewLocationsAttributesService¶
func NewLocationsAttributesService(s *Service) *LocationsAttributesService
func (*LocationsAttributesService)GetGoogleUpdated¶
func (r *LocationsAttributesService) GetGoogleUpdated(nameidstring) *LocationsAttributesGetGoogleUpdatedCall
GetGoogleUpdated: Gets the Google-updated version of the specified location.
- name: Google identifier for this location in the form of`locations/{location_id}/attributes`.
typeLocationsDeleteCall¶
type LocationsDeleteCall struct {// contains filtered or unexported fields}func (*LocationsDeleteCall)Context¶
func (c *LocationsDeleteCall) Context(ctxcontext.Context) *LocationsDeleteCall
Context sets the context to be used in this call's Do method.
func (*LocationsDeleteCall)Do¶
func (c *LocationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty,error)
Do executes the "mybusinessbusinessinformation.locations.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*LocationsDeleteCall)Fields¶
func (c *LocationsDeleteCall) Fields(s ...googleapi.Field) *LocationsDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*LocationsDeleteCall)Header¶
func (c *LocationsDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeLocationsGetAttributesCall¶
type LocationsGetAttributesCall struct {// contains filtered or unexported fields}func (*LocationsGetAttributesCall)Context¶
func (c *LocationsGetAttributesCall) Context(ctxcontext.Context) *LocationsGetAttributesCall
Context sets the context to be used in this call's Do method.
func (*LocationsGetAttributesCall)Do¶
func (c *LocationsGetAttributesCall) Do(opts ...googleapi.CallOption) (*Attributes,error)
Do executes the "mybusinessbusinessinformation.locations.getAttributes" call.Any non-2xx status code is an error. Response headers are in either*Attributes.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*LocationsGetAttributesCall)Fields¶
func (c *LocationsGetAttributesCall) Fields(s ...googleapi.Field) *LocationsGetAttributesCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*LocationsGetAttributesCall)Header¶
func (c *LocationsGetAttributesCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*LocationsGetAttributesCall)IfNoneMatch¶
func (c *LocationsGetAttributesCall) IfNoneMatch(entityTagstring) *LocationsGetAttributesCall
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.
typeLocationsGetCall¶
type LocationsGetCall struct {// contains filtered or unexported fields}func (*LocationsGetCall)Context¶
func (c *LocationsGetCall) Context(ctxcontext.Context) *LocationsGetCall
Context sets the context to be used in this call's Do method.
func (*LocationsGetCall)Do¶
func (c *LocationsGetCall) Do(opts ...googleapi.CallOption) (*Location,error)
Do executes the "mybusinessbusinessinformation.locations.get" call.Any non-2xx status code is an error. Response headers are in either*Location.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*LocationsGetCall)Fields¶
func (c *LocationsGetCall) Fields(s ...googleapi.Field) *LocationsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*LocationsGetCall)Header¶
func (c *LocationsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*LocationsGetCall)IfNoneMatch¶
func (c *LocationsGetCall) IfNoneMatch(entityTagstring) *LocationsGetCall
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 (*LocationsGetCall)ReadMask¶
func (c *LocationsGetCall) ReadMask(readMaskstring) *LocationsGetCall
ReadMask sets the optional parameter "readMask": Required. Read mask tospecify what fields will be returned in the response.
typeLocationsGetGoogleUpdatedCall¶
type LocationsGetGoogleUpdatedCall struct {// contains filtered or unexported fields}func (*LocationsGetGoogleUpdatedCall)Context¶
func (c *LocationsGetGoogleUpdatedCall) Context(ctxcontext.Context) *LocationsGetGoogleUpdatedCall
Context sets the context to be used in this call's Do method.
func (*LocationsGetGoogleUpdatedCall)Do¶
func (c *LocationsGetGoogleUpdatedCall) Do(opts ...googleapi.CallOption) (*GoogleUpdatedLocation,error)
Do executes the "mybusinessbusinessinformation.locations.getGoogleUpdated" call.Any non-2xx status code is an error. Response headers are in either*GoogleUpdatedLocation.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*LocationsGetGoogleUpdatedCall)Fields¶
func (c *LocationsGetGoogleUpdatedCall) Fields(s ...googleapi.Field) *LocationsGetGoogleUpdatedCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*LocationsGetGoogleUpdatedCall)Header¶
func (c *LocationsGetGoogleUpdatedCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*LocationsGetGoogleUpdatedCall)IfNoneMatch¶
func (c *LocationsGetGoogleUpdatedCall) IfNoneMatch(entityTagstring) *LocationsGetGoogleUpdatedCall
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 (*LocationsGetGoogleUpdatedCall)ReadMask¶
func (c *LocationsGetGoogleUpdatedCall) ReadMask(readMaskstring) *LocationsGetGoogleUpdatedCall
ReadMask sets the optional parameter "readMask": Required. Read mask tospecify what fields will be returned in the response.
typeLocationsPatchCall¶
type LocationsPatchCall struct {// contains filtered or unexported fields}func (*LocationsPatchCall)Context¶
func (c *LocationsPatchCall) Context(ctxcontext.Context) *LocationsPatchCall
Context sets the context to be used in this call's Do method.
func (*LocationsPatchCall)Do¶
func (c *LocationsPatchCall) Do(opts ...googleapi.CallOption) (*Location,error)
Do executes the "mybusinessbusinessinformation.locations.patch" call.Any non-2xx status code is an error. Response headers are in either*Location.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*LocationsPatchCall)Fields¶
func (c *LocationsPatchCall) Fields(s ...googleapi.Field) *LocationsPatchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*LocationsPatchCall)Header¶
func (c *LocationsPatchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*LocationsPatchCall)UpdateMask¶
func (c *LocationsPatchCall) UpdateMask(updateMaskstring) *LocationsPatchCall
UpdateMask sets the optional parameter "updateMask": Required. The specificfields to update.
func (*LocationsPatchCall)ValidateOnly¶
func (c *LocationsPatchCall) ValidateOnly(validateOnlybool) *LocationsPatchCall
ValidateOnly sets the optional parameter "validateOnly": If true, therequest is validated without actually updating the location. When this fieldis set, we will only return validation errors if there were any. Theresponse will be empty if no errors were found.
typeLocationsService¶
type LocationsService struct {Attributes *LocationsAttributesService// contains filtered or unexported fields}funcNewLocationsService¶
func NewLocationsService(s *Service) *LocationsService
func (*LocationsService)Delete¶
func (r *LocationsService) Delete(namestring) *LocationsDeleteCall
Delete: Deletes a location. If this location cannot be deleted using the APIand it is marked so in the`google.mybusiness.businessinformation.v1.LocationState`, use the GoogleBusiness Profile (https://business.google.com/manage/) website.
- name: The name of the location to delete.
func (*LocationsService)Get¶
func (r *LocationsService) Get(namestring) *LocationsGetCall
Get: Returns the specified location.
- name: The name of the location to fetch.
func (*LocationsService)GetAttributes¶
func (r *LocationsService) GetAttributes(nameidstring) *LocationsGetAttributesCall
GetAttributes: Looks up all the attributes set for a given location.
- name: Google identifier for this location in the form of`locations/{location_id}/attributes`.
func (*LocationsService)GetGoogleUpdated¶
func (r *LocationsService) GetGoogleUpdated(namestring) *LocationsGetGoogleUpdatedCall
GetGoogleUpdated: Gets the Google-updated version of the specified location.
- name: The name of the location to fetch.
func (*LocationsService)Patch¶
func (r *LocationsService) Patch(nameidstring, location *Location) *LocationsPatchCall
Patch: Updates the specified location.
- name: Google identifier for this location in the form:`locations/{location_id}`.
func (*LocationsService)UpdateAttributes¶
func (r *LocationsService) UpdateAttributes(nameidstring, attributes *Attributes) *LocationsUpdateAttributesCall
UpdateAttributes: Update attributes for a given location.
- name: Google identifier for this location in the form of`locations/{location_id}/attributes`.
typeLocationsUpdateAttributesCall¶
type LocationsUpdateAttributesCall struct {// contains filtered or unexported fields}func (*LocationsUpdateAttributesCall)AttributeMask¶
func (c *LocationsUpdateAttributesCall) AttributeMask(attributeMaskstring) *LocationsUpdateAttributesCall
AttributeMask sets the optional parameter "attributeMask": Required.Attribute name of attributes that you'd like to update. Represented by`attributes/{attribute}`. Updates: All attributes provided in the attributesfield that you would like to update must be set in the `attribute_mask`.Attributes set in the above list but not in the `attribute_mask` will beignored. Deletes: If you'd like to delete certain attributes, they must bespecified in the `attribute_mask` with no matching entry in the attributeslist. If you'd like to delete all attributes set on a location, you shouldlook up all the applicable attributes for the location and then add them tothe `attribute_mask` with an empty attributes field.
func (*LocationsUpdateAttributesCall)Context¶
func (c *LocationsUpdateAttributesCall) Context(ctxcontext.Context) *LocationsUpdateAttributesCall
Context sets the context to be used in this call's Do method.
func (*LocationsUpdateAttributesCall)Do¶
func (c *LocationsUpdateAttributesCall) Do(opts ...googleapi.CallOption) (*Attributes,error)
Do executes the "mybusinessbusinessinformation.locations.updateAttributes" call.Any non-2xx status code is an error. Response headers are in either*Attributes.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*LocationsUpdateAttributesCall)Fields¶
func (c *LocationsUpdateAttributesCall) Fields(s ...googleapi.Field) *LocationsUpdateAttributesCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*LocationsUpdateAttributesCall)Header¶
func (c *LocationsUpdateAttributesCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeMetadata¶
type Metadata struct {// CanDelete: Output only. Indicates whether the location can be deleted using// the API.CanDeletebool `json:"canDelete,omitempty"`// CanHaveBusinessCalls: Output only. Indicates if the listing is eligible for// business calls.CanHaveBusinessCallsbool `json:"canHaveBusinessCalls,omitempty"`// CanHaveFoodMenus: Output only. Indicates if the listing is eligible for food// menu.CanHaveFoodMenusbool `json:"canHaveFoodMenus,omitempty"`// CanModifyServiceList: Output only. Indicates if the listing can modify the// service list.CanModifyServiceListbool `json:"canModifyServiceList,omitempty"`// CanOperateHealthData: Output only. Indicates whether the location can// operate on Health data.CanOperateHealthDatabool `json:"canOperateHealthData,omitempty"`// CanOperateLocalPost: Output only. Indicates if the listing can manage local// posts. Deprecated: This field is no longer populated and will be removed in// a future version.CanOperateLocalPostbool `json:"canOperateLocalPost,omitempty"`// CanOperateLodgingData: Output only. Indicates whether the location can// operate on Lodging data.CanOperateLodgingDatabool `json:"canOperateLodgingData,omitempty"`// DuplicateLocation: Output only. The location resource that this location// duplicates.DuplicateLocationstring `json:"duplicateLocation,omitempty"`// HasGoogleUpdated: Output only. Indicates whether the place ID associated// with this location has updates that need to be updated or rejected by the// client. If this boolean is set, you should call the `getGoogleUpdated`// method to lookup information that's needs to be verified.HasGoogleUpdatedbool `json:"hasGoogleUpdated,omitempty"`// HasPendingEdits: Output only. Indicates whether any of this Location's// properties are in the edit pending state.HasPendingEditsbool `json:"hasPendingEdits,omitempty"`// HasVoiceOfMerchant: Output only. Indicates if the listing has Voice of// Merchant. If this boolean is false, you should call the// locations.getVoiceOfMerchantState API to get details as to why they do not// have Voice of Merchant.HasVoiceOfMerchantbool `json:"hasVoiceOfMerchant,omitempty"`// IsParticularlyPersonalPlace: Output only.IsParticularlyPersonalPlacebool `json:"isParticularlyPersonalPlace,omitempty"`// MapsUri: Output only. A link to the location on Maps.MapsUristring `json:"mapsUri,omitempty"`// NewReviewUri: Output only. A link to the page on Google Search where a// customer can leave a review for the location.NewReviewUristring `json:"newReviewUri,omitempty"`// PlaceId: Output only. If this locationappears on Google Maps, this field is// populated with the place ID for the location. This ID can be used in various// Places APIs. This field can be set during Create calls, but not for Update.PlaceIdstring `json:"placeId,omitempty"`// ForceSendFields is a list of field names (e.g. "CanDelete") 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. "CanDelete") 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:"-"`}Metadata: Additional non-user-editable information about the location.
func (Metadata)MarshalJSON¶
typeMoney¶
type Money struct {// CurrencyCode: The three-letter currency code defined in ISO 4217.CurrencyCodestring `json:"currencyCode,omitempty"`// Nanos: Number of nano (10^-9) units of the amount. The value must be between// -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos`// must be positive or zero. If `units` is zero, `nanos` can be positive, zero,// or negative. If `units` is negative, `nanos` must be negative or zero. For// example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.Nanosint64 `json:"nanos,omitempty"`// Units: The whole units of the amount. For example if `currencyCode` is// "USD", then 1 unit is one US dollar.Unitsint64 `json:"units,omitempty,string"`// ForceSendFields is a list of field names (e.g. "CurrencyCode") 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. "CurrencyCode") 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:"-"`}Money: Represents an amount of money with its currency type.
func (Money)MarshalJSON¶
typeMoreHours¶
type MoreHours struct {// HoursTypeId: Required. Type of hours. Clients should call {#link// businessCategories:BatchGet} to get supported hours types for categories of// their locations.HoursTypeIdstring `json:"hoursTypeId,omitempty"`// Periods: Required. A collection of times that this location is open. Each// period represents a range of hours when the location is open during the// week.Periods []*TimePeriod `json:"periods,omitempty"`// ForceSendFields is a list of field names (e.g. "HoursTypeId") 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. "HoursTypeId") 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:"-"`}MoreHours: The time periods during which a location is open for certaintypes of business.
func (MoreHours)MarshalJSON¶
typeMoreHoursType¶
type MoreHoursType struct {// DisplayName: Output only. The human-readable English display name for the// hours type.DisplayNamestring `json:"displayName,omitempty"`// HoursTypeId: Output only. A stable ID provided by Google for this hours// type.HoursTypeIdstring `json:"hoursTypeId,omitempty"`// LocalizedDisplayName: Output only. The human-readable localized display name// for the hours type.LocalizedDisplayNamestring `json:"localizedDisplayName,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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:"-"`}MoreHoursType: More hours types that a business can offers, in addition toits regular hours.
func (MoreHoursType)MarshalJSON¶
func (sMoreHoursType) MarshalJSON() ([]byte,error)
typeOpenInfo¶
type OpenInfo struct {// CanReopen: Output only. Indicates whether this business is eligible for// re-open.CanReopenbool `json:"canReopen,omitempty"`// OpeningDate: Optional. The date on which the location first opened. If the// exact day is not known, month and year only can be provided. The date must// be in the past or be no more than one year in the future.OpeningDate *Date `json:"openingDate,omitempty"`// Status: Required. Indicates whether or not the Location is currently open// for business. All locations are open by default, unless updated to be// closed.//// Possible values:// "OPEN_FOR_BUSINESS_UNSPECIFIED" - Not specified.// "OPEN" - Indicates that the location is open.// "CLOSED_PERMANENTLY" - Indicates that the location has been permanently// closed.// "CLOSED_TEMPORARILY" - Indicates that the location has been temporarily// closed.Statusstring `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "CanReopen") 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. "CanReopen") 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:"-"`}OpenInfo: Information related to the opening state of the business.
func (OpenInfo)MarshalJSON¶
typePhoneNumbers¶
type PhoneNumbers struct {// AdditionalPhones: Optional. Up to two phone numbers (mobile or landline, no// fax) at which your business can be called, in addition to your primary phone// number.AdditionalPhones []string `json:"additionalPhones,omitempty"`// PrimaryPhone: Required. A phone number that connects to your individual// business location as directly as possible. Use a local phone number instead// of a central, call center helpline number whenever possible.PrimaryPhonestring `json:"primaryPhone,omitempty"`// ForceSendFields is a list of field names (e.g. "AdditionalPhones") 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. "AdditionalPhones") 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:"-"`}PhoneNumbers: A collection of phone numbers for the business. Duringupdates, both fields must be set. Clients may not update just the primary oradditional phone numbers using the update mask. International phone formatis preferred, such as "+1 415 555 0132", see more in(https://developers.google.com/style/phone-numbers#international-phone-numbers).
func (PhoneNumbers)MarshalJSON¶
func (sPhoneNumbers) MarshalJSON() ([]byte,error)
typePlaceInfo¶
type PlaceInfo struct {// PlaceId: Required. The ID of the place. Must correspond to a region.// (https://developers.google.com/places/web-service/supported_types#table3)PlaceIdstring `json:"placeId,omitempty"`// PlaceName: Required. The localized name of the place. For example,// `Scottsdale, AZ`.PlaceNamestring `json:"placeName,omitempty"`// ForceSendFields is a list of field names (e.g. "PlaceId") 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. "PlaceId") 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:"-"`}PlaceInfo: Defines an area that's represented by a place ID.
func (PlaceInfo)MarshalJSON¶
typePlaces¶
type Places struct {// PlaceInfos: The areas represented by place IDs. Limited to a maximum of 20// places.PlaceInfos []*PlaceInfo `json:"placeInfos,omitempty"`// ForceSendFields is a list of field names (e.g. "PlaceInfos") 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. "PlaceInfos") 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:"-"`}Places: Defines the union of areas represented by a set of places.
func (Places)MarshalJSON¶
typePostalAddress¶
type PostalAddress struct {// AddressLines: Unstructured address lines describing the lower levels of an// address. Because values in `address_lines` do not have type information and// may sometimes contain multiple values in a single field (for example,// "Austin, TX"), it is important that the line order is clear. The order of// address lines should be "envelope order" for the country or region of the// address. In places where this can vary (for example, Japan),// `address_language` is used to make it explicit (for example, "ja" for// large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this// way, the most specific line of an address can be selected based on the// language. The minimum permitted structural representation of an address// consists of a `region_code` with all remaining information placed in the// `address_lines`. It would be possible to format such an address very// approximately without geocoding, but no semantic reasoning could be made// about any of the address components until it was at least partially// resolved. Creating an address only containing a `region_code` and// `address_lines` and then geocoding is the recommended way to handle// completely unstructured addresses (as opposed to guessing which parts of the// address should be localities or administrative areas).AddressLines []string `json:"addressLines,omitempty"`// AdministrativeArea: Optional. Highest administrative subdivision which is// used for postal addresses of a country or region. For example, this can be a// state, a province, an oblast, or a prefecture. For Spain, this is the// province and not the autonomous community (for example, "Barcelona" and not// "Catalonia"). Many countries don't use an administrative area in postal// addresses. For example, in Switzerland, this should be left unpopulated.AdministrativeAreastring `json:"administrativeArea,omitempty"`// LanguageCode: Optional. BCP-47 language code of the contents of this address// (if known). This is often the UI language of the input form or is expected// to match one of the languages used in the address' country/region, or their// transliterated equivalents. This can affect formatting in certain countries,// but is not critical to the correctness of the data and will never affect any// validation or other non-formatting related operations. If this value is not// known, it should be omitted (rather than specifying a possibly incorrect// default). Examples: "zh-Hant", "ja", "ja-Latn", "en".LanguageCodestring `json:"languageCode,omitempty"`// Locality: Optional. Generally refers to the city or town portion of the// address. Examples: US city, IT comune, UK post town. In regions of the world// where localities are not well defined or do not fit into this structure// well, leave `locality` empty and use `address_lines`.Localitystring `json:"locality,omitempty"`// Organization: Optional. The name of the organization at the address.Organizationstring `json:"organization,omitempty"`// PostalCode: Optional. Postal code of the address. Not all countries use or// require postal codes to be present, but where they are used, they may// trigger additional validation with other parts of the address (for example,// state or zip code validation in the United States).PostalCodestring `json:"postalCode,omitempty"`// Recipients: Optional. The recipient at the address. This field may, under// certain circumstances, contain multiline information. For example, it might// contain "care of" information.Recipients []string `json:"recipients,omitempty"`// RegionCode: Required. CLDR region code of the country/region of the address.// This is never inferred and it is up to the user to ensure the value is// correct. Seehttps://cldr.unicode.org/ and//https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html// for details. Example: "CH" for Switzerland.RegionCodestring `json:"regionCode,omitempty"`// Revision: The schema revision of the `PostalAddress`. This must be set to 0,// which is the latest revision. All new revisions **must** be backward// compatible with old revisions.Revisionint64 `json:"revision,omitempty"`// SortingCode: Optional. Additional, country-specific, sorting code. This is// not used in most regions. Where it is used, the value is either a string// like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or// just a number alone, representing the "sector code" (Jamaica), "delivery// area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).SortingCodestring `json:"sortingCode,omitempty"`// Sublocality: Optional. Sublocality of the address. For example, this can be// a neighborhood, borough, or district.Sublocalitystring `json:"sublocality,omitempty"`// ForceSendFields is a list of field names (e.g. "AddressLines") 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. "AddressLines") 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:"-"`}PostalAddress: Represents a postal address, such as for postal delivery orpayments addresses. With a postal address, a postal service can deliveritems to a premise, P.O. box, or similar. A postal address is not intendedto model geographical locations like roads, towns, or mountains. In typicalusage, an address would be created by user input or from importing existingdata, depending on the type of process. Advice on address input or editing:- Use an internationalization-ready address widget such ashttps://github.com/google/libaddressinput. - Users should not be presentedwith UI elements for input or editing of fields outside countries where thatfield is used. For more guidance on how to use this schema, see:https://support.google.com/business/answer/6397478.
func (PostalAddress)MarshalJSON¶
func (sPostalAddress) MarshalJSON() ([]byte,error)
typeProfile¶
type Profile struct {// Description: Required. Description of the location in your own voice, not// editable by anyone else.Descriptionstring `json:"description,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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:"-"`}Profile: All information pertaining to the location's profile.
func (Profile)MarshalJSON¶
typeRelationshipData¶
type RelationshipData struct {// ChildrenLocations: The list of children locations that this location has// relations with.ChildrenLocations []*RelevantLocation `json:"childrenLocations,omitempty"`// ParentChain: The resource name of the Chain that this location is member of.// How to find Chain IDParentChainstring `json:"parentChain,omitempty"`// ParentLocation: The parent location that this location has relations with.ParentLocation *RelevantLocation `json:"parentLocation,omitempty"`// ForceSendFields is a list of field names (e.g. "ChildrenLocations") 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. "ChildrenLocations") 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:"-"`}RelationshipData: Information of all parent and children locations relatedto this one.
func (RelationshipData)MarshalJSON¶
func (sRelationshipData) MarshalJSON() ([]byte,error)
typeRelevantLocation¶
type RelevantLocation struct {// PlaceId: Required. Specify the location that is on the other side of the// relation by its placeID.PlaceIdstring `json:"placeId,omitempty"`// RelationType: Required. The type of the relationship.//// Possible values:// "RELATION_TYPE_UNSPECIFIED" - Type unspecified.// "DEPARTMENT_OF" - This represents a relation between 2 locations which// share one physical area, same brand/upper management/organization, but with// different key attributes like store hours or phone numbers. For example,// Costco Pharmacy is a department in Costco Wholesale.// "INDEPENDENT_ESTABLISHMENT_IN" - This represents the cases where 2// locations are co-located in the same physical location, but from different// companies (e.g. Starbucks in a Safeway, shops in a mall).RelationTypestring `json:"relationType,omitempty"`// ForceSendFields is a list of field names (e.g. "PlaceId") 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. "PlaceId") 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:"-"`}RelevantLocation: Information about another location that is related tocurrent one. The relation can be any one of DEPARTMENT_OF orINDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be oneither side (parent/child) of the location.
func (RelevantLocation)MarshalJSON¶
func (sRelevantLocation) MarshalJSON() ([]byte,error)
typeRepeatedEnumAttributeValue¶
type RepeatedEnumAttributeValue struct {// SetValues: Enum values that are set.SetValues []string `json:"setValues,omitempty"`// UnsetValues: Enum values that are unset.UnsetValues []string `json:"unsetValues,omitempty"`// ForceSendFields is a list of field names (e.g. "SetValues") 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. "SetValues") 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:"-"`}RepeatedEnumAttributeValue: Values for an attribute with a `value_type` ofREPEATED_ENUM. This consists of two lists of value IDs: those that are set(true) and those that are unset (false). Values absent are consideredunknown. At least one value must be specified.
func (RepeatedEnumAttributeValue)MarshalJSON¶
func (sRepeatedEnumAttributeValue) MarshalJSON() ([]byte,error)
typeSearchChainsResponse¶
type SearchChainsResponse struct {// Chains: Chains that match the queried chain_display_name in// SearchChainsRequest. If there are no matches, this field will be empty.// Results are listed in order of relevance.Chains []*Chain `json:"chains,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Chains") 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. "Chains") 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:"-"`}SearchChainsResponse: Response message for Locations.SearchChains.
func (SearchChainsResponse)MarshalJSON¶
func (sSearchChainsResponse) MarshalJSON() ([]byte,error)
typeSearchGoogleLocationsRequest¶
type SearchGoogleLocationsRequest struct {// Location: Location to search for. If provided, will find locations which// match the provided location details, which must include a value for the// title.Location *Location `json:"location,omitempty"`// PageSize: The number of matches to return. The default value is 3, with a// maximum of 10. Note that latency may increase if more are requested. There// is no pagination.PageSizeint64 `json:"pageSize,omitempty"`// Query: Text query to search for. The search results from a query string will// be less accurate than if providing an exact location, but can provide more// inexact matches.Querystring `json:"query,omitempty"`// ForceSendFields is a list of field names (e.g. "Location") 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. "Location") 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:"-"`}SearchGoogleLocationsRequest: Request message forGoogleLocations.SearchGoogleLocations.
func (SearchGoogleLocationsRequest)MarshalJSON¶
func (sSearchGoogleLocationsRequest) MarshalJSON() ([]byte,error)
typeSearchGoogleLocationsResponse¶
type SearchGoogleLocationsResponse struct {// GoogleLocations: A collection of GoogleLocations that are potential matches// to the specified request, listed in order from most to least accuracy.GoogleLocations []*GoogleLocation `json:"googleLocations,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "GoogleLocations") 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. "GoogleLocations") 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:"-"`}SearchGoogleLocationsResponse: Response message forGoogleLocations.SearchGoogleLocations.
func (SearchGoogleLocationsResponse)MarshalJSON¶
func (sSearchGoogleLocationsResponse) MarshalJSON() ([]byte,error)
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentAccounts *AccountsServiceAttributes *AttributesServiceCategories *CategoriesServiceChains *ChainsServiceGoogleLocations *GoogleLocationsServiceLocations *LocationsService// contains filtered or unexported fields} funcNewdeprecated
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¶
NewService creates a new Service.
typeServiceAreaBusiness¶
type ServiceAreaBusiness struct {// BusinessType: Required. Indicates the type of the service area business.//// Possible values:// "BUSINESS_TYPE_UNSPECIFIED" - Output only. Not specified.// "CUSTOMER_LOCATION_ONLY" - Offers service only in the surrounding area// (not at the business address). If a business is being updated from a// CUSTOMER_AND_BUSINESS_LOCATION to a CUSTOMER_LOCATION_ONLY, the location// update must include field mask `storefront_address` and set the field to// empty.// "CUSTOMER_AND_BUSINESS_LOCATION" - Offers service at the business address// and the surrounding area.BusinessTypestring `json:"businessType,omitempty"`// Places: The area that this business serves defined through a set of places.Places *Places `json:"places,omitempty"`// RegionCode: Immutable. CLDR region code of the country/region that this// service area business is based in. Seehttp://cldr.unicode.org/ and//http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html// for details. Example: "CH" for Switzerland. This field is required for// CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region// specified here can be different from regions for the areas that this// business serves (e.g. service area businesses that provide services in// regions other than the one that they are based in). If this location// requires verification after creation, the address provided for verification// purposes *must* be located within this region, and the business owner or// their authorized representative *must* be able to receive postal mail at the// provided verification address.RegionCodestring `json:"regionCode,omitempty"`// ForceSendFields is a list of field names (e.g. "BusinessType") 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. "BusinessType") 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:"-"`}ServiceAreaBusiness: Service area businesses provide their service at thecustomer's location (for example, a locksmith or plumber).
func (ServiceAreaBusiness)MarshalJSON¶
func (sServiceAreaBusiness) MarshalJSON() ([]byte,error)
typeServiceItem¶
type ServiceItem struct {// FreeFormServiceItem: Optional. This field will be set case of free-form// services data.FreeFormServiceItem *FreeFormServiceItem `json:"freeFormServiceItem,omitempty"`// Price: Optional. Represents the monetary price of the service item. We// recommend that currency_code and units should be set when including a price.// This will be treated as a fixed price for the service item.Price *Money `json:"price,omitempty"`// StructuredServiceItem: Optional. This field will be set case of structured// services data.StructuredServiceItem *StructuredServiceItem `json:"structuredServiceItem,omitempty"`// ForceSendFields is a list of field names (e.g. "FreeFormServiceItem") 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. "FreeFormServiceItem") 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:"-"`}ServiceItem: A message that describes a single service item. It is used todescribe the type of service that the merchant provides. For example,haircut can be a service.
func (ServiceItem)MarshalJSON¶
func (sServiceItem) MarshalJSON() ([]byte,error)
typeServiceType¶
type ServiceType struct {// DisplayName: Output only. The human-readable display name for the service// type.DisplayNamestring `json:"displayName,omitempty"`// ServiceTypeId: Output only. A stable ID (provided by Google) for this// service type.ServiceTypeIdstring `json:"serviceTypeId,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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:"-"`}ServiceType: A message describing a service type that the business offers.
func (ServiceType)MarshalJSON¶
func (sServiceType) MarshalJSON() ([]byte,error)
typeSpecialHourPeriod¶
type SpecialHourPeriod struct {// CloseTime: Optional. Valid values are 00:00-24:00, where 24:00 represents// midnight at the end of the specified day field. Must be specified if// `closed` is false.CloseTime *TimeOfDay `json:"closeTime,omitempty"`// Closed: Optional. If true, `end_date`, `open_time`, and `close_time` are// ignored, and the date specified in `start_date` is treated as the location// being closed for the entire day.Closedbool `json:"closed,omitempty"`// EndDate: Optional. The calendar date this special hour period ends on. If// `end_date` field is not set, default to the date specified in `start_date`.// If set, this field must be equal to or at most 1 day after `start_date`.EndDate *Date `json:"endDate,omitempty"`// OpenTime: Optional. Valid values are 00:00-24:00 where 24:00 represents// midnight at the end of the specified day field. Must be specified if// `closed` is false.OpenTime *TimeOfDay `json:"openTime,omitempty"`// StartDate: Required. The calendar date this special hour period starts on.StartDate *Date `json:"startDate,omitempty"`// ForceSendFields is a list of field names (e.g. "CloseTime") 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. "CloseTime") 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:"-"`}SpecialHourPeriod: Represents a single time period when a location'soperational hours differ from its normal business hours. A special hourperiod must represent a range of less than 24 hours. The `open_time` and`start_date` must predate the `close_time` and `end_date`. The `close_time`and `end_date` can extend to 11:59 a.m. on the day after the specified`start_date`. For example, the following inputs are valid:start_date=2015-11-23, open_time=08:00, close_time=18:00start_date=2015-11-23, end_date=2015-11-23, open_time=08:00,close_time=18:00 start_date=2015-11-23, end_date=2015-11-24,open_time=13:00, close_time=11:59 The following inputs are not valid:start_date=2015-11-23, open_time=13:00, close_time=11:59start_date=2015-11-23, end_date=2015-11-24, open_time=13:00,close_time=12:00 start_date=2015-11-23, end_date=2015-11-25,open_time=08:00, close_time=18:00
func (SpecialHourPeriod)MarshalJSON¶
func (sSpecialHourPeriod) MarshalJSON() ([]byte,error)
typeSpecialHours¶
type SpecialHours struct {// SpecialHourPeriods: Required. A list of exceptions to the business's regular// hours.SpecialHourPeriods []*SpecialHourPeriod `json:"specialHourPeriods,omitempty"`// ForceSendFields is a list of field names (e.g. "SpecialHourPeriods") 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. "SpecialHourPeriods") 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:"-"`}SpecialHours: Represents a set of time periods when a location's operationalhours differ from its normal business hours.
func (SpecialHours)MarshalJSON¶
func (sSpecialHours) MarshalJSON() ([]byte,error)
typeStructuredServiceItem¶
type StructuredServiceItem struct {// Description: Optional. Description of structured service item. The character// limit is 300.Descriptionstring `json:"description,omitempty"`// ServiceTypeId: Required. The `service_type_id` field is a Google provided// unique ID that can be found in `ServiceType`. This information is provided// by `BatchGetCategories` rpc service.ServiceTypeIdstring `json:"serviceTypeId,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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:"-"`}StructuredServiceItem: Represents a structured service offered by themerchant. For eg: toilet_installation.
func (StructuredServiceItem)MarshalJSON¶
func (sStructuredServiceItem) MarshalJSON() ([]byte,error)
typeTimeOfDay¶
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)MarshalJSON¶
typeTimePeriod¶
type TimePeriod struct {// CloseDay: Required. Indicates the day of the week this period ends on.//// 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" - SundayCloseDaystring `json:"closeDay,omitempty"`// CloseTime: Required. Valid values are 00:00-24:00, where 24:00 represents// midnight at the end of the specified day field.CloseTime *TimeOfDay `json:"closeTime,omitempty"`// OpenDay: Required. Indicates the day of the week this period starts on.//// 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" - SundayOpenDaystring `json:"openDay,omitempty"`// OpenTime: Required. Valid values are 00:00-24:00, where 24:00 represents// midnight at the end of the specified day field.OpenTime *TimeOfDay `json:"openTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CloseDay") 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. "CloseDay") 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:"-"`}TimePeriod: Represents a span of time that the business is open, starting onthe specified open day/time and closing on the specified close day/time. Theclosing time must occur after the opening time, for example later in thesame day, or on a subsequent day.
func (TimePeriod)MarshalJSON¶
func (sTimePeriod) MarshalJSON() ([]byte,error)
typeUriAttributeValue¶
type UriAttributeValue struct {// Uri: Required. The proposed URI value for this attribute.Uristring `json:"uri,omitempty"`// ForceSendFields is a list of field names (e.g. "Uri") 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. "Uri") 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:"-"`}UriAttributeValue: Values for an attribute with a `value_type` of URL.
func (UriAttributeValue)MarshalJSON¶
func (sUriAttributeValue) MarshalJSON() ([]byte,error)