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.

LineItemService¶

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

Instantiates the line item 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,LineItemServiceTransport,Callable[..., LineItemServiceTransport]]]) – 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 LineItemServiceTransport 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_unit_path(network_code: str, ad_unit: str) → str[source]¶: Returns a fully-qualified ad_unit string.

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

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

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

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

batch_activate_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchActivateLineItemsRequest, 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.line_item_service.BatchActivateLineItemsResponse[source]¶

Batch activates LineItem 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_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchActivateLineItemsRequest, dict]) – The request object. Request object for BatchActivateLineItems method.
parent (str) –
Required. The parent resource where LineItems will be updated. 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 names of the LineItem objects to activate. Format: networks/{network_code}/lineItems/{line_item}

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 BatchActivateLineItems method.

Return type

google.ads.admanager_v1.types.BatchActivateLineItemsResponse

batch_archive_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchArchiveLineItemsRequest, 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.line_item_service.BatchArchiveLineItemsResponse[source]¶

Batch archives LineItem 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_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchArchiveLineItemsRequest, dict]) – The request object. Request object for BatchArchiveLineItems method.
parent (str) –
Required. The parent resource where LineItems will be updated. 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 names of the LineItem objects to archive. Format: networks/{network_code}/lineItems/{line_item}

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 BatchArchiveLineItems method.

Return type

google.ads.admanager_v1.types.BatchArchiveLineItemsResponse

batch_create_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchCreateLineItemsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.line_item_service.CreateLineItemRequest]] = 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.line_item_service.BatchCreateLineItemsResponse[source]¶

Creates LineItem 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_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

    # Initialize request argument(s)
    requests = admanager_v1.CreateLineItemRequest()
    requests.parent = "parent_value"
    requests.line_item.creative_placeholders.size.width = 544
    requests.line_item.creative_placeholders.size.height = 633
    requests.line_item.creative_placeholders.size.size_type = "AUDIO"

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchCreateLineItemsRequest, dict]) – The request object. Request object for BatchCreateLineItems method.
parent (str) –
Required. The parent resource where LineItems will be created. Format: networks/{network_code} The parent field in the CreateLineItemRequest 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.CreateLineItemRequest]) –
Required. The LineItem 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 BatchCreateLineItems method.

Return type

google.ads.admanager_v1.types.BatchCreateLineItemsResponse

batch_delete_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchDeleteLineItemsRequest, 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]]] = ()) → None[source]¶

Batch deletes LineItem 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_delete_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

Parameters

request (Union[google.ads.admanager_v1.types.BatchDeleteLineItemsRequest, dict]) – The request object. Request object for BatchDeleteLineItems method.
parent (str) –
Required. The parent resource where LineItems will be updated. 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 names of the LineItem objects to delete. Format: networks/{network_code}/lineItems/{line_item}

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.

batch_pause_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchPauseLineItemsRequest, 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.line_item_service.BatchPauseLineItemsResponse[source]¶

Batch pauses LineItem 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_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchPauseLineItemsRequest, dict]) – The request object. Request object for BatchPauseLineItems method.
parent (str) –
Required. The parent resource where LineItems will be updated. 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 names of the LineItem objects to pause. Format: networks/{network_code}/lineItems/{line_item}

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 BatchPauseLineItems method.

Return type

google.ads.admanager_v1.types.BatchPauseLineItemsResponse

batch_release_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchReleaseLineItemsRequest, 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.line_item_service.BatchReleaseLineItemsResponse[source]¶

Batch releases LineItem 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_release_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchReleaseLineItemsRequest, dict]) – The request object. Request object for BatchReleaseLineItems method.
parent (str) –
Required. The parent resource where LineItems will be updated. 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 names of the LineItem objects to release. Format: networks/{network_code}/lineItems/{line_item}

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 BatchReleaseLineItems method.

Return type

google.ads.admanager_v1.types.BatchReleaseLineItemsResponse

batch_reserve_and_overbook_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchReserveAndOverbookLineItemsRequest, 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.line_item_service.BatchReserveAndOverbookLineItemsResponse[source]¶

