Show / Hide Table of Contents

Class OrderTrackingSignalsServiceClient

OrderTrackingSignalsService client wrapper, for convenient use.

Inheritance
object
OrderTrackingSignalsServiceClient
OrderTrackingSignalsServiceClientImpl
Inherited Members
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Shopping.Merchant.OrderTracking.V1
Assembly: Google.Shopping.Merchant.OrderTracking.V1.dll
Syntax
public abstract class OrderTrackingSignalsServiceClient
Remarks

Service to serve order tracking signals public API.

Properties

DefaultEndpoint

The default endpoint for the OrderTrackingSignalsService service, which is a host of "merchantapi.googleapis.com" and a port of 443.

Declaration
public static string DefaultEndpoint { get; }
Property Value
Type Description
string

DefaultScopes

The default OrderTrackingSignalsService scopes.

Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type Description
IReadOnlyList<string>
Remarks

The default OrderTrackingSignalsService scopes are:

  • https://www.googleapis.com/auth/content

GrpcClient

The underlying gRPC OrderTrackingSignalsService client

Declaration
public virtual OrderTrackingSignalsService.OrderTrackingSignalsServiceClient GrpcClient { get; }
Property Value
Type Description
OrderTrackingSignalsService.OrderTrackingSignalsServiceClient

ServiceMetadata

The service metadata associated with this client type.

Declaration
public static ServiceMetadata ServiceMetadata { get; }
Property Value
Type Description
ServiceMetadata

Methods

Create()

Synchronously creates a OrderTrackingSignalsServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use OrderTrackingSignalsServiceClientBuilder.

Declaration
public static OrderTrackingSignalsServiceClient Create()
Returns
Type Description
OrderTrackingSignalsServiceClient

The created OrderTrackingSignalsServiceClient.

CreateAsync(CancellationToken)

Asynchronously creates a OrderTrackingSignalsServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use OrderTrackingSignalsServiceClientBuilder.

Declaration
public static Task<OrderTrackingSignalsServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
Task<OrderTrackingSignalsServiceClient>

The task representing the created OrderTrackingSignalsServiceClient.

CreateOrderTrackingSignal(AccountName, string, CallSettings)

Creates new order tracking signal.

Declaration
public virtual OrderTrackingSignal CreateOrderTrackingSignal(AccountName parent, string orderTrackingSignalId, CallSettings callSettings = null)
Parameters
Type Name Description
AccountName parent

Required. The account of the business for which the order signal is created. Format: accounts/{account}

string orderTrackingSignalId

Output only. The ID that uniquely identifies this order tracking signal.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OrderTrackingSignal

The RPC response.

Sample code
// Create client
OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient = OrderTrackingSignalsServiceClient.Create();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
string orderTrackingSignalId = "";
// Make the request
OrderTrackingSignal response = orderTrackingSignalsServiceClient.CreateOrderTrackingSignal(parent, orderTrackingSignalId);

CreateOrderTrackingSignal(CreateOrderTrackingSignalRequest, CallSettings)

Creates new order tracking signal.

