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.

LineItemCreativeAssociationService

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

Instantiates the line item creative association 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,LineItemCreativeAssociationServiceTransport,Callable[..., LineItemCreativeAssociationServiceTransport]]]) – 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 LineItemCreativeAssociationServiceTransport 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_line_item_creative_associations(request: Optional[Union[google.ads.admanager_v1.types.line_item_creative_association_service.BatchActivateLineItemCreativeAssociationsRequest, 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_creative_association_service.BatchActivateLineItemCreativeAssociationsResponse[source]

Activate a list of LineItemCreativeAssociation 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_item_creative_associations():
    # Create a client
    client = admanager_v1.LineItemCreativeAssociationServiceClient()

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

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

    # Handle the response
    print(response)
Parameters
  • request (Union[google.ads.admanager_v1.types.BatchActivateLineItemCreativeAssociationsRequest, dict]) – The request object. Request message for BatchActivateLineItemCreativeAssociations method.

  • parent (str) –

    Required. The parent resource where LineItemCreativeAssociations will be activated. This request supports using the “-” character as a wildcard for resources that span across multiple LineItem parents. Format: networks/{network_code}/lineItems/{line_item_id} Format: networks/{network_code}/lineItems/-

    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 LineItemCreativeAssociation objects to activate. A maximum of 1000 objects can be activated in a batch. Format: networks/{network_code}/lineItems/{line_item_id}/creatives/{creative_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 BatchActivateLineItemCreativeAssociations method.

Return type

google.ads.admanager_v1.types.BatchActivateLineItemCreativeAssociationsResponse

batch_create_line_item_creative_associations(request: Optional[Union[google.ads.admanager_v1.types.line_item_creative_association_service.BatchCreateLineItemCreativeAssociationsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.line_item_creative_association_service.CreateLineItemCreativeAssociationRequest]] = 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_creative_association_service.BatchCreateLineItemCreativeAssociationsResponse[source]

Creates LineItemCreativeAssociation 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_item_creative_associations():
    # Create a client
    client = admanager_v1.LineItemCreativeAssociationServiceClient()

    # Initialize request argument(s)
    requests = admanager_v1.CreateLineItemCreativeAssociationRequest()
    requests.parent = "parent_value"

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

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

    # Handle the response
    print(response)
Parameters
  • request (Union[google.ads.admanager_v1.types.BatchCreateLineItemCreativeAssociationsRequest, dict]) – The request object. Request object for BatchCreateLineItemCreativeAssociations method.

  • parent (str) –

    Required. The parent resource where LineItemCreativeAssociations will be created. This request supports using the “-” character as a wildcard for resources that span across multiple LineItem parents. Format: networks/{network_code}/lineItems/{line_item_id} Format: networks/{network_code}/lineItems/-

    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.CreateLineItemCreativeAssociationRequest]) –

    Required. The LineItemCreativeAssociation 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 BatchCreateLineItemCreativeAssociations method.

Return type

google.ads.admanager_v1.types.BatchCreateLineItemCreativeAssociationsResponse

batch_deactivate_line_item_creative_associations(request: Optional[Union[google.ads.admanager_v1.types.line_item_creative_association_service.BatchDeactivateLineItemCreativeAssociationsRequest, 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_creative_association_service.BatchDeactivateLineItemCreativeAssociationsResponse[source]

Deactivates a list of LineItemCreativeAssociation 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_deactivate_line_item_creative_associations():
    # Create a client
    client = admanager_v1.LineItemCreativeAssociationServiceClient()

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

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

    # Handle the response
    print(response)
Parameters
  • request (Union[google.ads.admanager_v1.types.BatchDeactivateLineItemCreativeAssociationsRequest, dict]) – The request object. Request message for BatchDeactivateLineItemCreativeAssociations method.

  • parent (str) –

    Required. The parent resource where LineItemCreativeAssociations will be deactivated. This request supports using the “-” character as a wildcard for resources that span across multiple LineItem parents. Format: networks/{network_code}/lineItems/{line_item_id} Format: networks/{network_code}/lineItems/-

    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 LineItemCreativeAssociation objects to deactivate. A maximum of 1000 objects can be deactivated in a batch. Format: networks/{network_code}/lineItems/{line_item_id}/creatives/{creative_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 BatchDeactivateLineItemCreativeAssociations method.

Return type

google.ads.admanager_v1.types.BatchDeactivateLineItemCreativeAssociationsResponse

batch_delete_line_item_creative_associations(request: Optional[Union[google.ads.admanager_v1.types.line_item_creative_association_service.BatchDeleteLineItemCreativeAssociationsRequest, 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]

Deletes a list of LineItemCreativeAssociation 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_item_creative_associations():
    # Create a client
    client = admanager_v1.LineItemCreativeAssociationServiceClient()

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

    # Make the request
    client.batch_delete_line_item_creative_associations(request=request)
Parameters
  • request (Union[google.ads.admanager_v1.types.BatchDeleteLineItemCreativeAssociationsRequest, dict]) – The request object. Request message for BatchDeleteLineItemCreativeAssociations method.

  • parent (str) –

    Required. The parent resource where LineItemCreativeAssociations will be deleted. This request supports using the “-” character as a wildcard for resources that span across multiple LineItem parents. Format: networks/{network_code}/lineItems/{line_item_id} Format: networks/{network_code}/lineItems/-

    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 LineItemCreativeAssociation objects to delete. A maximum of 1000 objects can be deleted in a batch. Format: networks/{network_code}/lineItems/{line_item_id}/creatives/{creative_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.

batch_update_line_item_creative_associations(request: Optional[Union[google.ads.admanager_v1.types.line_item_creative_association_service.BatchUpdateLineItemCreativeAssociationsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.line_item_creative_association_service.UpdateLineItemCreativeAssociationRequest]] = 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_creative_association_service.BatchUpdateLineItemCreativeAssociationsResponse[source]

Batch updates LineItemCreativeAssociation 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_item_creative_associations():
    # Create a client
    client = admanager_v1.LineItemCreativeAssociationServiceClient()

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

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

    # Handle the response
    print(response)
Parameters
  • request (Union[google.ads.admanager_v1.types.BatchUpdateLineItemCreativeAssociationsRequest, dict]) – The request object. Request object for BatchUpdateLineItemCreativeAssociations method.

  • parent (str) –

    Required. The parent resource where LineItemCreativeAssociations will be updated. This request supports using the “-” character as a wildcard for resources that span across multiple LineItem parents. Format: networks/{network_code}/lineItems/{line_item_id} Format: networks/{network_code}/lineItems/-

    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.UpdateLineItemCreativeAssociationRequest]) –

    Required. The LineItemCreativeAssociation 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 BatchUpdateLineItemCreativeAssociations method.

Return type

google.ads.admanager_v1.types.BatchUpdateLineItemCreativeAssociationsResponse

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 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_line_item_creative_association(request: Optional[Union[google.ads.admanager_v1.types.line_item_creative_association_service.CreateLineItemCreativeAssociationRequest, dict]] = None, *, parent: Optional[str] = None, line_item_creative_association: Optional[google.ads.admanager_v1.types.line_item_creative_association_messages.LineItemCreativeAssociation] = 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_creative_association_messages.LineItemCreativeAssociation[source]

Creates a LineItemCreativeAssociation 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_creative_association():
    # Create a client
    client = admanager_v1.LineItemCreativeAssociationServiceClient()

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

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

    # Handle the response
    print(response)
Parameters
  • request (Union[google.ads.admanager_v1.types.CreateLineItemCreativeAssociationRequest, dict]) – The request object. Request object for CreateLineItemCreativeAssociation method.

  • parent (str) –

    Required. The parent resource where this LineItemCreativeAssociation will be created. Format: networks/{network_code}/lineItems/{line_item_id}

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • line_item_creative_association (google.ads.admanager_v1.types.LineItemCreativeAssociation) – Required. The LineItemCreativeAssociation to create. This corresponds to the line_item_creative_association 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 LineItemCreativeAssociation associates a

[Creative][google.ads.admanager.v1.Creative] or [CreativeSet][google.ads.admanager.v1.CreativeSet] with a [LineItem][google.ads.admanager.v1.LineItem] so that the creative can be served in ad units targeted by the line item.

Return type

google.ads.admanager_v1.types.LineItemCreativeAssociation

static creative_path(network_code: str, creative: str) → str[source]

Returns a fully-qualified creative string.

static creative_set_path(network_code: str, creative_set: str) → str[source]

Returns a fully-qualified creative_set 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

LineItemCreativeAssociationServiceClient

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

LineItemCreativeAssociationServiceClient

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

LineItemCreativeAssociationServiceClient

get_line_item_creative_association(request: Optional[Union[google.ads.admanager_v1.types.line_item_creative_association_service.GetLineItemCreativeAssociationRequest, 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_creative_association_messages.LineItemCreativeAssociation[source]

Retrieves a LineItemCreativeAssociation 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_creative_association():
    # Create a client
    client = admanager_v1.LineItemCreativeAssociationServiceClient()

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

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

    # Handle the response
    print(response)
Parameters
  • request (Union[google.ads.admanager_v1.types.GetLineItemCreativeAssociationRequest, dict]) – The request object. Request object for GetLineItemCreativeAssociation method.

  • name (str) –

    Required. The resource name of the LineItemCreativeAssociation. Format: networks/{network_code}/lineItems/{line_item_id}/creatives/{creative_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 LineItemCreativeAssociation associates a

[Creative][google.ads.admanager.v1.Creative] or [CreativeSet][google.ads.admanager.v1.CreativeSet] with a [LineItem][google.ads.admanager.v1.LineItem] so that the creative can be served in ad units targeted by the line item.

Return type

google.ads.admanager_v1.types.LineItemCreativeAssociation

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 line_item_creative_association_path(network_code: str, line_item: str, creative: str) → str[source]

Returns a fully-qualified line_item_creative_association string.

static line_item_path(network_code: str, line_item: str) → str[source]

Returns a fully-qualified line_item string.

list_line_item_creative_associations(request: Optional[Union[google.ads.admanager_v1.types.line_item_creative_association_service.ListLineItemCreativeAssociationsRequest, 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_creative_association_service.pagers.ListLineItemCreativeAssociationsPager[source]

Lists LineItemCreativeAssociation 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_item_creative_associations():
    # Create a client
    client = admanager_v1.LineItemCreativeAssociationServiceClient()

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

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
  • request (Union[google.ads.admanager_v1.types.ListLineItemCreativeAssociationsRequest, dict]) – The request object. Request object for ListLineItemCreativeAssociations method.

  • parent (str) –

    Required. The parent, which owns this collection of LineItemCreativeAssociations. This request supports using the “-” character as a wildcard for resources that span across multiple LineItem parents. Format: networks/{network_code}/lineItems/{line_item_id} Format: networks/{network_code}/lineItems/-

    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 ListLineItemCreativeAssociationsRequest containing

matching LineItemCreativeAssociation objects.

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

Return type

google.ads.admanager_v1.services.line_item_creative_association_service.pagers.ListLineItemCreativeAssociationsPager

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_creative_path(path: str) → Dict[str, str][source]

Parses a creative path into its component segments.

static parse_creative_set_path(path: str) → Dict[str, str][source]

Parses a creative_set path into its component segments.

static parse_line_item_creative_association_path(path: str) → Dict[str, str][source]

Parses a line_item_creative_association 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.

preview_line_item_creative_association(request: Optional[Union[google.ads.admanager_v1.types.line_item_creative_association_service.PreviewLineItemCreativeAssociationRequest, dict]] = None, *, name: Optional[str] = None, site_url: 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_creative_association_service.PreviewLineItemCreativeAssociationResponse[source]

Fetch previews for the [LineItemCreativeAssociation][google.ads.admanager.v1.LineItemCreativeAssociation].

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

    # Initialize request argument(s)
    request = admanager_v1.PreviewLineItemCreativeAssociationRequest(
        name="name_value",
        site_url="site_url_value",
    )

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

    # Handle the response
    print(response)
Parameters
  • request (Union[google.ads.admanager_v1.types.PreviewLineItemCreativeAssociationRequest, dict]) – The request object. Request message for PreviewLineItemCreativeAssociation method.

  • name (str) –

    Required. The name of the LineItemCreativeAssociation object to preview. Format: networks/{network_code}/lineItems/{line_item_id}/creatives/{creative_id}

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • site_url (str) –

    Required. The URL of the site that the creative should be previewed in

    This corresponds to the site_url 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 PreviewLineItemCreativeAssociation method.

Return type

google.ads.admanager_v1.types.PreviewLineItemCreativeAssociationResponse

property transport: google.ads.admanager_v1.services.line_item_creative_association_service.transports.base.LineItemCreativeAssociationServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

LineItemCreativeAssociationServiceTransport

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_creative_association(request: Optional[Union[google.ads.admanager_v1.types.line_item_creative_association_service.UpdateLineItemCreativeAssociationRequest, dict]] = None, *, line_item_creative_association: Optional[google.ads.admanager_v1.types.line_item_creative_association_messages.LineItemCreativeAssociation] = 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_creative_association_messages.LineItemCreativeAssociation[source]

Updates a LineItemCreativeAssociation 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_creative_association():
    # Create a client
    client = admanager_v1.LineItemCreativeAssociationServiceClient()

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

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

    # Handle the response
    print(response)
Parameters
  • request (Union[google.ads.admanager_v1.types.UpdateLineItemCreativeAssociationRequest, dict]) – The request object. Request object for UpdateLineItemCreativeAssociation method.

  • line_item_creative_association (google.ads.admanager_v1.types.LineItemCreativeAssociation) –

    Required. The LineItemCreativeAssociation to update. Format: networks/{network_code}/lineItems/{line_item_id}/creatives/{creative_id}

    This corresponds to the line_item_creative_association 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 LineItemCreativeAssociation associates a

[Creative][google.ads.admanager.v1.Creative] or [CreativeSet][google.ads.admanager.v1.CreativeSet] with a [LineItem][google.ads.admanager.v1.LineItem] so that the creative can be served in ad units targeted by the line item.

Return type

google.ads.admanager_v1.types.LineItemCreativeAssociation

class google.ads.admanager_v1.services.line_item_creative_association_service.pagers.ListLineItemCreativeAssociationsPager(method: Callable[[...], google.ads.admanager_v1.types.line_item_creative_association_service.ListLineItemCreativeAssociationsResponse], request: google.ads.admanager_v1.types.line_item_creative_association_service.ListLineItemCreativeAssociationsRequest, response: google.ads.admanager_v1.types.line_item_creative_association_service.ListLineItemCreativeAssociationsResponse, *, 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_item_creative_associations requests.

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

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

All the usual google.ads.admanager_v1.types.ListLineItemCreativeAssociationsResponse 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