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.

TargetingPresetService¶

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

Instantiates the targeting preset 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,TargetingPresetServiceTransport,Callable[..., TargetingPresetServiceTransport]]]) – 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 TargetingPresetServiceTransport 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_create_targeting_presets(request: Optional[Union[google.ads.admanager_v1.types.targeting_preset_service.BatchCreateTargetingPresetsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.targeting_preset_service.CreateTargetingPresetRequest]] = 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.targeting_preset_service.BatchCreateTargetingPresetsResponse[source]¶

Creates TargetingPreset 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_targeting_presets():
    # Create a client
    client = admanager_v1.TargetingPresetServiceClient()

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

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

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

    # Handle the response
    print(response)

Parameters

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

Return type

google.ads.admanager_v1.types.BatchCreateTargetingPresetsResponse

batch_deactivate_targeting_presets(request: Optional[Union[google.ads.admanager_v1.types.targeting_preset_service.BatchDeactivateTargetingPresetsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.targeting_preset_service.DeactivateTargetingPresetRequest]] = 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.targeting_preset_service.BatchDeactivateTargetingPresetsResponse[source]¶

Batch deactivates TargetingPreset 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_targeting_presets():
    # Create a client
    client = admanager_v1.TargetingPresetServiceClient()

    # Initialize request argument(s)
    requests = admanager_v1.DeactivateTargetingPresetRequest()
    requests.name = "name_value"
    requests.targeting_preset_id = 2019

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchDeactivateTargetingPresetsRequest, dict]) – The request object. Request message for BatchDeactivateTargetingPresets method.
parent (str) – Required. Format: networks/{network_code} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
requests (MutableSequence[google.ads.admanager_v1.types.DeactivateTargetingPresetRequest]) – Required. The TargetingPreset objects to deactivate. 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 message for DeactivateTargetingPresets method.

Return type

google.ads.admanager_v1.types.BatchDeactivateTargetingPresetsResponse

batch_update_targeting_presets(request: Optional[Union[google.ads.admanager_v1.types.targeting_preset_service.BatchUpdateTargetingPresetsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.targeting_preset_service.UpdateTargetingPresetRequest]] = 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.targeting_preset_service.BatchUpdateTargetingPresetsResponse[source]¶

Batch updates TargetingPreset 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_targeting_presets():
    # Create a client
    client = admanager_v1.TargetingPresetServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchUpdateTargetingPresetsRequest, dict]) – The request object. Request object for BatchUpdateTargetingPresets method.
parent (str) –
Required. The parent resource where TargetingPresets will be updated. Format: networks/{network_code} The parent field in the UpdateTargetingPresetRequest 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.UpdateTargetingPresetRequest]) –
Required. The TargetingPreset 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 BatchUpdateTargetingPresets method.

Return type

google.ads.admanager_v1.types.BatchUpdateTargetingPresetsResponse

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 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_targeting_preset(request: Optional[Union[google.ads.admanager_v1.types.targeting_preset_service.CreateTargetingPresetRequest, dict]] = None, *, parent: Optional[str] = None, targeting_preset: Optional[google.ads.admanager_v1.types.targeting_preset_messages.TargetingPreset] = 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.targeting_preset_messages.TargetingPreset[source]¶

Creates a TargetingPreset 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_targeting_preset():
    # Create a client
    client = admanager_v1.TargetingPresetServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.CreateTargetingPresetRequest, dict]) – The request object. Request object for CreateTargetingPreset method.
parent (str) –
Required. The parent resource where this TargetingPreset 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.
targeting_preset (google.ads.admanager_v1.types.TargetingPreset) – Required. The TargetingPreset to create. This corresponds to the targeting_preset 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

User-defined preset targeting criteria.

Return type

google.ads.admanager_v1.types.TargetingPreset

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

TargetingPresetServiceClient

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

TargetingPresetServiceClient

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

TargetingPresetServiceClient

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

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

get_targeting_preset(request: Optional[Union[google.ads.admanager_v1.types.targeting_preset_service.GetTargetingPresetRequest, 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.targeting_preset_messages.TargetingPreset[source]¶

Retrieves a TargetingPreset object. Note: Deactivated targeting presets are “logically deleted” (filtered out) by the get logic in the manager layer, so they will not be returned by the GetTargetingPreset RPC.

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

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

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

    # Handle the response
    print(response)

Parameters

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

User-defined preset targeting criteria.

Return type

google.ads.admanager_v1.types.TargetingPreset

list_targeting_presets(request: Optional[Union[google.ads.admanager_v1.types.targeting_preset_service.ListTargetingPresetsRequest, 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.targeting_preset_service.pagers.ListTargetingPresetsPager[source]¶

Lists TargetingPreset 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_targeting_presets():
    # Create a client
    client = admanager_v1.TargetingPresetServiceClient()

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

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

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

Parameters

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

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

Return type

google.ads.admanager_v1.services.targeting_preset_service.pagers.ListTargetingPresetsPager

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 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_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_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_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_placement_path(path: str) → Dict[str, str][source]¶: Parses a placement path into its component segments.

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

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

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

property transport: google.ads.admanager_v1.services.targeting_preset_service.transports.base.TargetingPresetServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

TargetingPresetServiceTransport

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_targeting_preset(request: Optional[Union[google.ads.admanager_v1.types.targeting_preset_service.UpdateTargetingPresetRequest, dict]] = None, *, targeting_preset: Optional[google.ads.admanager_v1.types.targeting_preset_messages.TargetingPreset] = 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.targeting_preset_messages.TargetingPreset[source]¶

Updates a TargetingPreset 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_targeting_preset():
    # Create a client
    client = admanager_v1.TargetingPresetServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.UpdateTargetingPresetRequest, dict]) – The request object. Request object for UpdateTargetingPreset method.
targeting_preset (google.ads.admanager_v1.types.TargetingPreset) –
Required. The TargetingPreset to update.

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

This corresponds to the targeting_preset 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

User-defined preset targeting criteria.

Return type

google.ads.admanager_v1.types.TargetingPreset

class google.ads.admanager_v1.services.targeting_preset_service.pagers.ListTargetingPresetsPager(method: Callable[[...], google.ads.admanager_v1.types.targeting_preset_service.ListTargetingPresetsResponse], request: google.ads.admanager_v1.types.targeting_preset_service.ListTargetingPresetsRequest, response: google.ads.admanager_v1.types.targeting_preset_service.ListTargetingPresetsResponse, *, 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_targeting_presets requests.

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

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

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

TargetingPresetService¶

google-ads-admanager

Navigation

Related Topics