Package indexing

import "google.golang.org/api/indexing/v3"
...
ctx := context.Background()
indexingService, err := indexing.NewService(ctx)

indexingService, err := indexing.NewService(ctx, option.WithAPIKey("AIza..."))

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

Constants

OAuth2 scopes used by this API.

const (
    // Submit data to Google for indexing
    IndexingScope = "https://www.googleapis.com/auth/indexing"
)

type PublishUrlNotificationResponse ¶

PublishUrlNotificationResponse: Output for PublishUrlNotification

type PublishUrlNotificationResponse struct {
    // UrlNotificationMetadata: Description of the notification events received for
    // this URL.
    UrlNotificationMetadata *UrlNotificationMetadata `json:"urlNotificationMetadata,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "UrlNotificationMetadata") 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. "UrlNotificationMetadata") to
    // include in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*PublishUrlNotificationResponse) MarshalJSON ¶

func (s *PublishUrlNotificationResponse) MarshalJSON() ([]byte, error)

type Service ¶

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

    UrlNotifications *UrlNotificationsService
    // contains filtered or unexported fields
}

func New ¶

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.

type UrlNotification ¶

UrlNotification: `UrlNotification` is the resource used in all Indexing API calls. It describes one event in the life cycle of a Web Document.

type UrlNotification struct {
    // NotifyTime: Creation timestamp for this notification. Users should _not_
    // specify it, the field is ignored at the request time.
    NotifyTime string `json:"notifyTime,omitempty"`
    // Type: The URL life cycle event that Google is being notified about.
    //
    // Possible values:
    //   "URL_NOTIFICATION_TYPE_UNSPECIFIED" - Unspecified.
    //   "URL_UPDATED" - The given URL (Web document) has been updated.
    //   "URL_DELETED" - The given URL (Web document) has been deleted.
    Type string `json:"type,omitempty"`
    // Url: The object of this notification. The URL must be owned by the publisher
    // of this notification and, in case of `URL_UPDATED` notifications, it _must_
    // be crawlable by Google.
    Url string `json:"url,omitempty"`
    // ForceSendFields is a list of field names (e.g. "NotifyTime") 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. "NotifyTime") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*UrlNotification) MarshalJSON ¶

func (s *UrlNotification) MarshalJSON() ([]byte, error)

type UrlNotificationMetadata ¶

UrlNotificationMetadata: Summary of the most recent Indexing API notifications successfully received, for a given URL.

type UrlNotificationMetadata struct {
    // LatestRemove: Latest notification received with type `URL_REMOVED`.
    LatestRemove *UrlNotification `json:"latestRemove,omitempty"`
    // LatestUpdate: Latest notification received with type `URL_UPDATED`.
    LatestUpdate *UrlNotification `json:"latestUpdate,omitempty"`
    // Url: URL to which this metadata refers.
    Url string `json:"url,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "LatestRemove") 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. "LatestRemove") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*UrlNotificationMetadata) MarshalJSON ¶

func (s *UrlNotificationMetadata) MarshalJSON() ([]byte, error)

type UrlNotificationsGetMetadataCall ¶

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

func (*UrlNotificationsGetMetadataCall) Context ¶

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

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

func (*UrlNotificationsGetMetadataCall) Do ¶

func (c *UrlNotificationsGetMetadataCall) Do(opts ...googleapi.CallOption) (*UrlNotificationMetadata, error)

Do executes the "indexing.urlNotifications.getMetadata" call. Any non-2xx status code is an error. Response headers are in either *UrlNotificationMetadata.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 (*UrlNotificationsGetMetadataCall) Fields ¶

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

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

func (*UrlNotificationsGetMetadataCall) Header ¶

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

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

func (*UrlNotificationsGetMetadataCall) IfNoneMatch ¶

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

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

func (*UrlNotificationsGetMetadataCall) Url ¶

func (c *UrlNotificationsGetMetadataCall) Url(url string) *UrlNotificationsGetMetadataCall

Url sets the optional parameter "url": URL that is being queried.

type UrlNotificationsPublishCall ¶

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

func (*UrlNotificationsPublishCall) Context ¶

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

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

func (*UrlNotificationsPublishCall) Do ¶

func (c *UrlNotificationsPublishCall) Do(opts ...googleapi.CallOption) (*PublishUrlNotificationResponse, error)

Do executes the "indexing.urlNotifications.publish" call. Any non-2xx status code is an error. Response headers are in either *PublishUrlNotificationResponse.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 (*UrlNotificationsPublishCall) Fields ¶

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

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

func (*UrlNotificationsPublishCall) Header ¶

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

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

type UrlNotificationsService ¶

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

func NewUrlNotificationsService ¶

func NewUrlNotificationsService(s *Service) *UrlNotificationsService

func (*UrlNotificationsService) GetMetadata ¶

func (r *UrlNotificationsService) GetMetadata() *UrlNotificationsGetMetadataCall

GetMetadata: Gets metadata about a Web Document. This method can _only_ be used to query URLs that were previously seen in successful Indexing API notifications. Includes the latest `UrlNotification` received via this API.

func (*UrlNotificationsService) Publish ¶

func (r *UrlNotificationsService) Publish(urlnotification *UrlNotification) *UrlNotificationsPublishCall

Publish: Notifies that a URL has been updated or deleted.