Class AdBreakServiceClientImpl

AdBreakService client wrapper implementation, for convenient use.

Inheritance

object

AdBreakServiceClient

AdBreakServiceClientImpl

Inherited Members

AdBreakServiceClient.DefaultEndpoint

AdBreakServiceClient.DefaultScopes

AdBreakServiceClient.ServiceMetadata

AdBreakServiceClient.CreateAsync(CancellationToken)

AdBreakServiceClient.Create()

AdBreakServiceClient.ShutdownDefaultChannelsAsync()

AdBreakServiceClient.GetAdBreakAsync(GetAdBreakRequest, CancellationToken)

AdBreakServiceClient.GetAdBreak(string, CallSettings)

AdBreakServiceClient.GetAdBreakAsync(string, CallSettings)

AdBreakServiceClient.GetAdBreakAsync(string, CancellationToken)

AdBreakServiceClient.GetAdBreak(AdBreakName, CallSettings)

AdBreakServiceClient.GetAdBreakAsync(AdBreakName, CallSettings)

AdBreakServiceClient.GetAdBreakAsync(AdBreakName, CancellationToken)

AdBreakServiceClient.ListAdBreaks(string, string, int?, CallSettings)

AdBreakServiceClient.ListAdBreaksAsync(string, string, int?, CallSettings)

AdBreakServiceClient.ListAdBreaks(LiveStreamEventName, string, int?, CallSettings)

AdBreakServiceClient.ListAdBreaksAsync(LiveStreamEventName, string, int?, CallSettings)

AdBreakServiceClient.CreateAdBreakAsync(CreateAdBreakRequest, CancellationToken)

AdBreakServiceClient.CreateAdBreak(string, AdBreak, CallSettings)

AdBreakServiceClient.CreateAdBreakAsync(string, AdBreak, CallSettings)

AdBreakServiceClient.CreateAdBreakAsync(string, AdBreak, CancellationToken)

AdBreakServiceClient.CreateAdBreak(LiveStreamEventName, AdBreak, CallSettings)

AdBreakServiceClient.CreateAdBreakAsync(LiveStreamEventName, AdBreak, CallSettings)

AdBreakServiceClient.CreateAdBreakAsync(LiveStreamEventName, AdBreak, CancellationToken)

AdBreakServiceClient.UpdateAdBreakAsync(UpdateAdBreakRequest, CancellationToken)

AdBreakServiceClient.UpdateAdBreak(AdBreak, FieldMask, CallSettings)

AdBreakServiceClient.UpdateAdBreakAsync(AdBreak, FieldMask, CallSettings)

AdBreakServiceClient.UpdateAdBreakAsync(AdBreak, FieldMask, CancellationToken)

AdBreakServiceClient.DeleteAdBreakAsync(DeleteAdBreakRequest, CancellationToken)

AdBreakServiceClient.DeleteAdBreak(string, CallSettings)

AdBreakServiceClient.DeleteAdBreakAsync(string, CallSettings)

AdBreakServiceClient.DeleteAdBreakAsync(string, CancellationToken)

AdBreakServiceClient.DeleteAdBreak(AdBreakName, CallSettings)

AdBreakServiceClient.DeleteAdBreakAsync(AdBreakName, CallSettings)

