Class AdBreakService.AdBreakServiceClient

Client for AdBreakService

Inheritance

object

ClientBase

ClientBase<AdBreakService.AdBreakServiceClient>

AdBreakService.AdBreakServiceClient

Inherited Members

ClientBase<AdBreakService.AdBreakServiceClient>.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 AdBreakService.AdBreakServiceClient : ClientBase<AdBreakService.AdBreakServiceClient>

Constructors

AdBreakServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected AdBreakServiceClient()

AdBreakServiceClient(CallInvoker)

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

Declaration

public AdBreakServiceClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

AdBreakServiceClient(ChannelBase)

Creates a new client for AdBreakService

Declaration

public AdBreakServiceClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

AdBreakServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected AdBreakServiceClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

CreateAdBreak(CreateAdBreakRequest, CallOptions)

API to create an AdBreak object.

Informs DAI of an upcoming ad break for a live stream event, with an optional expected start time. DAI will begin decisioning ads for the break shortly before the expected start time, if provided. Each live stream event can only have one incomplete ad break at any given time. The next ad break can be scheduled after the previous ad break has started serving, indicated by its state being [COMPLETE][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.COMPLETE], or it has been deleted.

This method cannot be used if the LiveStreamEvent has prefetching ad breaks enabled or the event is not active. If a LiveStreamEvent is deactivated after creating an ad break and before the ad break is complete, the ad break is discarded.

An ad break's state is complete when the following occurs:

• Full service DAI: after a matching ad break shows in the LiveStreamEvent manifest only when the ad break has started decisioning.
• Pod Serving: after the ad break is requested using the ad break ID or break sequence.

Declaration

