As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

AdBreakService¶

class google.ads.admanager_v1.services.ad_break_service.AdBreakServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.ads.admanager_v1.services.ad_break_service.transports.base.AdBreakServiceTransport, typing.Callable[[...], google.ads.admanager_v1.services.ad_break_service.transports.base.AdBreakServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Provides methods for handling AdBreak objects.

Instantiates the ad break service client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,AdBreakServiceTransport,Callable[..., AdBreakServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the AdBreakServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static ad_break_path(network_code: str, asset_key: str, ad_break: str) → str[source]¶: Returns a fully-qualified ad_break string.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_ad_break(request: Optional[Union[google.ads.admanager_v1.types.ad_break_service.CreateAdBreakRequest, dict]] = None, *, parent: Optional[str] = None, ad_break: Optional[google.ads.admanager_v1.types.ad_break_messages.AdBreak] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.ads.admanager_v1.types.ad_break_messages.AdBreak[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.ads import admanager_v1

def sample_create_ad_break():
    # Create a client
    client = admanager_v1.AdBreakServiceClient()

    # Initialize request argument(s)
    request = admanager_v1.CreateAdBreakRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_ad_break(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.CreateAdBreakRequest, dict]) – The request object. Request object for CreateAdBreak method.
parent (str) –
Required. The parent resource where this AdBreak will be created identified by an asset key or custom asset key.

Formats: networks/{network_code}/liveStreamEventsByAssetKey/{asset_key} networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
ad_break (google.ads.admanager_v1.types.AdBreak) – Required. The AdBreak to create. This corresponds to the ad_break field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

The AdBreak resource.

Return type

google.ads.admanager_v1.types.AdBreak

delete_ad_break(request: Optional[Union[google.ads.admanager_v1.types.ad_break_service.DeleteAdBreakRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → None[source]¶

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].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.ads import admanager_v1

def sample_delete_ad_break():
    # Create a client
    client = admanager_v1.AdBreakServiceClient()

    # Initialize request argument(s)
    request = admanager_v1.DeleteAdBreakRequest(
        name="name_value",
    )

    # Make the request
    client.delete_ad_break(request=request)

Parameters

request (Union[google.ads.admanager_v1.types.DeleteAdBreakRequest, dict]) – The request object. Request object for DeleteAdBreak method.
name (str) –
Required. The name of the ad break to delete.

Format: networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

AdBreakServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

AdBreakServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

AdBreakServiceClient

get_ad_break(request: Optional[Union[google.ads.admanager_v1.types.ad_break_service.GetAdBreakRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.ads.admanager_v1.types.ad_break_messages.AdBreak[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.ads import admanager_v1

def sample_get_ad_break():
    # Create a client
    client = admanager_v1.AdBreakServiceClient()

    # Initialize request argument(s)
    request = admanager_v1.GetAdBreakRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_ad_break(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.GetAdBreakRequest, dict]) – The request object. Request object for GetAdBreak method.
name (str) –
Required. The resource name of the AdBreak using the asset key or custom asset key.

Format: networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break_id} networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}/adBreaks/{ad_break_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

The AdBreak resource.

Return type

google.ads.admanager_v1.types.AdBreak

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

An Operation object.

Return type

Operation

list_ad_breaks(request: Optional[Union[google.ads.admanager_v1.types.ad_break_service.ListAdBreaksRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.ads.admanager_v1.services.ad_break_service.pagers.ListAdBreaksPager[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.ads import admanager_v1

def sample_list_ad_breaks():
    # Create a client
    client = admanager_v1.AdBreakServiceClient()

    # Initialize request argument(s)
    request = admanager_v1.ListAdBreaksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_ad_breaks(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.ads.admanager_v1.types.ListAdBreaksRequest, dict]) – The request object. Request object for ListAdBreaks method.
parent (str) –
Required. The parent, which owns this collection of AdBreaks.

Formats: networks/{network_code}/liveStreamEventsByAssetKey/{asset_key} networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

Response object for ListAdBreaksRequest containing matching AdBreak: objects.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.ads.admanager_v1.services.ad_break_service.pagers.ListAdBreaksPager

static live_stream_event_path(network_code: str, live_stream_event: str) → str[source]¶: Returns a fully-qualified live_stream_event string.

static parse_ad_break_path(path: str) → Dict[str, str][source]¶: Parses a ad_break path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_live_stream_event_path(path: str) → Dict[str, str][source]¶: Parses a live_stream_event path into its component segments.

property transport: google.ads.admanager_v1.services.ad_break_service.transports.base.AdBreakServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

AdBreakServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_ad_break(request: Optional[Union[google.ads.admanager_v1.types.ad_break_service.UpdateAdBreakRequest, dict]] = None, *, ad_break: Optional[google.ads.admanager_v1.types.ad_break_messages.AdBreak] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.ads.admanager_v1.types.ad_break_messages.AdBreak[source]¶

API to update an AdBreak object.

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.ads import admanager_v1

def sample_update_ad_break():
    # Create a client
    client = admanager_v1.AdBreakServiceClient()

    # Initialize request argument(s)
    request = admanager_v1.UpdateAdBreakRequest(
    )

    # Make the request
    response = client.update_ad_break(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.UpdateAdBreakRequest, dict]) – The request object. Request object for UpdateAdBreak method.
ad_break (google.ads.admanager_v1.types.AdBreak) –
Required. The AdBreak to update.

The AdBreak’s name is used to identify the AdBreak to update.

This corresponds to the ad_break field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. The list of fields to update.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

The AdBreak resource.

Return type

google.ads.admanager_v1.types.AdBreak

class google.ads.admanager_v1.services.ad_break_service.pagers.ListAdBreaksPager(method: Callable[[...], google.ads.admanager_v1.types.ad_break_service.ListAdBreaksResponse], request: google.ads.admanager_v1.types.ad_break_service.ListAdBreaksRequest, response: google.ads.admanager_v1.types.ad_break_service.ListAdBreaksResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]¶

A pager for iterating through list_ad_breaks requests.

This class thinly wraps an initial google.ads.admanager_v1.types.ListAdBreaksResponse object, and provides an __iter__ method to iterate through its ad_breaks field.

If there are more pages, the __iter__ method will make additional ListAdBreaks requests and continue to iterate through the ad_breaks field on the corresponding responses.

All the usual google.ads.admanager_v1.types.ListAdBreaksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.ads.admanager_v1.types.ListAdBreaksRequest) – The initial request object.
response (google.ads.admanager_v1.types.ListAdBreaksResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

AdBreakService¶

google-ads-admanager

Navigation

Related Topics