Show / Hide Table of Contents

Class SiteService.SiteServiceClient

Client for SiteService

Inheritance
object
ClientBase
ClientBase<SiteService.SiteServiceClient>
SiteService.SiteServiceClient
Inherited Members
ClientBase<SiteService.SiteServiceClient>.WithHost(string)
ClientBase.CallInvoker
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public class SiteService.SiteServiceClient : ClientBase<SiteService.SiteServiceClient>

Constructors

SiteServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration
protected SiteServiceClient()

SiteServiceClient(CallInvoker)

Creates a new client for SiteService that uses a custom CallInvoker.

Declaration
public SiteServiceClient(CallInvoker callInvoker)
Parameters
Type Name Description
CallInvoker callInvoker

The callInvoker to use to make remote calls.

SiteServiceClient(ChannelBase)

Creates a new client for SiteService

Declaration
public SiteServiceClient(ChannelBase channel)
Parameters
Type Name Description
ChannelBase channel

The channel to use to make remote calls.

SiteServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration
protected SiteServiceClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration

The client configuration.

Methods

BatchCreateSites(BatchCreateSitesRequest, CallOptions)

API to batch create Site objects.

Declaration
public virtual BatchCreateSitesResponse BatchCreateSites(BatchCreateSitesRequest request, CallOptions options)
Parameters
Type Name Description
BatchCreateSitesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchCreateSitesResponse

The response received from the server.

BatchCreateSites(BatchCreateSitesRequest, Metadata, DateTime?, CancellationToken)

API to batch create Site objects.