public virtual AdBreak CreateAdBreak(CreateAdBreakRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateAdBreakRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AdBreak	The response received from the server.

CreateAdBreak(CreateAdBreakRequest, Metadata, DateTime?, CancellationToken)

API to create an AdBreak object.

Informs DAI of an upcoming ad break for a live stream event, with an optional expected start time. DAI will begin decisioning ads for the break shortly before the expected start time, if provided. Each live stream event can only have one incomplete ad break at any given time. The next ad break can be scheduled after the previous ad break has started serving, indicated by its state being [COMPLETE][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.COMPLETE], or it has been deleted.

This method cannot be used if the LiveStreamEvent has prefetching ad breaks enabled or the event is not active. If a LiveStreamEvent is deactivated after creating an ad break and before the ad break is complete, the ad break is discarded.

An ad break's state is complete when the following occurs:

• Full service DAI: after a matching ad break shows in the LiveStreamEvent manifest only when the ad break has started decisioning.
• Pod Serving: after the ad break is requested using the ad break ID or break sequence.

Declaration

public virtual AdBreak CreateAdBreak(CreateAdBreakRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateAdBreakRequest	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
AdBreak	The response received from the server.

CreateAdBreakAsync(CreateAdBreakRequest, CallOptions)

API to create an AdBreak object.

Informs DAI of an upcoming ad break for a live stream event, with an optional expected start time. DAI will begin decisioning ads for the break shortly before the expected start time, if provided. Each live stream event can only have one incomplete ad break at any given time. The next ad break can be scheduled after the previous ad break has started serving, indicated by its state being [COMPLETE][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.COMPLETE], or it has been deleted.

This method cannot be used if the LiveStreamEvent has prefetching ad breaks enabled or the event is not active. If a LiveStreamEvent is deactivated after creating an ad break and before the ad break is complete, the ad break is discarded.

An ad break's state is complete when the following occurs:

• Full service DAI: after a matching ad break shows in the LiveStreamEvent manifest only when the ad break has started decisioning.
• Pod Serving: after the ad break is requested using the ad break ID or break sequence.

Declaration

public virtual AsyncUnaryCall<AdBreak> CreateAdBreakAsync(CreateAdBreakRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateAdBreakRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<AdBreak>	The call object.

CreateAdBreakAsync(CreateAdBreakRequest, Metadata, DateTime?, CancellationToken)

API to create an AdBreak object.

Informs DAI of an upcoming ad break for a live stream event, with an optional expected start time. DAI will begin decisioning ads for the break shortly before the expected start time, if provided. Each live stream event can only have one incomplete ad break at any given time. The next ad break can be scheduled after the previous ad break has started serving, indicated by its state being [COMPLETE][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.COMPLETE], or it has been deleted.

This method cannot be used if the LiveStreamEvent has prefetching ad breaks enabled or the event is not active. If a LiveStreamEvent is deactivated after creating an ad break and before the ad break is complete, the ad break is discarded.

An ad break's state is complete when the following occurs:

• Full service DAI: after a matching ad break shows in the LiveStreamEvent manifest only when the ad break has started decisioning.
• Pod Serving: after the ad break is requested using the ad break ID or break sequence.

Declaration

public virtual AsyncUnaryCall<AdBreak> CreateAdBreakAsync(CreateAdBreakRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateAdBreakRequest	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<AdBreak>	The call object.

DeleteAdBreak(DeleteAdBreakRequest, CallOptions)

API to delete an AdBreak object.

Deletes and cancels an incomplete ad break, mitigating the need to wait for the current break to serve before recreating an ad break. You can delete an ad break that has not started serving or seen in manifests, indicated by its state being [SCHEDULED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED] or [DECISIONED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.DECISIONED].

Declaration

public virtual Empty DeleteAdBreak(DeleteAdBreakRequest request, CallOptions options)

Parameters

Type	Name	Description
DeleteAdBreakRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Empty	The response received from the server.

DeleteAdBreak(DeleteAdBreakRequest, Metadata, DateTime?, CancellationToken)

API to delete an AdBreak object.

Deletes and cancels an incomplete ad break, mitigating the need to wait for the current break to serve before recreating an ad break. You can delete an ad break that has not started serving or seen in manifests, indicated by its state being [SCHEDULED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED] or [DECISIONED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.DECISIONED].

Declaration

public virtual Empty DeleteAdBreak(DeleteAdBreakRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DeleteAdBreakRequest	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
Empty	The response received from the server.

DeleteAdBreakAsync(DeleteAdBreakRequest, CallOptions)

API to delete an AdBreak object.

Deletes and cancels an incomplete ad break, mitigating the need to wait for the current break to serve before recreating an ad break. You can delete an ad break that has not started serving or seen in manifests, indicated by its state being [SCHEDULED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED] or [DECISIONED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.DECISIONED].

Declaration

public virtual AsyncUnaryCall<Empty> DeleteAdBreakAsync(DeleteAdBreakRequest request, CallOptions options)

Parameters

Type	Name	Description
DeleteAdBreakRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Empty>	The call object.

DeleteAdBreakAsync(DeleteAdBreakRequest, Metadata, DateTime?, CancellationToken)

API to delete an AdBreak object.

Deletes and cancels an incomplete ad break, mitigating the need to wait for the current break to serve before recreating an ad break. You can delete an ad break that has not started serving or seen in manifests, indicated by its state being [SCHEDULED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED] or [DECISIONED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.DECISIONED].

Declaration

public virtual AsyncUnaryCall<Empty> DeleteAdBreakAsync(DeleteAdBreakRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DeleteAdBreakRequest	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<Empty>	The call object.

GetAdBreak(GetAdBreakRequest, CallOptions)

API to retrieve an AdBreak object.

Query an ad break by its resource name or custom asset key. Check the resource's breakState field to determine its state.

Declaration

public virtual AdBreak GetAdBreak(GetAdBreakRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAdBreakRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AdBreak	The response received from the server.

GetAdBreak(GetAdBreakRequest, Metadata, DateTime?, CancellationToken)

API to retrieve an AdBreak object.

Query an ad break by its resource name or custom asset key. Check the resource's breakState field to determine its state.

Declaration

public virtual AdBreak GetAdBreak(GetAdBreakRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetAdBreakRequest	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
AdBreak	The response received from the server.

GetAdBreakAsync(GetAdBreakRequest, CallOptions)

API to retrieve an AdBreak object.

Query an ad break by its resource name or custom asset key. Check the resource's breakState field to determine its state.

Declaration

public virtual AsyncUnaryCall<AdBreak> GetAdBreakAsync(GetAdBreakRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAdBreakRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<AdBreak>	The call object.

GetAdBreakAsync(GetAdBreakRequest, Metadata, DateTime?, CancellationToken)

API to retrieve an AdBreak object.

Query an ad break by its resource name or custom asset key. Check the resource's breakState field to determine its state.

Declaration

public virtual AsyncUnaryCall<AdBreak> GetAdBreakAsync(GetAdBreakRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetAdBreakRequest	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<AdBreak>	The call object.

ListAdBreaks(ListAdBreaksRequest, CallOptions)

API to retrieve a list of AdBreak objects.

By default, when no orderBy query parameter is specified, ad breaks are ordered reverse chronologically. However, ad breaks with a 'breakState' of 'SCHEDULED' or 'DECISIONED' are prioritized and appear first.

Declaration

public virtual ListAdBreaksResponse ListAdBreaks(ListAdBreaksRequest request, CallOptions options)

Parameters

Type	Name	Description
ListAdBreaksRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
ListAdBreaksResponse	The response received from the server.

ListAdBreaks(ListAdBreaksRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of AdBreak objects.

By default, when no orderBy query parameter is specified, ad breaks are ordered reverse chronologically. However, ad breaks with a 'breakState' of 'SCHEDULED' or 'DECISIONED' are prioritized and appear first.

Declaration

public virtual ListAdBreaksResponse ListAdBreaks(ListAdBreaksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListAdBreaksRequest	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
ListAdBreaksResponse	The response received from the server.

ListAdBreaksAsync(ListAdBreaksRequest, CallOptions)

API to retrieve a list of AdBreak objects.

By default, when no orderBy query parameter is specified, ad breaks are ordered reverse chronologically. However, ad breaks with a 'breakState' of 'SCHEDULED' or 'DECISIONED' are prioritized and appear first.

Declaration

public virtual AsyncUnaryCall<ListAdBreaksResponse> ListAdBreaksAsync(ListAdBreaksRequest request, CallOptions options)

Parameters

Type	Name	Description
ListAdBreaksRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<ListAdBreaksResponse>	The call object.

ListAdBreaksAsync(ListAdBreaksRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of AdBreak objects.

By default, when no orderBy query parameter is specified, ad breaks are ordered reverse chronologically. However, ad breaks with a 'breakState' of 'SCHEDULED' or 'DECISIONED' are prioritized and appear first.

Declaration

public virtual AsyncUnaryCall<ListAdBreaksResponse> ListAdBreaksAsync(ListAdBreaksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListAdBreaksRequest	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<ListAdBreaksResponse>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override AdBreakService.AdBreakServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
AdBreakService.AdBreakServiceClient

Overrides

Grpc.Core.ClientBase<Google.Ads.AdManager.V1.AdBreakService.AdBreakServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateAdBreak(UpdateAdBreakRequest, CallOptions)

API to update an AdBreak object.

Modify an ad break when its state is [SCHEDULED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED].

Declaration

public virtual AdBreak UpdateAdBreak(UpdateAdBreakRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateAdBreakRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AdBreak	The response received from the server.

UpdateAdBreak(UpdateAdBreakRequest, Metadata, DateTime?, CancellationToken)

API to update an AdBreak object.

Modify an ad break when its state is [SCHEDULED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED].

Declaration

public virtual AdBreak UpdateAdBreak(UpdateAdBreakRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateAdBreakRequest	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
AdBreak	The response received from the server.

UpdateAdBreakAsync(UpdateAdBreakRequest, CallOptions)

API to update an AdBreak object.

Modify an ad break when its state is [SCHEDULED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED].

Declaration

public virtual AsyncUnaryCall<AdBreak> UpdateAdBreakAsync(UpdateAdBreakRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateAdBreakRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<AdBreak>	The call object.

UpdateAdBreakAsync(UpdateAdBreakRequest, Metadata, DateTime?, CancellationToken)

API to update an AdBreak object.

Modify an ad break when its state is [SCHEDULED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED].

Declaration

public virtual AsyncUnaryCall<AdBreak> UpdateAdBreakAsync(UpdateAdBreakRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateAdBreakRequest	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<AdBreak>	The call object.