mybusinessnotifications

package
v0.204.0 Latest Latest
Warning

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

 Go to latest Published: Oct 31, 2024 License: BSD-3-Clause Imports: 16 Imported by: 1

Documentation

Overview

Package mybusinessnotifications provides access to the My Business Notifications API.

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

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/mybusinessnotifications/v1"
...
ctx := context.Background()
mybusinessnotificationsService, err := mybusinessnotifications.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

mybusinessnotificationsService, err := mybusinessnotifications.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

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

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountsGetNotificationSettingCall 

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

func (*AccountsGetNotificationSettingCall) Context 

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

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

func (*AccountsGetNotificationSettingCall) Do 

func (c *AccountsGetNotificationSettingCall) Do(opts ...googleapi.CallOption) (*NotificationSetting, error)

Do executes the "mybusinessnotifications.accounts.getNotificationSetting" call. Any non-2xx status code is an error. Response headers are in either *NotificationSetting.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsGetNotificationSettingCall) Fields 

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

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

func (*AccountsGetNotificationSettingCall) Header 

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

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

func (*AccountsGetNotificationSettingCall) IfNoneMatch 

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

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

type AccountsService 

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

func NewAccountsService 

func NewAccountsService(s *Service) *AccountsService

func (*AccountsService) GetNotificationSetting 

func (r *AccountsService) GetNotificationSetting(name string) *AccountsGetNotificationSettingCall

GetNotificationSetting: Returns the pubsub notification settings for the account.

  • name: The resource name of the notification setting we are trying to fetch.

func (*AccountsService) UpdateNotificationSetting 

func (r *AccountsService) UpdateNotificationSetting(name string, notificationsetting *NotificationSetting) *AccountsUpdateNotificationSettingCall

UpdateNotificationSetting: Sets the pubsub notification setting for the account informing Google which topic to send pubsub notifications for. Use the notification_types field within notification_setting to manipulate the events an account wants to subscribe to. An account will only have one notification setting resource, and only one pubsub topic can be set. To delete the setting, update with an empty notification_types

  • name: The resource name this setting is for. This is of the form `accounts/{account_id}/notificationSetting`.

type AccountsUpdateNotificationSettingCall 

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

func (*AccountsUpdateNotificationSettingCall) Context 

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

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

func (*AccountsUpdateNotificationSettingCall) Do 

func (c *AccountsUpdateNotificationSettingCall) Do(opts ...googleapi.CallOption) (*NotificationSetting, error)

Do executes the "mybusinessnotifications.accounts.updateNotificationSetting" call. Any non-2xx status code is an error. Response headers are in either *NotificationSetting.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsUpdateNotificationSettingCall) Fields 

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

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

func (*AccountsUpdateNotificationSettingCall) Header 

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

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

func (*AccountsUpdateNotificationSettingCall) UpdateMask 

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

UpdateMask sets the optional parameter "updateMask": Required. The specific fields that should be updated. The only editable field is notification_setting.

type NotificationSetting 

type NotificationSetting struct {
	// Name: Required. The resource name this setting is for. This is of the form
	// `accounts/{account_id}/notificationSetting`.
	Name string `json:"name,omitempty"`
	// NotificationTypes: The types of notifications that will be sent to the
	// Pub/Sub topic. To stop receiving notifications entirely, use
	// NotificationSettings.UpdateNotificationSetting with an empty
	// notification_types or set the pubsub_topic to an empty string.
	//
	// Possible values:
	//   "NOTIFICATION_TYPE_UNSPECIFIED" - No notification type. Will not match any
	// notifications.
	//   "GOOGLE_UPDATE" - The location has Google updates for review. The
	// location_name field on the notification will provide the resource name of
	// the location with Google updates.
	//   "NEW_REVIEW" - A new review has been added to the location. The
	// review_name field on the notification will provide the resource name of the
	// review that was added, and location_name will have the location's resource
	// name.
	//   "UPDATED_REVIEW" - A review on the location has been updated. The
	// review_name field on the notification will provide the resource name of the
	// review that was added, and location_name will have the location's resource
	// name.
	//   "NEW_CUSTOMER_MEDIA" - A new media item has been added to the location by
	// a Google Maps user. The notification will provide the resource name of the
	// new media item.
	//   "NEW_QUESTION" - A new question is added to the location. The notification
	// will provide the resource name of question.
	//   "UPDATED_QUESTION" - A question of the location is updated. The
	// notification will provide the resource name of question.
	//   "NEW_ANSWER" - A new answer is added to the location. The notification
	// will provide the resource name of question and answer.
	//   "UPDATED_ANSWER" - An answer of the location is updated. The notification
	// will provide the resource name of question and answer.
	//   "DUPLICATE_LOCATION" - Indicates whether there is a change in location
	// metadata's duplicate location field.
	//   "LOSS_OF_VOICE_OF_MERCHANT" - Deprecated: Migrate the existing usages of
	// this value to the more expanded "VOICE_OF_MERCHANT_UPDATED".
	//   "VOICE_OF_MERCHANT_UPDATED" - Indicates whether the location has an update
	// in Voice of Merchant (VOM) status. VOM dictates whether the location is in
	// good standing and the merchant has control over the business on Google. Any
	// edits made to the location will propagate to Maps after passing the review
	// phase. Call GetVoiceOfMerchantState rpc for more details.
	NotificationTypes []string `json:"notificationTypes,omitempty"`
	// PubsubTopic: Optional. The Google Pub/Sub topic that will receive
	// notifications when locations managed by this account are updated. If unset,
	// no notifications will be posted. The account
	// mybusiness-api-pubsub@system.gserviceaccount.com must have at least Publish
	// permissions on the Pub/Sub topic.
	PubsubTopic string `json:"pubsubTopic,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// 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:"-"`
}

NotificationSetting: A Google Pub/Sub topic where notifications can be published when a location is updated or has a new review. There will be only one notification setting resource per-account.

func (NotificationSetting) MarshalJSON 

func (s NotificationSetting) MarshalJSON() ([]byte, error)

type Service 

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

	Accounts *AccountsService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService 

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

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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