AdBreakServiceClient.DeleteAdBreakAsync(AdBreakName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class AdBreakServiceClientImpl : AdBreakServiceClient

Remarks

Provides methods for handling AdBreak objects.

Constructors

AdBreakServiceClientImpl(AdBreakServiceClient, AdBreakServiceSettings, ILogger)

Constructs a client wrapper for the AdBreakService service, with the specified gRPC client and settings.

Declaration

public AdBreakServiceClientImpl(AdBreakService.AdBreakServiceClient grpcClient, AdBreakServiceSettings settings, ILogger logger)

Parameters

Type	Name	Description
AdBreakService.AdBreakServiceClient	grpcClient	The underlying gRPC client.
AdBreakServiceSettings	settings	The base AdBreakServiceSettings used within this client.
ILogger	logger	Optional ILogger to use within this client.

Properties

GrpcClient

The underlying gRPC AdBreakService client

Declaration

public override AdBreakService.AdBreakServiceClient GrpcClient { get; }

Property Value

Type	Description
AdBreakService.AdBreakServiceClient

Overrides

AdBreakServiceClient.GrpcClient

Methods

CreateAdBreak(CreateAdBreakRequest, CallSettings)

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 override AdBreak CreateAdBreak(CreateAdBreakRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CreateAdBreakRequest	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
AdBreak	The RPC response.

Overrides

AdBreakServiceClient.CreateAdBreak(CreateAdBreakRequest, CallSettings)

CreateAdBreakAsync(CreateAdBreakRequest, CallSettings)

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 override Task<AdBreak> CreateAdBreakAsync(CreateAdBreakRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CreateAdBreakRequest	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<AdBreak>	A Task containing the RPC response.

Overrides

AdBreakServiceClient.CreateAdBreakAsync(CreateAdBreakRequest, CallSettings)

DeleteAdBreak(DeleteAdBreakRequest, CallSettings)

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 override void DeleteAdBreak(DeleteAdBreakRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
DeleteAdBreakRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Overrides

AdBreakServiceClient.DeleteAdBreak(DeleteAdBreakRequest, CallSettings)

DeleteAdBreakAsync(DeleteAdBreakRequest, CallSettings)

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 override Task DeleteAdBreakAsync(DeleteAdBreakRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
DeleteAdBreakRequest	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	A Task containing the RPC response.

Overrides

AdBreakServiceClient.DeleteAdBreakAsync(DeleteAdBreakRequest, CallSettings)

GetAdBreak(GetAdBreakRequest, CallSettings)

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 override AdBreak GetAdBreak(GetAdBreakRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetAdBreakRequest	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
AdBreak	The RPC response.

Overrides

AdBreakServiceClient.GetAdBreak(GetAdBreakRequest, CallSettings)

GetAdBreakAsync(GetAdBreakRequest, CallSettings)

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 override Task<AdBreak> GetAdBreakAsync(GetAdBreakRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetAdBreakRequest	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<AdBreak>	A Task containing the RPC response.

Overrides

AdBreakServiceClient.GetAdBreakAsync(GetAdBreakRequest, CallSettings)

ListAdBreaks(ListAdBreaksRequest, CallSettings)

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 override PagedEnumerable<ListAdBreaksResponse, AdBreak> ListAdBreaks(ListAdBreaksRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListAdBreaksRequest	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
PagedEnumerable<ListAdBreaksResponse, AdBreak>	A pageable sequence of AdBreak resources.

Overrides

AdBreakServiceClient.ListAdBreaks(ListAdBreaksRequest, CallSettings)

ListAdBreaksAsync(ListAdBreaksRequest, CallSettings)

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 override PagedAsyncEnumerable<ListAdBreaksResponse, AdBreak> ListAdBreaksAsync(ListAdBreaksRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListAdBreaksRequest	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
PagedAsyncEnumerable<ListAdBreaksResponse, AdBreak>	A pageable asynchronous sequence of AdBreak resources.

Overrides

AdBreakServiceClient.ListAdBreaksAsync(ListAdBreaksRequest, CallSettings)

UpdateAdBreak(UpdateAdBreakRequest, CallSettings)

API to update an AdBreak object.

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

Declaration

public override AdBreak UpdateAdBreak(UpdateAdBreakRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdateAdBreakRequest	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
AdBreak	The RPC response.

Overrides

AdBreakServiceClient.UpdateAdBreak(UpdateAdBreakRequest, CallSettings)

UpdateAdBreakAsync(UpdateAdBreakRequest, CallSettings)

API to update an AdBreak object.

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

Declaration

public override Task<AdBreak> UpdateAdBreakAsync(UpdateAdBreakRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdateAdBreakRequest	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<AdBreak>	A Task containing the RPC response.

Overrides

AdBreakServiceClient.UpdateAdBreakAsync(UpdateAdBreakRequest, CallSettings)