Batch reserves and overbooks LineItem 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_reserve_and_overbook_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchReserveAndOverbookLineItemsRequest, dict]) – The request object. Request object for BatchReserveAndOverbookLineItems method.
parent (str) –
Required. The parent resource where LineItems will be updated. 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 names of the LineItem objects to reserve and overbook. Format: networks/{network_code}/lineItems/{line_item}

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 BatchReserveAndOverbookLineItems method.

Return type

google.ads.admanager_v1.types.BatchReserveAndOverbookLineItemsResponse

batch_reserve_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchReserveLineItemsRequest, 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.line_item_service.BatchReserveLineItemsResponse[source]¶

Batch reserves LineItem 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_reserve_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchReserveLineItemsRequest, dict]) – The request object. Request object for BatchReserveLineItems method.
parent (str) –
Required. The parent resource where LineItems will be updated. 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 names of the LineItem objects to reserve. Format: networks/{network_code}/lineItems/{line_item}

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 BatchReserveLineItems method.

Return type

google.ads.admanager_v1.types.BatchReserveLineItemsResponse

batch_resume_and_overbook_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchResumeAndOverbookLineItemsRequest, 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.line_item_service.BatchResumeAndOverbookLineItemsResponse[source]¶

Batch resumes and overbooks LineItem 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_resume_and_overbook_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchResumeAndOverbookLineItemsRequest, dict]) – The request object. Request object for BatchResumeAndOverbookLineItems method.
parent (str) –
Required. The parent resource where LineItems will be updated. 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 names of the LineItem objects to resume and overbook. Format: networks/{network_code}/lineItems/{line_item}

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 BatchResumeAndOverbookLineItems method.

Return type

google.ads.admanager_v1.types.BatchResumeAndOverbookLineItemsResponse

batch_resume_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchResumeLineItemsRequest, 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.line_item_service.BatchResumeLineItemsResponse[source]¶

Batch resumes LineItem 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_resume_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchResumeLineItemsRequest, dict]) – The request object. Request object for BatchResumeLineItems method.
parent (str) –
Required. The parent resource where LineItems will be updated. 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 names of the LineItem objects to resume. Format: networks/{network_code}/lineItems/{line_item}

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 BatchResumeLineItems method.

Return type

google.ads.admanager_v1.types.BatchResumeLineItemsResponse

batch_unarchive_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchUnarchiveLineItemsRequest, 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.line_item_service.BatchUnarchiveLineItemsResponse[source]¶

Batch unarchives LineItem 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_unarchive_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchUnarchiveLineItemsRequest, dict]) – The request object. Request object for BatchUnarchiveLineItems method.
parent (str) –
Required. The parent resource where LineItems will be unarchived. 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 names of the LineItem objects to extract. Format: networks/{network_code}/lineItems/{line_item}

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 BatchUnarchiveLineItems method.

Return type

google.ads.admanager_v1.types.BatchUnarchiveLineItemsResponse

batch_update_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.BatchUpdateLineItemsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.line_item_service.UpdateLineItemRequest]] = 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.line_item_service.BatchUpdateLineItemsResponse[source]¶

Batch updates LineItem 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_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

    # Initialize request argument(s)
    requests = admanager_v1.UpdateLineItemRequest()
    requests.line_item.creative_placeholders.size.width = 544
    requests.line_item.creative_placeholders.size.height = 633
    requests.line_item.creative_placeholders.size.size_type = "AUDIO"

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchUpdateLineItemsRequest, dict]) – The request object. Request object for BatchUpdateLineItems method.
parent (str) –
Required. The parent resource where LineItems will be updated. Format: networks/{network_code} The parent segment of the line_item.name in each UpdateLineItemRequest 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.UpdateLineItemRequest]) –
Required. The LineItem 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 BatchUpdateLineItems method.

Return type

google.ads.admanager_v1.types.BatchUpdateLineItemsResponse

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

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

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 cms_metadata_value_path(network_code: str, cms_metadata_value: str) → str[source]¶: Returns a fully-qualified cms_metadata_value 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.

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

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

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

