|
67 | 67 | * </tr> |
68 | 68 | * <tr> |
69 | 69 | * <td><p> GetAdBreak</td> |
70 | | - * <td><p> API to retrieve an `AdBreak` object. |
| 70 | + * <td><p> Retrieves an `AdBreak` object. |
71 | 71 | * <p> Query an ad break by its resource name or custom asset key. Check the resource's `breakState` field to determine its state.</td> |
72 | 72 | * <td> |
73 | 73 | * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
|
87 | 87 | * </tr> |
88 | 88 | * <tr> |
89 | 89 | * <td><p> ListAdBreaks</td> |
90 | | - * <td><p> API to retrieve a list of `AdBreak` objects. |
| 90 | + * <td><p> Lists `AdBreak` objects. |
91 | 91 | * <p> 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.</td> |
92 | 92 | * <td> |
93 | 93 | * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
|
108 | 108 | * </tr> |
109 | 109 | * <tr> |
110 | 110 | * <td><p> CreateAdBreak</td> |
111 | | - * <td><p> API to create an `AdBreak` object. |
| 111 | + * <td><p> Creates an `AdBreak` object. |
112 | 112 | * <p> 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. |
113 | 113 | * <p> This method cannot be used if the `LiveStreamEvent` has [prefetching ad breaks enabled](https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#prefetchenabled) 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. |
114 | 114 | * <p> 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.</td> |
|
130 | 130 | * </tr> |
131 | 131 | * <tr> |
132 | 132 | * <td><p> UpdateAdBreak</td> |
133 | | - * <td><p> API to update an `AdBreak` object. |
| 133 | + * <td><p> Updates an `AdBreak` object. |
134 | 134 | * <p> Modify an ad break when its state is [`SCHEDULED`][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED].</td> |
135 | 135 | * <td> |
136 | 136 | * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
|
149 | 149 | * </tr> |
150 | 150 | * <tr> |
151 | 151 | * <td><p> DeleteAdBreak</td> |
152 | | - * <td><p> API to delete an `AdBreak` object. |
| 152 | + * <td><p> Deletes an `AdBreak` object. |
153 | 153 | * <p> 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].</td> |
154 | 154 | * <td> |
155 | 155 | * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
@@ -261,7 +261,7 @@ public AdBreakServiceStub getStub() { |
261 | 261 |
|
262 | 262 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
263 | 263 | /** |
264 | | - * API to retrieve an `AdBreak` object. |
| 264 | + * Retrieves an `AdBreak` object. |
265 | 265 | * |
266 | 266 | * <p>Query an ad break by its resource name or custom asset key. Check the resource's |
267 | 267 | * `breakState` field to determine its state. |
@@ -294,7 +294,7 @@ public final AdBreak getAdBreak(@Nullable AdBreakName name) { |
294 | 294 |
|
295 | 295 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
296 | 296 | /** |
297 | | - * API to retrieve an `AdBreak` object. |
| 297 | + * Retrieves an `AdBreak` object. |
298 | 298 | * |
299 | 299 | * <p>Query an ad break by its resource name or custom asset key. Check the resource's |
300 | 300 | * `breakState` field to determine its state. |
@@ -326,7 +326,7 @@ public final AdBreak getAdBreak(String name) { |
326 | 326 |
|
327 | 327 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
328 | 328 | /** |
329 | | - * API to retrieve an `AdBreak` object. |
| 329 | + * Retrieves an `AdBreak` object. |
330 | 330 | * |
331 | 331 | * <p>Query an ad break by its resource name or custom asset key. Check the resource's |
332 | 332 | * `breakState` field to determine its state. |
@@ -357,7 +357,7 @@ public final AdBreak getAdBreak(GetAdBreakRequest request) { |
357 | 357 |
|
358 | 358 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
359 | 359 | /** |
360 | | - * API to retrieve an `AdBreak` object. |
| 360 | + * Retrieves an `AdBreak` object. |
361 | 361 | * |
362 | 362 | * <p>Query an ad break by its resource name or custom asset key. Check the resource's |
363 | 363 | * `breakState` field to determine its state. |
@@ -387,7 +387,7 @@ public final UnaryCallable<GetAdBreakRequest, AdBreak> getAdBreakCallable() { |
387 | 387 |
|
388 | 388 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
389 | 389 | /** |
390 | | - * API to retrieve a list of `AdBreak` objects. |
| 390 | + * Lists `AdBreak` objects. |
391 | 391 | * |
392 | 392 | * <p>By default, when no `orderBy` query parameter is specified, ad breaks are ordered reverse |
393 | 393 | * chronologically. However, ad breaks with a 'breakState' of 'SCHEDULED' or 'DECISIONED' are |
@@ -424,7 +424,7 @@ public final ListAdBreaksPagedResponse listAdBreaks(@Nullable LiveStreamEventNam |
424 | 424 |
|
425 | 425 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
426 | 426 | /** |
427 | | - * API to retrieve a list of `AdBreak` objects. |
| 427 | + * Lists `AdBreak` objects. |
428 | 428 | * |
429 | 429 | * <p>By default, when no `orderBy` query parameter is specified, ad breaks are ordered reverse |
430 | 430 | * chronologically. However, ad breaks with a 'breakState' of 'SCHEDULED' or 'DECISIONED' are |
@@ -458,7 +458,7 @@ public final ListAdBreaksPagedResponse listAdBreaks(String parent) { |
458 | 458 |
|
459 | 459 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
460 | 460 | /** |
461 | | - * API to retrieve a list of `AdBreak` objects. |
| 461 | + * Lists `AdBreak` objects. |
462 | 462 | * |
463 | 463 | * <p>By default, when no `orderBy` query parameter is specified, ad breaks are ordered reverse |
464 | 464 | * chronologically. However, ad breaks with a 'breakState' of 'SCHEDULED' or 'DECISIONED' are |
@@ -497,7 +497,7 @@ public final ListAdBreaksPagedResponse listAdBreaks(ListAdBreaksRequest request) |
497 | 497 |
|
498 | 498 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
499 | 499 | /** |
500 | | - * API to retrieve a list of `AdBreak` objects. |
| 500 | + * Lists `AdBreak` objects. |
501 | 501 | * |
502 | 502 | * <p>By default, when no `orderBy` query parameter is specified, ad breaks are ordered reverse |
503 | 503 | * chronologically. However, ad breaks with a 'breakState' of 'SCHEDULED' or 'DECISIONED' are |
@@ -537,7 +537,7 @@ public final ListAdBreaksPagedResponse listAdBreaks(ListAdBreaksRequest request) |
537 | 537 |
|
538 | 538 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
539 | 539 | /** |
540 | | - * API to retrieve a list of `AdBreak` objects. |
| 540 | + * Lists `AdBreak` objects. |
541 | 541 | * |
542 | 542 | * <p>By default, when no `orderBy` query parameter is specified, ad breaks are ordered reverse |
543 | 543 | * chronologically. However, ad breaks with a 'breakState' of 'SCHEDULED' or 'DECISIONED' are |
@@ -582,7 +582,7 @@ public final UnaryCallable<ListAdBreaksRequest, ListAdBreaksResponse> listAdBrea |
582 | 582 |
|
583 | 583 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
584 | 584 | /** |
585 | | - * API to create an `AdBreak` object. |
| 585 | + * Creates an `AdBreak` object. |
586 | 586 | * |
587 | 587 | * <p>Informs DAI of an upcoming ad break for a live stream event, with an optional expected start |
588 | 588 | * time. DAI will begin decisioning ads for the break shortly before the expected start time, if |
@@ -634,7 +634,7 @@ public final AdBreak createAdBreak(@Nullable LiveStreamEventName parent, AdBreak |
634 | 634 |
|
635 | 635 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
636 | 636 | /** |
637 | | - * API to create an `AdBreak` object. |
| 637 | + * Creates an `AdBreak` object. |
638 | 638 | * |
639 | 639 | * <p>Informs DAI of an upcoming ad break for a live stream event, with an optional expected start |
640 | 640 | * time. DAI will begin decisioning ads for the break shortly before the expected start time, if |
@@ -683,7 +683,7 @@ public final AdBreak createAdBreak(String parent, AdBreak adBreak) { |
683 | 683 |
|
684 | 684 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
685 | 685 | /** |
686 | | - * API to create an `AdBreak` object. |
| 686 | + * Creates an `AdBreak` object. |
687 | 687 | * |
688 | 688 | * <p>Informs DAI of an upcoming ad break for a live stream event, with an optional expected start |
689 | 689 | * time. DAI will begin decisioning ads for the break shortly before the expected start time, if |
@@ -729,7 +729,7 @@ public final AdBreak createAdBreak(CreateAdBreakRequest request) { |
729 | 729 |
|
730 | 730 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
731 | 731 | /** |
732 | | - * API to create an `AdBreak` object. |
| 732 | + * Creates an `AdBreak` object. |
733 | 733 | * |
734 | 734 | * <p>Informs DAI of an upcoming ad break for a live stream event, with an optional expected start |
735 | 735 | * time. DAI will begin decisioning ads for the break shortly before the expected start time, if |
@@ -774,7 +774,7 @@ public final UnaryCallable<CreateAdBreakRequest, AdBreak> createAdBreakCallable( |
774 | 774 |
|
775 | 775 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
776 | 776 | /** |
777 | | - * API to update an `AdBreak` object. |
| 777 | + * Updates an `AdBreak` object. |
778 | 778 | * |
779 | 779 | * <p>Modify an ad break when its state is |
780 | 780 | * [`SCHEDULED`][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED]. |
@@ -807,7 +807,7 @@ public final AdBreak updateAdBreak(AdBreak adBreak, FieldMask updateMask) { |
807 | 807 |
|
808 | 808 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
809 | 809 | /** |
810 | | - * API to update an `AdBreak` object. |
| 810 | + * Updates an `AdBreak` object. |
811 | 811 | * |
812 | 812 | * <p>Modify an ad break when its state is |
813 | 813 | * [`SCHEDULED`][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED]. |
@@ -839,7 +839,7 @@ public final AdBreak updateAdBreak(UpdateAdBreakRequest request) { |
839 | 839 |
|
840 | 840 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
841 | 841 | /** |
842 | | - * API to update an `AdBreak` object. |
| 842 | + * Updates an `AdBreak` object. |
843 | 843 | * |
844 | 844 | * <p>Modify an ad break when its state is |
845 | 845 | * [`SCHEDULED`][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED]. |
@@ -870,7 +870,7 @@ public final UnaryCallable<UpdateAdBreakRequest, AdBreak> updateAdBreakCallable( |
870 | 870 |
|
871 | 871 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
872 | 872 | /** |
873 | | - * API to delete an `AdBreak` object. |
| 873 | + * Deletes an `AdBreak` object. |
874 | 874 | * |
875 | 875 | * <p>Deletes and cancels an incomplete ad break, mitigating the need to wait for the current |
876 | 876 | * break to serve before recreating an ad break. You can delete an ad break that has not started |
@@ -905,7 +905,7 @@ public final void deleteAdBreak(@Nullable AdBreakName name) { |
905 | 905 |
|
906 | 906 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
907 | 907 | /** |
908 | | - * API to delete an `AdBreak` object. |
| 908 | + * Deletes an `AdBreak` object. |
909 | 909 | * |
910 | 910 | * <p>Deletes and cancels an incomplete ad break, mitigating the need to wait for the current |
911 | 911 | * break to serve before recreating an ad break. You can delete an ad break that has not started |
@@ -939,7 +939,7 @@ public final void deleteAdBreak(String name) { |
939 | 939 |
|
940 | 940 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
941 | 941 | /** |
942 | | - * API to delete an `AdBreak` object. |
| 942 | + * Deletes an `AdBreak` object. |
943 | 943 | * |
944 | 944 | * <p>Deletes and cancels an incomplete ad break, mitigating the need to wait for the current |
945 | 945 | * break to serve before recreating an ad break. You can delete an ad break that has not started |
@@ -973,7 +973,7 @@ public final void deleteAdBreak(DeleteAdBreakRequest request) { |
973 | 973 |
|
974 | 974 | // AUTO-GENERATED DOCUMENTATION AND METHOD. |
975 | 975 | /** |
976 | | - * API to delete an `AdBreak` object. |
| 976 | + * Deletes an `AdBreak` object. |
977 | 977 | * |
978 | 978 | * <p>Deletes and cancels an incomplete ad break, mitigating the need to wait for the current |
979 | 979 | * break to serve before recreating an ad break. You can delete an ad break that has not started |
|
0 commit comments