Declaration
public virtual OrderTrackingSignal CreateOrderTrackingSignal(CreateOrderTrackingSignalRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateOrderTrackingSignalRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OrderTrackingSignal

The RPC response.

Sample code
// Create client
OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient = OrderTrackingSignalsServiceClient.Create();
// Initialize request argument(s)
CreateOrderTrackingSignalRequest request = new CreateOrderTrackingSignalRequest
{
    ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
    OrderTrackingSignalId = "",
    OrderTrackingSignal = new OrderTrackingSignal(),
};
// Make the request
OrderTrackingSignal response = orderTrackingSignalsServiceClient.CreateOrderTrackingSignal(request);

CreateOrderTrackingSignal(string, string, CallSettings)

Creates new order tracking signal.

Declaration
public virtual OrderTrackingSignal CreateOrderTrackingSignal(string parent, string orderTrackingSignalId, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The account of the business for which the order signal is created. Format: accounts/{account}

string orderTrackingSignalId

Output only. The ID that uniquely identifies this order tracking signal.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OrderTrackingSignal

The RPC response.

Sample code
// Create client
OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient = OrderTrackingSignalsServiceClient.Create();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
string orderTrackingSignalId = "";
// Make the request
OrderTrackingSignal response = orderTrackingSignalsServiceClient.CreateOrderTrackingSignal(parent, orderTrackingSignalId);

CreateOrderTrackingSignalAsync(AccountName, string, CallSettings)

Creates new order tracking signal.

Declaration
public virtual Task<OrderTrackingSignal> CreateOrderTrackingSignalAsync(AccountName parent, string orderTrackingSignalId, CallSettings callSettings = null)
Parameters
Type Name Description
AccountName parent

Required. The account of the business for which the order signal is created. Format: accounts/{account}

string orderTrackingSignalId

Output only. The ID that uniquely identifies this order tracking signal.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<OrderTrackingSignal>

A Task containing the RPC response.

Sample code
// Create client
OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient = await OrderTrackingSignalsServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
string orderTrackingSignalId = "";
// Make the request
OrderTrackingSignal response = await orderTrackingSignalsServiceClient.CreateOrderTrackingSignalAsync(parent, orderTrackingSignalId);

CreateOrderTrackingSignalAsync(AccountName, string, CancellationToken)

Creates new order tracking signal.

Declaration
public virtual Task<OrderTrackingSignal> CreateOrderTrackingSignalAsync(AccountName parent, string orderTrackingSignalId, CancellationToken cancellationToken)
Parameters
Type Name Description
AccountName parent

Required. The account of the business for which the order signal is created. Format: accounts/{account}

string orderTrackingSignalId

Output only. The ID that uniquely identifies this order tracking signal.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<OrderTrackingSignal>

A Task containing the RPC response.

Sample code
// Create client
OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient = await OrderTrackingSignalsServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
string orderTrackingSignalId = "";
// Make the request
OrderTrackingSignal response = await orderTrackingSignalsServiceClient.CreateOrderTrackingSignalAsync(parent, orderTrackingSignalId);

CreateOrderTrackingSignalAsync(CreateOrderTrackingSignalRequest, CallSettings)

Creates new order tracking signal.

Declaration
public virtual Task<OrderTrackingSignal> CreateOrderTrackingSignalAsync(CreateOrderTrackingSignalRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateOrderTrackingSignalRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<OrderTrackingSignal>

A Task containing the RPC response.

Sample code
// Create client
OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient = await OrderTrackingSignalsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateOrderTrackingSignalRequest request = new CreateOrderTrackingSignalRequest
{
    ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
    OrderTrackingSignalId = "",
    OrderTrackingSignal = new OrderTrackingSignal(),
};
// Make the request
OrderTrackingSignal response = await orderTrackingSignalsServiceClient.CreateOrderTrackingSignalAsync(request);

CreateOrderTrackingSignalAsync(CreateOrderTrackingSignalRequest, CancellationToken)

Creates new order tracking signal.

Declaration
public virtual Task<OrderTrackingSignal> CreateOrderTrackingSignalAsync(CreateOrderTrackingSignalRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateOrderTrackingSignalRequest request

The request object containing all of the parameters for the API call.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<OrderTrackingSignal>

A Task containing the RPC response.

Sample code
// Create client
OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient = await OrderTrackingSignalsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateOrderTrackingSignalRequest request = new CreateOrderTrackingSignalRequest
{
    ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
    OrderTrackingSignalId = "",
    OrderTrackingSignal = new OrderTrackingSignal(),
};
// Make the request
OrderTrackingSignal response = await orderTrackingSignalsServiceClient.CreateOrderTrackingSignalAsync(request);

CreateOrderTrackingSignalAsync(string, string, CallSettings)

Creates new order tracking signal.

Declaration
public virtual Task<OrderTrackingSignal> CreateOrderTrackingSignalAsync(string parent, string orderTrackingSignalId, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The account of the business for which the order signal is created. Format: accounts/{account}

string orderTrackingSignalId

Output only. The ID that uniquely identifies this order tracking signal.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<OrderTrackingSignal>

A Task containing the RPC response.

Sample code
// Create client
OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient = await OrderTrackingSignalsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
string orderTrackingSignalId = "";
// Make the request
OrderTrackingSignal response = await orderTrackingSignalsServiceClient.CreateOrderTrackingSignalAsync(parent, orderTrackingSignalId);

CreateOrderTrackingSignalAsync(string, string, CancellationToken)

Creates new order tracking signal.

Declaration
public virtual Task<OrderTrackingSignal> CreateOrderTrackingSignalAsync(string parent, string orderTrackingSignalId, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The account of the business for which the order signal is created. Format: accounts/{account}

string orderTrackingSignalId

Output only. The ID that uniquely identifies this order tracking signal.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<OrderTrackingSignal>

A Task containing the RPC response.

Sample code
// Create client
OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient = await OrderTrackingSignalsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
string orderTrackingSignalId = "";
// Make the request
OrderTrackingSignal response = await orderTrackingSignalsServiceClient.CreateOrderTrackingSignalAsync(parent, orderTrackingSignalId);

ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Declaration
public static Task ShutdownDefaultChannelsAsync()
Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

In this article
Back to top Generated by DocFX