Class TermsOfServiceAgreementStateServiceClient
TermsOfServiceAgreementStateService client wrapper, for convenient use.
Inheritance
Namespace: Google.Shopping.Merchant.Accounts.V1Beta
Assembly: Google.Shopping.Merchant.Accounts.V1Beta.dll
Syntax
public abstract class TermsOfServiceAgreementStateServiceClient
Remarks
Service to support TermsOfServiceAgreementState
API.
Properties
DefaultEndpoint
The default endpoint for the TermsOfServiceAgreementStateService 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 TermsOfServiceAgreementStateService scopes.
Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type | Description |
---|---|
IReadOnlyList<string> |
Remarks
The default TermsOfServiceAgreementStateService scopes are:
- https://www.googleapis.com/auth/content
GrpcClient
The underlying gRPC TermsOfServiceAgreementStateService client
Declaration
public virtual TermsOfServiceAgreementStateService.TermsOfServiceAgreementStateServiceClient GrpcClient { get; }
Property Value
Type | Description |
---|---|
TermsOfServiceAgreementStateService.TermsOfServiceAgreementStateServiceClient |
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 TermsOfServiceAgreementStateServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use TermsOfServiceAgreementStateServiceClientBuilder.
Declaration
public static TermsOfServiceAgreementStateServiceClient Create()
Returns
Type | Description |
---|---|
TermsOfServiceAgreementStateServiceClient | The created TermsOfServiceAgreementStateServiceClient. |
CreateAsync(CancellationToken)
Asynchronously creates a TermsOfServiceAgreementStateServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use TermsOfServiceAgreementStateServiceClientBuilder.
Declaration
public static Task<TermsOfServiceAgreementStateServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken | The CancellationToken to use while creating the client. |
Returns
Type | Description |
---|---|
Task<TermsOfServiceAgreementStateServiceClient> | The task representing the created TermsOfServiceAgreementStateServiceClient. |
GetTermsOfServiceAgreementState(GetTermsOfServiceAgreementStateRequest, CallSettings)
Returns the state of a terms of service agreement.
Declaration
public virtual TermsOfServiceAgreementState GetTermsOfServiceAgreementState(GetTermsOfServiceAgreementStateRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
GetTermsOfServiceAgreementStateRequest | 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 |
---|---|
TermsOfServiceAgreementState | The RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = TermsOfServiceAgreementStateServiceClient.Create();
// Initialize request argument(s)
GetTermsOfServiceAgreementStateRequest request = new GetTermsOfServiceAgreementStateRequest
{
TermsOfServiceAgreementStateName = TermsOfServiceAgreementStateName.FromAccountIdentifier("[ACCOUNT]", "[IDENTIFIER]"),
};
// Make the request
TermsOfServiceAgreementState response = termsOfServiceAgreementStateServiceClient.GetTermsOfServiceAgreementState(request);
GetTermsOfServiceAgreementState(TermsOfServiceAgreementStateName, CallSettings)
Returns the state of a terms of service agreement.
Declaration
public virtual TermsOfServiceAgreementState GetTermsOfServiceAgreementState(TermsOfServiceAgreementStateName name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
TermsOfServiceAgreementStateName | name | Required. The resource name of the terms of service version.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
TermsOfServiceAgreementState | The RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = TermsOfServiceAgreementStateServiceClient.Create();
// Initialize request argument(s)
TermsOfServiceAgreementStateName name = TermsOfServiceAgreementStateName.FromAccountIdentifier("[ACCOUNT]", "[IDENTIFIER]");
// Make the request
TermsOfServiceAgreementState response = termsOfServiceAgreementStateServiceClient.GetTermsOfServiceAgreementState(name);
GetTermsOfServiceAgreementState(string, CallSettings)
Returns the state of a terms of service agreement.
Declaration
public virtual TermsOfServiceAgreementState GetTermsOfServiceAgreementState(string name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The resource name of the terms of service version.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
TermsOfServiceAgreementState | The RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = TermsOfServiceAgreementStateServiceClient.Create();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/termsOfServiceAgreementStates/[IDENTIFIER]";
// Make the request
TermsOfServiceAgreementState response = termsOfServiceAgreementStateServiceClient.GetTermsOfServiceAgreementState(name);
GetTermsOfServiceAgreementStateAsync(GetTermsOfServiceAgreementStateRequest, CallSettings)
Returns the state of a terms of service agreement.
Declaration
public virtual Task<TermsOfServiceAgreementState> GetTermsOfServiceAgreementStateAsync(GetTermsOfServiceAgreementStateRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
GetTermsOfServiceAgreementStateRequest | 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<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
GetTermsOfServiceAgreementStateRequest request = new GetTermsOfServiceAgreementStateRequest
{
TermsOfServiceAgreementStateName = TermsOfServiceAgreementStateName.FromAccountIdentifier("[ACCOUNT]", "[IDENTIFIER]"),
};
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.GetTermsOfServiceAgreementStateAsync(request);
GetTermsOfServiceAgreementStateAsync(GetTermsOfServiceAgreementStateRequest, CancellationToken)
Returns the state of a terms of service agreement.
Declaration
public virtual Task<TermsOfServiceAgreementState> GetTermsOfServiceAgreementStateAsync(GetTermsOfServiceAgreementStateRequest request, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
GetTermsOfServiceAgreementStateRequest | 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<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
GetTermsOfServiceAgreementStateRequest request = new GetTermsOfServiceAgreementStateRequest
{
TermsOfServiceAgreementStateName = TermsOfServiceAgreementStateName.FromAccountIdentifier("[ACCOUNT]", "[IDENTIFIER]"),
};
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.GetTermsOfServiceAgreementStateAsync(request);
GetTermsOfServiceAgreementStateAsync(TermsOfServiceAgreementStateName, CallSettings)
Returns the state of a terms of service agreement.
Declaration
public virtual Task<TermsOfServiceAgreementState> GetTermsOfServiceAgreementStateAsync(TermsOfServiceAgreementStateName name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
TermsOfServiceAgreementStateName | name | Required. The resource name of the terms of service version.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
TermsOfServiceAgreementStateName name = TermsOfServiceAgreementStateName.FromAccountIdentifier("[ACCOUNT]", "[IDENTIFIER]");
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.GetTermsOfServiceAgreementStateAsync(name);
GetTermsOfServiceAgreementStateAsync(TermsOfServiceAgreementStateName, CancellationToken)
Returns the state of a terms of service agreement.
Declaration
public virtual Task<TermsOfServiceAgreementState> GetTermsOfServiceAgreementStateAsync(TermsOfServiceAgreementStateName name, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
TermsOfServiceAgreementStateName | name | Required. The resource name of the terms of service version.
Format: |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
TermsOfServiceAgreementStateName name = TermsOfServiceAgreementStateName.FromAccountIdentifier("[ACCOUNT]", "[IDENTIFIER]");
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.GetTermsOfServiceAgreementStateAsync(name);
GetTermsOfServiceAgreementStateAsync(string, CallSettings)
Returns the state of a terms of service agreement.
Declaration
public virtual Task<TermsOfServiceAgreementState> GetTermsOfServiceAgreementStateAsync(string name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The resource name of the terms of service version.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/termsOfServiceAgreementStates/[IDENTIFIER]";
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.GetTermsOfServiceAgreementStateAsync(name);
GetTermsOfServiceAgreementStateAsync(string, CancellationToken)
Returns the state of a terms of service agreement.
Declaration
public virtual Task<TermsOfServiceAgreementState> GetTermsOfServiceAgreementStateAsync(string name, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The resource name of the terms of service version.
Format: |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/termsOfServiceAgreementStates/[IDENTIFIER]";
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.GetTermsOfServiceAgreementStateAsync(name);
RetrieveForApplicationTermsOfServiceAgreementState(AccountName, CallSettings)
Retrieves the state of the agreement for the application terms of service.
Declaration
public virtual TermsOfServiceAgreementState RetrieveForApplicationTermsOfServiceAgreementState(AccountName parent, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
AccountName | parent | Required. The account for which to get a TermsOfServiceAgreementState
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
TermsOfServiceAgreementState | The RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = TermsOfServiceAgreementStateServiceClient.Create();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
// Make the request
TermsOfServiceAgreementState response = termsOfServiceAgreementStateServiceClient.RetrieveForApplicationTermsOfServiceAgreementState(parent);
RetrieveForApplicationTermsOfServiceAgreementState(RetrieveForApplicationTermsOfServiceAgreementStateRequest, CallSettings)
Retrieves the state of the agreement for the application terms of service.
Declaration
public virtual TermsOfServiceAgreementState RetrieveForApplicationTermsOfServiceAgreementState(RetrieveForApplicationTermsOfServiceAgreementStateRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
RetrieveForApplicationTermsOfServiceAgreementStateRequest | 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 |
---|---|
TermsOfServiceAgreementState | The RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = TermsOfServiceAgreementStateServiceClient.Create();
// Initialize request argument(s)
RetrieveForApplicationTermsOfServiceAgreementStateRequest request = new RetrieveForApplicationTermsOfServiceAgreementStateRequest
{
ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
};
// Make the request
TermsOfServiceAgreementState response = termsOfServiceAgreementStateServiceClient.RetrieveForApplicationTermsOfServiceAgreementState(request);
RetrieveForApplicationTermsOfServiceAgreementState(string, CallSettings)
Retrieves the state of the agreement for the application terms of service.
Declaration
public virtual TermsOfServiceAgreementState RetrieveForApplicationTermsOfServiceAgreementState(string parent, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The account for which to get a TermsOfServiceAgreementState
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
TermsOfServiceAgreementState | The RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = TermsOfServiceAgreementStateServiceClient.Create();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
// Make the request
TermsOfServiceAgreementState response = termsOfServiceAgreementStateServiceClient.RetrieveForApplicationTermsOfServiceAgreementState(parent);
RetrieveForApplicationTermsOfServiceAgreementStateAsync(AccountName, CallSettings)
Retrieves the state of the agreement for the application terms of service.
Declaration
public virtual Task<TermsOfServiceAgreementState> RetrieveForApplicationTermsOfServiceAgreementStateAsync(AccountName parent, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
AccountName | parent | Required. The account for which to get a TermsOfServiceAgreementState
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.RetrieveForApplicationTermsOfServiceAgreementStateAsync(parent);
RetrieveForApplicationTermsOfServiceAgreementStateAsync(AccountName, CancellationToken)
Retrieves the state of the agreement for the application terms of service.
Declaration
public virtual Task<TermsOfServiceAgreementState> RetrieveForApplicationTermsOfServiceAgreementStateAsync(AccountName parent, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
AccountName | parent | Required. The account for which to get a TermsOfServiceAgreementState
Format: |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.RetrieveForApplicationTermsOfServiceAgreementStateAsync(parent);
RetrieveForApplicationTermsOfServiceAgreementStateAsync(RetrieveForApplicationTermsOfServiceAgreementStateRequest, CallSettings)
Retrieves the state of the agreement for the application terms of service.
Declaration
public virtual Task<TermsOfServiceAgreementState> RetrieveForApplicationTermsOfServiceAgreementStateAsync(RetrieveForApplicationTermsOfServiceAgreementStateRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
RetrieveForApplicationTermsOfServiceAgreementStateRequest | 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<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
RetrieveForApplicationTermsOfServiceAgreementStateRequest request = new RetrieveForApplicationTermsOfServiceAgreementStateRequest
{
ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
};
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.RetrieveForApplicationTermsOfServiceAgreementStateAsync(request);
RetrieveForApplicationTermsOfServiceAgreementStateAsync(RetrieveForApplicationTermsOfServiceAgreementStateRequest, CancellationToken)
Retrieves the state of the agreement for the application terms of service.
Declaration
public virtual Task<TermsOfServiceAgreementState> RetrieveForApplicationTermsOfServiceAgreementStateAsync(RetrieveForApplicationTermsOfServiceAgreementStateRequest request, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
RetrieveForApplicationTermsOfServiceAgreementStateRequest | 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<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
RetrieveForApplicationTermsOfServiceAgreementStateRequest request = new RetrieveForApplicationTermsOfServiceAgreementStateRequest
{
ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
};
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.RetrieveForApplicationTermsOfServiceAgreementStateAsync(request);
RetrieveForApplicationTermsOfServiceAgreementStateAsync(string, CallSettings)
Retrieves the state of the agreement for the application terms of service.
Declaration
public virtual Task<TermsOfServiceAgreementState> RetrieveForApplicationTermsOfServiceAgreementStateAsync(string parent, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The account for which to get a TermsOfServiceAgreementState
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.RetrieveForApplicationTermsOfServiceAgreementStateAsync(parent);
RetrieveForApplicationTermsOfServiceAgreementStateAsync(string, CancellationToken)
Retrieves the state of the agreement for the application terms of service.
Declaration
public virtual Task<TermsOfServiceAgreementState> RetrieveForApplicationTermsOfServiceAgreementStateAsync(string parent, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The account for which to get a TermsOfServiceAgreementState
Format: |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task<TermsOfServiceAgreementState> | A Task containing the RPC response. |
Sample code
// Create client
TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient = await TermsOfServiceAgreementStateServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
// Make the request
TermsOfServiceAgreementState response = await termsOfServiceAgreementStateServiceClient.RetrieveForApplicationTermsOfServiceAgreementStateAsync(parent);
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.