create_line_item(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.CreateLineItemRequest, dict]] = None, *, parent: Optional[str] = None, line_item: Optional[google.ads.admanager_v1.types.line_item_messages.LineItem] = 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.line_item_messages.LineItem[source]¶

Creates a LineItem 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_line_item():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

    # Initialize request argument(s)
    line_item = admanager_v1.LineItem()
    line_item.creative_placeholders.size.width = 544
    line_item.creative_placeholders.size.height = 633
    line_item.creative_placeholders.size.size_type = "AUDIO"

    request = admanager_v1.CreateLineItemRequest(
        parent="parent_value",
        line_item=line_item,
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.CreateLineItemRequest, dict]) – The request object. Request object for CreateLineItem method.
parent (str) –
Required. The parent resource where this LineItem 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.
line_item (google.ads.admanager_v1.types.LineItem) – Required. The LineItem to create. This corresponds to the line_item 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 LineItem contains information about how specific ad creatives are intended to serve to your website or app along with pricing and other delivery details.

Return type

google.ads.admanager_v1.types.LineItem

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

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

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

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

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

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

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

LineItemServiceClient

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

LineItemServiceClient

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

LineItemServiceClient

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

get_line_item(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.GetLineItemRequest, 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.line_item_messages.LineItem[source]¶

Retrieves a LineItem 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_line_item():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.GetLineItemRequest, dict]) – The request object. Request object for GetLineItem method.
name (str) –
Required. The resource name of the LineItem. Format: networks/{network_code}/lineItems/{line_item_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 LineItem contains information about how specific ad creatives are intended to serve to your website or app along with pricing and other delivery details.

Return type

google.ads.admanager_v1.types.LineItem

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

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

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

list_line_items(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.ListLineItemsRequest, 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.line_item_service.pagers.ListLineItemsPager[source]¶

Lists LineItem 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_line_items():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

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

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

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

Parameters

request (Union[google.ads.admanager_v1.types.ListLineItemsRequest, dict]) – The request object. Request object for ListLineItems method.
parent (str) –
Required. The parent, which owns this collection of LineItems. 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 ListLineItemsRequest containing matching LineItem: objects.

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

Return type

google.ads.admanager_v1.services.line_item_service.pagers.ListLineItemsPager

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

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

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

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

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

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

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

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

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

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

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

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

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

static parse_cms_metadata_value_path(path: str) → Dict[str, str][source]¶: Parses a cms_metadata_value 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_company_path(path: str) → Dict[str, str][source]¶: Parses a company path into its component segments.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

property transport: google.ads.admanager_v1.services.line_item_service.transports.base.LineItemServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

LineItemServiceTransport

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_line_item(request: Optional[Union[google.ads.admanager_v1.types.line_item_service.UpdateLineItemRequest, dict]] = None, *, line_item: Optional[google.ads.admanager_v1.types.line_item_messages.LineItem] = 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.line_item_messages.LineItem[source]¶

Updates a LineItem 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_line_item():
    # Create a client
    client = admanager_v1.LineItemServiceClient()

    # Initialize request argument(s)
    line_item = admanager_v1.LineItem()
    line_item.creative_placeholders.size.width = 544
    line_item.creative_placeholders.size.height = 633
    line_item.creative_placeholders.size.size_type = "AUDIO"

    request = admanager_v1.UpdateLineItemRequest(
        line_item=line_item,
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.UpdateLineItemRequest, dict]) – The request object. Request object for UpdateLineItem method.
line_item (google.ads.admanager_v1.types.LineItem) –
Required. The LineItem to update.

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

This corresponds to the line_item 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 LineItem contains information about how specific ad creatives are intended to serve to your website or app along with pricing and other delivery details.

Return type

google.ads.admanager_v1.types.LineItem

class google.ads.admanager_v1.services.line_item_service.pagers.ListLineItemsPager(method: Callable[[...], google.ads.admanager_v1.types.line_item_service.ListLineItemsResponse], request: google.ads.admanager_v1.types.line_item_service.ListLineItemsRequest, response: google.ads.admanager_v1.types.line_item_service.ListLineItemsResponse, *, 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_line_items requests.

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

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

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

LineItemService¶

google-ads-admanager

Navigation

Related Topics