Class EmailPreferencesServiceClientImpl
EmailPreferencesService client wrapper implementation, for convenient use.
Inherited Members
Namespace: Google.Shopping.Merchant.Accounts.V1Beta
Assembly: Google.Shopping.Merchant.Accounts.V1Beta.dll
Syntax
public sealed class EmailPreferencesServiceClientImpl : EmailPreferencesServiceClientRemarks
Service to support the EmailPreferences API.
This service only permits retrieving and updating email preferences for the authenticated user.
Constructors
EmailPreferencesServiceClientImpl(EmailPreferencesServiceClient, EmailPreferencesServiceSettings, ILogger)
Constructs a client wrapper for the EmailPreferencesService service, with the specified gRPC client and settings.
Declaration
public EmailPreferencesServiceClientImpl(EmailPreferencesService.EmailPreferencesServiceClient grpcClient, EmailPreferencesServiceSettings settings, ILogger logger)Parameters
| Type | Name | Description |
|---|---|---|
| EmailPreferencesService.EmailPreferencesServiceClient | grpcClient | The underlying gRPC client. |
| EmailPreferencesServiceSettings | settings | The base EmailPreferencesServiceSettings used within this client. |
| ILogger | logger | Optional ILogger to use within this client. |
Properties
GrpcClient
The underlying gRPC EmailPreferencesService client
Declaration
public override EmailPreferencesService.EmailPreferencesServiceClient GrpcClient { get; }Property Value
| Type | Description |
|---|---|
| EmailPreferencesService.EmailPreferencesServiceClient |
Overrides
Methods
GetEmailPreferences(GetEmailPreferencesRequest, CallSettings)
Returns the email preferences for a Merchant Center account user.
Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
Declaration
public override EmailPreferences GetEmailPreferences(GetEmailPreferencesRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| GetEmailPreferencesRequest | 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 |
|---|---|
| EmailPreferences | The RPC response. |
Overrides
GetEmailPreferencesAsync(GetEmailPreferencesRequest, CallSettings)
Returns the email preferences for a Merchant Center account user.
Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
Declaration
public override Task<EmailPreferences> GetEmailPreferencesAsync(GetEmailPreferencesRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| GetEmailPreferencesRequest | 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<EmailPreferences> | A Task containing the RPC response. |
Overrides
UpdateEmailPreferences(UpdateEmailPreferencesRequest, CallSettings)
Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA.
Preferences which are not explicitly selected in the update mask will not be updated.
It is invalid for updates to specify an UNCONFIRMED opt-in status value.
Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.
Declaration
public override EmailPreferences UpdateEmailPreferences(UpdateEmailPreferencesRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateEmailPreferencesRequest | 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 |
|---|---|
| EmailPreferences | The RPC response. |
Overrides
UpdateEmailPreferencesAsync(UpdateEmailPreferencesRequest, CallSettings)
Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA.
Preferences which are not explicitly selected in the update mask will not be updated.
It is invalid for updates to specify an UNCONFIRMED opt-in status value.
Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.
Declaration
public override Task<EmailPreferences> UpdateEmailPreferencesAsync(UpdateEmailPreferencesRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateEmailPreferencesRequest | 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<EmailPreferences> | A Task containing the RPC response. |