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.

LiveStreamService¶

class google.ads.admanager_v1.services.live_stream_service.LiveStreamServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.ads.admanager_v1.services.live_stream_service.transports.base.LiveStreamServiceTransport, typing.Callable[[...], google.ads.admanager_v1.services.live_stream_service.transports.base.LiveStreamServiceTransport]]] = 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 LiveStream objects.

Instantiates the live stream 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,LiveStreamServiceTransport,Callable[..., LiveStreamServiceTransport]]]) – 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 LiveStreamServiceTransport 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!

property api_endpoint: str¶

Return the API endpoint used by the client instance.

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

batch_activate_live_streams(request: Optional[Union[google.ads.admanager_v1.types.live_stream_service.BatchActivateLiveStreamsRequest, dict]] = None, *, parent: Optional[str] = None, names: Optional[MutableSequence[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.live_stream_service.BatchActivateLiveStreamsResponse[source]¶

Batch activates LiveStream objects.

# 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_batch_activate_live_streams():
    # Create a client
    client = admanager_v1.LiveStreamServiceClient()

    # Initialize request argument(s)
    request = admanager_v1.BatchActivateLiveStreamsRequest(
        parent="parent_value",
        names=['names_value1', 'names_value2'],
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchActivateLiveStreamsRequest, dict]) – The request object. Request object for BatchActivateLiveStreams method.
parent (str) – Required. Format: networks/{network_code} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
names (MutableSequence[str]) –
Required. The resource names of the LiveStreams to activate. Format: networks/{network_code}/liveStreams/{live_stream_id}

This corresponds to the names 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 BatchActivateLiveStreams method.

Return type

google.ads.admanager_v1.types.BatchActivateLiveStreamsResponse

batch_archive_live_streams(request: Optional[Union[google.ads.admanager_v1.types.live_stream_service.BatchArchiveLiveStreamsRequest, dict]] = None, *, parent: Optional[str] = None, names: Optional[MutableSequence[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.live_stream_service.BatchArchiveLiveStreamsResponse[source]¶

Batch archives LiveStream objects.

# 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_batch_archive_live_streams():
    # Create a client
    client = admanager_v1.LiveStreamServiceClient()

    # Initialize request argument(s)
    request = admanager_v1.BatchArchiveLiveStreamsRequest(
        parent="parent_value",
        names=['names_value1', 'names_value2'],
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchArchiveLiveStreamsRequest, dict]) – The request object. Request object for BatchArchiveLiveStreams method.
parent (str) – Required. Format: networks/{network_code} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
names (MutableSequence[str]) –
Required. The resource names of the LiveStreams to archive. Format: networks/{network_code}/liveStreams/{live_stream_id}

This corresponds to the names 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 BatchArchiveLiveStreams method.

Return type

google.ads.admanager_v1.types.BatchArchiveLiveStreamsResponse

batch_create_live_streams(request: Optional[Union[google.ads.admanager_v1.types.live_stream_service.BatchCreateLiveStreamsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.live_stream_service.CreateLiveStreamRequest]] = 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.live_stream_service.BatchCreateLiveStreamsResponse[source]¶

Batch creates LiveStream objects.

# 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_batch_create_live_streams():
    # Create a client
    client = admanager_v1.LiveStreamServiceClient()

    # Initialize request argument(s)
    requests = admanager_v1.CreateLiveStreamRequest()
    requests.parent = "parent_value"
    requests.live_stream.content_urls = ['content_urls_value1', 'content_urls_value2']
    requests.live_stream.ad_tags = ['ad_tags_value1', 'ad_tags_value2']

    request = admanager_v1.BatchCreateLiveStreamsRequest(
        parent="parent_value",
        requests=requests,
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchCreateLiveStreamsRequest, dict]) – The request object. Request object for BatchCreateLiveStreams method.
parent (str) –
Required. The parent resource where LiveStreams will be created. Format: networks/{network_code} The parent field in the CreateLiveStreamRequest must match this field.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
requests (MutableSequence[google.ads.admanager_v1.types.CreateLiveStreamRequest]) –
Required. The LiveStream objects to create. A maximum of 100 objects can be created in a batch.

This corresponds to the requests 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 BatchCreateLiveStreams method.

Return type

google.ads.admanager_v1.types.BatchCreateLiveStreamsResponse

batch_pause_ads_live_streams(request: Optional[Union[google.ads.admanager_v1.types.live_stream_service.BatchPauseAdsLiveStreamsRequest, dict]] = None, *, parent: Optional[str] = None, names: Optional[MutableSequence[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.live_stream_service.BatchPauseAdsLiveStreamsResponse[source]¶

Batch pauses ads on LiveStream objects.

# 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_batch_pause_ads_live_streams():
    # Create a client
    client = admanager_v1.LiveStreamServiceClient()

    # Initialize request argument(s)
    request = admanager_v1.BatchPauseAdsLiveStreamsRequest(
        parent="parent_value",
        names=['names_value1', 'names_value2'],
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchPauseAdsLiveStreamsRequest, dict]) – The request object. Request object for BatchPauseAdsLiveStreams method.
parent (str) – Required. Format: networks/{network_code} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
names (MutableSequence[str]) –
Required. The resource names of the LiveStreams to pause ads on. Format: networks/{network_code}/liveStreams/{live_stream_id}

This corresponds to the names 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 BatchPauseAdsLiveStreams method.

Return type

google.ads.admanager_v1.types.BatchPauseAdsLiveStreamsResponse

batch_pause_live_streams(request: Optional[Union[google.ads.admanager_v1.types.live_stream_service.BatchPauseLiveStreamsRequest, dict]] = None, *, parent: Optional[str] = None, names: Optional[MutableSequence[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.live_stream_service.BatchPauseLiveStreamsResponse[source]¶

Batch pauses LiveStream objects.

# 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_batch_pause_live_streams():
    # Create a client
    client = admanager_v1.LiveStreamServiceClient()

    # Initialize request argument(s)
    request = admanager_v1.BatchPauseLiveStreamsRequest(
        parent="parent_value",
        names=['names_value1', 'names_value2'],
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchPauseLiveStreamsRequest, dict]) – The request object. Request object for BatchPauseLiveStreams method.
parent (str) – Required. Format: networks/{network_code} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
names (MutableSequence[str]) –
Required. The resource names of the LiveStreams to pause. Format: networks/{network_code}/liveStreams/{live_stream_id}

This corresponds to the names 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 BatchPauseLiveStreams method.

Return type

google.ads.admanager_v1.types.BatchPauseLiveStreamsResponse

batch_refresh_master_playlists(request: Optional[Union[google.ads.admanager_v1.types.live_stream_service.BatchRefreshMasterPlaylistsRequest, dict]] = None, *, parent: Optional[str] = None, names: Optional[MutableSequence[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.live_stream_service.BatchRefreshMasterPlaylistsResponse[source]¶

Batch refreshes master playlists on LiveStream objects.

# 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_batch_refresh_master_playlists():
    # Create a client
    client = admanager_v1.LiveStreamServiceClient()

    # Initialize request argument(s)
    request = admanager_v1.BatchRefreshMasterPlaylistsRequest(
        parent="parent_value",
        names=['names_value1', 'names_value2'],
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchRefreshMasterPlaylistsRequest, dict]) – The request object. Request object for BatchRefreshMasterPlaylists method.
parent (str) – Required. Format: networks/{network_code} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
names (MutableSequence[str]) –
Required. The resource names of the LiveStreams to refresh master playlists on. Format: networks/{network_code}/liveStreams/{live_stream_id}

This corresponds to the names 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 BatchRefreshMasterPlaylists method.

Return type

google.ads.admanager_v1.types.BatchRefreshMasterPlaylistsResponse

batch_update_live_streams(request: Optional[Union[google.ads.admanager_v1.types.live_stream_service.BatchUpdateLiveStreamsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.live_stream_service.UpdateLiveStreamRequest]] = 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.live_stream_service.BatchUpdateLiveStreamsResponse[source]¶

Batch updates LiveStream objects.

# 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_batch_update_live_streams():
    # Create a client
    client = admanager_v1.LiveStreamServiceClient()

    # Initialize request argument(s)
    requests = admanager_v1.UpdateLiveStreamRequest()
    requests.live_stream.content_urls = ['content_urls_value1', 'content_urls_value2']
    requests.live_stream.ad_tags = ['ad_tags_value1', 'ad_tags_value2']

    request = admanager_v1.BatchUpdateLiveStreamsRequest(
        parent="parent_value",
        requests=requests,
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchUpdateLiveStreamsRequest, dict]) – The request object. Request object for BatchUpdateLiveStreams method.
parent (str) –
Required. The parent resource where LiveStreams will be updated. Format: networks/{network_code} The parent field in the UpdateLiveStreamRequest must match this field.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
requests (MutableSequence[google.ads.admanager_v1.types.UpdateLiveStreamRequest]) –
Required. The LiveStream objects to update. A maximum of 100 objects can be updated in a batch.

This corresponds to the requests 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 BatchUpdateLiveStreams method.

Return type

google.ads.admanager_v1.types.BatchUpdateLiveStreamsResponse

cancel_operation(request: Optional[Union[google.longrunning.operations_pb2.CancelOperationRequest, dict]] = 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]¶

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (CancelOperationRequest) – The request object. Request message for CancelOperation 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

None

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

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_live_stream(request: Optional[Union[google.ads.admanager_v1.types.live_stream_service.CreateLiveStreamRequest, dict]] = None, *, parent: Optional[str] = None, live_stream: Optional[google.ads.admanager_v1.types.live_stream_messages.LiveStream] = 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.live_stream_messages.LiveStream[source]¶

Creates a LiveStream object.

# 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_live_stream():
    # Create a client
    client = admanager_v1.LiveStreamServiceClient()

    # Initialize request argument(s)
    live_stream = admanager_v1.LiveStream()
    live_stream.content_urls = ['content_urls_value1', 'content_urls_value2']
    live_stream.ad_tags = ['ad_tags_value1', 'ad_tags_value2']

    request = admanager_v1.CreateLiveStreamRequest(
        parent="parent_value",
        live_stream=live_stream,
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.CreateLiveStreamRequest, dict]) – The request object. Request object for CreateLiveStream method.
parent (str) –
Required. The parent resource where this LiveStream will be created. Format: networks/{network_code}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
live_stream (google.ads.admanager_v1.types.LiveStream) – Required. The LiveStream to create. This corresponds to the live_stream 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

A LiveStream encapsulates all the information necessary to enable DAI (Dynamic Ad Insertion) into a live video stream. This includes information such as the start and expected end time of the live stream, the URL of the actual content for Ad Manager to pull and insert ads into, as well as the metadata necessary to generate ad requests during the live stream.

Return type

google.ads.admanager_v1.types.LiveStream

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

LiveStreamServiceClient

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

LiveStreamServiceClient

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

LiveStreamServiceClient

get_live_stream(request: Optional[Union[google.ads.admanager_v1.types.live_stream_service.GetLiveStreamRequest, 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.live_stream_messages.LiveStream[source]¶

Retrieves a LiveStream object.

# 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_live_stream():
    # Create a client
    client = admanager_v1.LiveStreamServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.GetLiveStreamRequest, dict]) – The request object. Request object for GetLiveStream method.
name (str) –
Required. The resource name of the LiveStream. Format: networks/{network_code}/liveStreams/{live_stream_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

A LiveStream encapsulates all the information necessary to enable DAI (Dynamic Ad Insertion) into a live video stream. This includes information such as the start and expected end time of the live stream, the URL of the actual content for Ad Manager to pull and insert ads into, as well as the metadata necessary to generate ad requests during the live stream.

Return type

google.ads.admanager_v1.types.LiveStream

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[Union[google.longrunning.operations_pb2.GetOperationRequest, dict]] = 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_live_streams(request: Optional[Union[google.ads.admanager_v1.types.live_stream_service.ListLiveStreamsRequest, 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.live_stream_service.pagers.ListLiveStreamsPager[source]¶

Lists LiveStream objects.

# 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_live_streams():
    # Create a client
    client = admanager_v1.LiveStreamServiceClient()

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

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

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

Parameters

request (Union[google.ads.admanager_v1.types.ListLiveStreamsRequest, dict]) – The request object. Request object for ListLiveStreams method.
parent (str) –
Required. The parent, which owns this collection of LiveStreams. Format: networks/{network_code}

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 ListLiveStreamsRequest containing matching LiveStream: objects.

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

Return type

google.ads.admanager_v1.services.live_stream_service.pagers.ListLiveStreamsPager

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

static network_path(network_code: str) → str[source]¶: Returns a fully-qualified network string.

static parse_cdn_config_path(path: str) → Dict[str, str][source]¶: Parses a cdn_config 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_path(path: str) → Dict[str, str][source]¶: Parses a live_stream path into its component segments.

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

property transport: google.ads.admanager_v1.services.live_stream_service.transports.base.LiveStreamServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

LiveStreamServiceTransport

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_live_stream(request: Optional[Union[google.ads.admanager_v1.types.live_stream_service.UpdateLiveStreamRequest, dict]] = None, *, live_stream: Optional[google.ads.admanager_v1.types.live_stream_messages.LiveStream] = 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.live_stream_messages.LiveStream[source]¶

Updates a LiveStream object.

# 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_live_stream():
    # Create a client
    client = admanager_v1.LiveStreamServiceClient()

    # Initialize request argument(s)
    live_stream = admanager_v1.LiveStream()
    live_stream.content_urls = ['content_urls_value1', 'content_urls_value2']
    live_stream.ad_tags = ['ad_tags_value1', 'ad_tags_value2']

    request = admanager_v1.UpdateLiveStreamRequest(
        live_stream=live_stream,
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.UpdateLiveStreamRequest, dict]) – The request object. Request object for UpdateLiveStream method.
live_stream (google.ads.admanager_v1.types.LiveStream) –
Required. The LiveStream to update.

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

This corresponds to the live_stream field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Optional. 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

A LiveStream encapsulates all the information necessary to enable DAI (Dynamic Ad Insertion) into a live video stream. This includes information such as the start and expected end time of the live stream, the URL of the actual content for Ad Manager to pull and insert ads into, as well as the metadata necessary to generate ad requests during the live stream.

Return type

google.ads.admanager_v1.types.LiveStream

class google.ads.admanager_v1.services.live_stream_service.pagers.ListLiveStreamsPager(method: Callable[[...], google.ads.admanager_v1.types.live_stream_service.ListLiveStreamsResponse], request: google.ads.admanager_v1.types.live_stream_service.ListLiveStreamsRequest, response: google.ads.admanager_v1.types.live_stream_service.ListLiveStreamsResponse, *, 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_live_streams requests.

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

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

All the usual google.ads.admanager_v1.types.ListLiveStreamsResponse 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.ListLiveStreamsRequest) – The initial request object.
response (google.ads.admanager_v1.types.ListLiveStreamsResponse) – 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.

LiveStreamService¶

google-ads-admanager

Navigation

Related Topics