Merchant API v1beta - Package cloud.google.com/go/shopping/merchant/ordertracking/apiv1beta (v1.2.1)

Version latest

• 1.2.1 (latest)
• 1.2.0
• 1.1.1
• 1.0.0
• 0.25.0
• 0.24.1
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.1
• 0.18.1
• 0.17.1
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.1
• 0.11.1
• 0.10.0
• 0.9.2
• 0.8.7
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.2
• 0.2.2

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Package ordertracking is an auto-generated package for the Merchant API.

Programmatically manage your Merchant Center Accounts.

NOTE: This package is in beta. It is not stable, and may be subject to changes.

General documentation

For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:

• Authentication and Authorization
• Timeouts and Cancellation
• Testing against Client Libraries
• Debugging Client Libraries
• Inspecting errors

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/shopping/merchant/ordertracking/apiv1beta@latest
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := ordertracking.NewOrderTrackingSignalsClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client, mentioned above.

req := &ordertrackingpb.CreateOrderTrackingSignalRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/ordertracking/apiv1beta/ordertrackingpb#CreateOrderTrackingSignalRequest.
}
resp, err := c.CreateOrderTrackingSignal(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewOrderTrackingSignalsClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

OrderTrackingSignalsCallOptions

type OrderTrackingSignalsCallOptions struct {
	CreateOrderTrackingSignal []gax.CallOption
}

OrderTrackingSignalsCallOptions contains the retry settings for each method of OrderTrackingSignalsClient.

OrderTrackingSignalsClient

type OrderTrackingSignalsClient struct {

	// The call options for this service.
	CallOptions *OrderTrackingSignalsCallOptions
	// contains filtered or unexported fields
}

OrderTrackingSignalsClient is a client for interacting with Merchant API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service to serve order tracking signals public API.

func NewOrderTrackingSignalsClient

func NewOrderTrackingSignalsClient(ctx context.Context, opts ...option.ClientOption) (*OrderTrackingSignalsClient, error)

NewOrderTrackingSignalsClient creates a new order tracking signals service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service to serve order tracking signals public API.

Example

package main

import (
	"context"

	ordertracking "cloud.google.com/go/shopping/merchant/ordertracking/apiv1beta"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := ordertracking.NewOrderTrackingSignalsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewOrderTrackingSignalsRESTClient

func NewOrderTrackingSignalsRESTClient(ctx context.Context, opts ...option.ClientOption) (*OrderTrackingSignalsClient, error)

NewOrderTrackingSignalsRESTClient creates a new order tracking signals service rest client.

Service to serve order tracking signals public API.

Example

package main

import (
	"context"

	ordertracking "cloud.google.com/go/shopping/merchant/ordertracking/apiv1beta"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := ordertracking.NewOrderTrackingSignalsRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*OrderTrackingSignalsClient) Close

func (c *OrderTrackingSignalsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*OrderTrackingSignalsClient) Connection (deprecated)

func (c *OrderTrackingSignalsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not always return the same resource.

func (*OrderTrackingSignalsClient) CreateOrderTrackingSignal

func (c *OrderTrackingSignalsClient) CreateOrderTrackingSignal(ctx context.Context, req *ordertrackingpb.CreateOrderTrackingSignalRequest, opts ...gax.CallOption) (*ordertrackingpb.OrderTrackingSignal, error)

CreateOrderTrackingSignal creates new order tracking signal.

Example

package main

import (
	"context"

	ordertracking "cloud.google.com/go/shopping/merchant/ordertracking/apiv1beta"
	ordertrackingpb "cloud.google.com/go/shopping/merchant/ordertracking/apiv1beta/ordertrackingpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := ordertracking.NewOrderTrackingSignalsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &ordertrackingpb.CreateOrderTrackingSignalRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/ordertracking/apiv1beta/ordertrackingpb#CreateOrderTrackingSignalRequest.
	}
	resp, err := c.CreateOrderTrackingSignal(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}