Declaration
public virtual BatchCreateSitesResponse BatchCreateSites(BatchCreateSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchCreateSitesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
BatchCreateSitesResponse

The response received from the server.

BatchCreateSitesAsync(BatchCreateSitesRequest, CallOptions)

API to batch create Site objects.

Declaration
public virtual AsyncUnaryCall<BatchCreateSitesResponse> BatchCreateSitesAsync(BatchCreateSitesRequest request, CallOptions options)
Parameters
Type Name Description
BatchCreateSitesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchCreateSitesResponse>

The call object.

BatchCreateSitesAsync(BatchCreateSitesRequest, Metadata, DateTime?, CancellationToken)

API to batch create Site objects.

Declaration
public virtual AsyncUnaryCall<BatchCreateSitesResponse> BatchCreateSitesAsync(BatchCreateSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchCreateSitesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<BatchCreateSitesResponse>

The call object.

BatchDeactivateSites(BatchDeactivateSitesRequest, CallOptions)

Deactivates a list of Site objects.

Declaration
public virtual BatchDeactivateSitesResponse BatchDeactivateSites(BatchDeactivateSitesRequest request, CallOptions options)
Parameters
Type Name Description
BatchDeactivateSitesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchDeactivateSitesResponse

The response received from the server.

BatchDeactivateSites(BatchDeactivateSitesRequest, Metadata, DateTime?, CancellationToken)

Deactivates a list of Site objects.

Declaration
public virtual BatchDeactivateSitesResponse BatchDeactivateSites(BatchDeactivateSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchDeactivateSitesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
BatchDeactivateSitesResponse

The response received from the server.

BatchDeactivateSitesAsync(BatchDeactivateSitesRequest, CallOptions)

Deactivates a list of Site objects.

Declaration
public virtual AsyncUnaryCall<BatchDeactivateSitesResponse> BatchDeactivateSitesAsync(BatchDeactivateSitesRequest request, CallOptions options)
Parameters
Type Name Description
BatchDeactivateSitesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchDeactivateSitesResponse>

The call object.

BatchDeactivateSitesAsync(BatchDeactivateSitesRequest, Metadata, DateTime?, CancellationToken)

Deactivates a list of Site objects.

Declaration
public virtual AsyncUnaryCall<BatchDeactivateSitesResponse> BatchDeactivateSitesAsync(BatchDeactivateSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchDeactivateSitesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<BatchDeactivateSitesResponse>

The call object.

BatchSubmitSitesForApproval(BatchSubmitSitesForApprovalRequest, CallOptions)

Submits a list of Site objects for approval.

Declaration
public virtual BatchSubmitSitesForApprovalResponse BatchSubmitSitesForApproval(BatchSubmitSitesForApprovalRequest request, CallOptions options)
Parameters
Type Name Description
BatchSubmitSitesForApprovalRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchSubmitSitesForApprovalResponse

The response received from the server.

BatchSubmitSitesForApproval(BatchSubmitSitesForApprovalRequest, Metadata, DateTime?, CancellationToken)

Submits a list of Site objects for approval.

Declaration
public virtual BatchSubmitSitesForApprovalResponse BatchSubmitSitesForApproval(BatchSubmitSitesForApprovalRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchSubmitSitesForApprovalRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
BatchSubmitSitesForApprovalResponse

The response received from the server.

BatchSubmitSitesForApprovalAsync(BatchSubmitSitesForApprovalRequest, CallOptions)

Submits a list of Site objects for approval.

Declaration
public virtual AsyncUnaryCall<BatchSubmitSitesForApprovalResponse> BatchSubmitSitesForApprovalAsync(BatchSubmitSitesForApprovalRequest request, CallOptions options)
Parameters
Type Name Description
BatchSubmitSitesForApprovalRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchSubmitSitesForApprovalResponse>

The call object.

BatchSubmitSitesForApprovalAsync(BatchSubmitSitesForApprovalRequest, Metadata, DateTime?, CancellationToken)

Submits a list of Site objects for approval.

Declaration
public virtual AsyncUnaryCall<BatchSubmitSitesForApprovalResponse> BatchSubmitSitesForApprovalAsync(BatchSubmitSitesForApprovalRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchSubmitSitesForApprovalRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<BatchSubmitSitesForApprovalResponse>

The call object.

BatchUpdateSites(BatchUpdateSitesRequest, CallOptions)

API to batch update Site objects.

Declaration
public virtual BatchUpdateSitesResponse BatchUpdateSites(BatchUpdateSitesRequest request, CallOptions options)
Parameters
Type Name Description
BatchUpdateSitesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchUpdateSitesResponse

The response received from the server.

BatchUpdateSites(BatchUpdateSitesRequest, Metadata, DateTime?, CancellationToken)

API to batch update Site objects.

Declaration
public virtual BatchUpdateSitesResponse BatchUpdateSites(BatchUpdateSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchUpdateSitesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
BatchUpdateSitesResponse

The response received from the server.

BatchUpdateSitesAsync(BatchUpdateSitesRequest, CallOptions)

API to batch update Site objects.

Declaration
public virtual AsyncUnaryCall<BatchUpdateSitesResponse> BatchUpdateSitesAsync(BatchUpdateSitesRequest request, CallOptions options)
Parameters
Type Name Description
BatchUpdateSitesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchUpdateSitesResponse>

The call object.

BatchUpdateSitesAsync(BatchUpdateSitesRequest, Metadata, DateTime?, CancellationToken)

API to batch update Site objects.

Declaration
public virtual AsyncUnaryCall<BatchUpdateSitesResponse> BatchUpdateSitesAsync(BatchUpdateSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchUpdateSitesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<BatchUpdateSitesResponse>

The call object.

CreateSite(CreateSiteRequest, CallOptions)

API to create a Site object.

Declaration
public virtual Site CreateSite(CreateSiteRequest request, CallOptions options)
Parameters
Type Name Description
CreateSiteRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Site

The response received from the server.

CreateSite(CreateSiteRequest, Metadata, DateTime?, CancellationToken)

API to create a Site object.

Declaration
public virtual Site CreateSite(CreateSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateSiteRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
Site

The response received from the server.

CreateSiteAsync(CreateSiteRequest, CallOptions)

API to create a Site object.

Declaration
public virtual AsyncUnaryCall<Site> CreateSiteAsync(CreateSiteRequest request, CallOptions options)
Parameters
Type Name Description
CreateSiteRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Site>

The call object.

CreateSiteAsync(CreateSiteRequest, Metadata, DateTime?, CancellationToken)

API to create a Site object.

Declaration
public virtual AsyncUnaryCall<Site> CreateSiteAsync(CreateSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateSiteRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Site>

The call object.

GetSite(GetSiteRequest, CallOptions)

API to retrieve a Site object.

Declaration
public virtual Site GetSite(GetSiteRequest request, CallOptions options)
Parameters
Type Name Description
GetSiteRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Site

The response received from the server.

GetSite(GetSiteRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a Site object.

Declaration
public virtual Site GetSite(GetSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetSiteRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
Site

The response received from the server.

GetSiteAsync(GetSiteRequest, CallOptions)

API to retrieve a Site object.

Declaration
public virtual AsyncUnaryCall<Site> GetSiteAsync(GetSiteRequest request, CallOptions options)
Parameters
Type Name Description
GetSiteRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Site>

The call object.

GetSiteAsync(GetSiteRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a Site object.

Declaration
public virtual AsyncUnaryCall<Site> GetSiteAsync(GetSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetSiteRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Site>

The call object.

ListSites(ListSitesRequest, CallOptions)

API to retrieve a list of Site objects.

Declaration
public virtual ListSitesResponse ListSites(ListSitesRequest request, CallOptions options)
Parameters
Type Name Description
ListSitesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
ListSitesResponse

The response received from the server.

ListSites(ListSitesRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of Site objects.

Declaration
public virtual ListSitesResponse ListSites(ListSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListSitesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
ListSitesResponse

The response received from the server.

ListSitesAsync(ListSitesRequest, CallOptions)

API to retrieve a list of Site objects.

Declaration
public virtual AsyncUnaryCall<ListSitesResponse> ListSitesAsync(ListSitesRequest request, CallOptions options)
Parameters
Type Name Description
ListSitesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListSitesResponse>

The call object.

ListSitesAsync(ListSitesRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of Site objects.

Declaration
public virtual AsyncUnaryCall<ListSitesResponse> ListSitesAsync(ListSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListSitesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<ListSitesResponse>

The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration
protected override SiteService.SiteServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration
Returns
Type Description
SiteService.SiteServiceClient
Overrides
Grpc.Core.ClientBase<Google.Ads.AdManager.V1.SiteService.SiteServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateSite(UpdateSiteRequest, CallOptions)

API to update a Site object.

Declaration
public virtual Site UpdateSite(UpdateSiteRequest request, CallOptions options)
Parameters
Type Name Description
UpdateSiteRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Site

The response received from the server.

UpdateSite(UpdateSiteRequest, Metadata, DateTime?, CancellationToken)

API to update a Site object.

Declaration
public virtual Site UpdateSite(UpdateSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
UpdateSiteRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
Site

The response received from the server.

UpdateSiteAsync(UpdateSiteRequest, CallOptions)

API to update a Site object.

Declaration
public virtual AsyncUnaryCall<Site> UpdateSiteAsync(UpdateSiteRequest request, CallOptions options)
Parameters
Type Name Description
UpdateSiteRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Site>

The call object.

UpdateSiteAsync(UpdateSiteRequest, Metadata, DateTime?, CancellationToken)

API to update a Site object.

Declaration
public virtual AsyncUnaryCall<Site> UpdateSiteAsync(UpdateSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
UpdateSiteRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Site>

The call object.

In this article
Back to top Generated by DocFX