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.

NativeStyleService¶

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

Instantiates the native style 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,NativeStyleServiceTransport,Callable[..., NativeStyleServiceTransport]]]) – 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 NativeStyleServiceTransport 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_native_styles(request: Optional[Union[google.ads.admanager_v1.types.native_style_service.BatchActivateNativeStylesRequest, 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.native_style_service.BatchActivateNativeStylesResponse[source]¶

Beginning of non-CRUD Activates a list of NativeStyle 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_native_styles():
    # Create a client
    client = admanager_v1.NativeStyleServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchActivateNativeStylesRequest, dict]) – The request object. Request object for BatchActivateNativeStyles method.
parent (str) – Required. Format: networks/{network_code} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
names (MutableSequence[str]) –
Required. Resource names for the NativeStyles. Format: networks/{network_code}/nativeStyles/{native_style_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 BatchActivateNativeStyles method.

Return type

google.ads.admanager_v1.types.BatchActivateNativeStylesResponse

batch_archive_native_styles(request: Optional[Union[google.ads.admanager_v1.types.native_style_service.BatchArchiveNativeStylesRequest, 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.native_style_service.BatchArchiveNativeStylesResponse[source]¶

Archives a list of NativeStyle 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_native_styles():
    # Create a client
    client = admanager_v1.NativeStyleServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchArchiveNativeStylesRequest, dict]) – The request object. Request object for BatchArchiveNativeStyles method.
parent (str) – Required. Format: networks/{network_code} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
names (MutableSequence[str]) –
Required. Resource names for the NativeStyles. Format: networks/{network_code}/nativeStyles/{native_style_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 BatchArchiveNativeStyles method.

Return type

google.ads.admanager_v1.types.BatchArchiveNativeStylesResponse

batch_create_native_styles(request: Optional[Union[google.ads.admanager_v1.types.native_style_service.BatchCreateNativeStylesRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.native_style_service.CreateNativeStyleRequest]] = 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.native_style_service.BatchCreateNativeStylesResponse[source]¶

Creates NativeStyle 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_native_styles():
    # Create a client
    client = admanager_v1.NativeStyleServiceClient()

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

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

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

    # Handle the response
    print(response)

Parameters

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

Return type

google.ads.admanager_v1.types.BatchCreateNativeStylesResponse

batch_deactivate_native_styles(request: Optional[Union[google.ads.admanager_v1.types.native_style_service.BatchDeactivateNativeStylesRequest, 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.native_style_service.BatchDeactivateNativeStylesResponse[source]¶

Deactivates a list of NativeStyle 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_native_styles():
    # Create a client
    client = admanager_v1.NativeStyleServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.ads.admanager_v1.types.BatchDeactivateNativeStylesRequest, dict]) – The request object. Request object for BatchDeactivateNativeStyles method.
parent (str) – Required. Format: networks/{network_code} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
names (MutableSequence[str]) –
Required. Resource names for the NativeStyles. Format: networks/{network_code}/nativeStyles/{native_style_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 BatchDeactivateNativeStyles method.

Return type

google.ads.admanager_v1.types.BatchDeactivateNativeStylesResponse

batch_update_native_styles(request: Optional[Union[google.ads.admanager_v1.types.native_style_service.BatchUpdateNativeStylesRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.native_style_service.UpdateNativeStyleRequest]] = 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.native_style_service.BatchUpdateNativeStylesResponse[source]¶

Batch updates NativeStyle 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_native_styles():
    # Create a client
    client = admanager_v1.NativeStyleServiceClient()

    # Initialize request argument(s)
    requests = admanager_v1.UpdateNativeStyleRequest()
    requests.native_style.size.width = 544
    requests.native_style.size.height = 633
    requests.native_style.size.size_type = "AUDIO"

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

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

    # Handle the response
    print(response)

Parameters

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

Return type

google.ads.admanager_v1.types.BatchUpdateNativeStylesResponse

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.

static creative_template_path(network_code: str, creative_template: str) → str[source]¶: Returns a fully-qualified creative_template 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

NativeStyleServiceClient

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

NativeStyleServiceClient

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

NativeStyleServiceClient

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_native_style(request: Optional[Union[google.ads.admanager_v1.types.native_style_service.GetNativeStyleRequest, 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.native_style_messages.NativeStyle[source]¶

Retrieves a NativeStyle 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_native_style():
    # Create a client
    client = admanager_v1.NativeStyleServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

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

Used to define the look and feel of native ads, for both web and apps. Native styles determine how native creatives look for a segment of inventory.

Return type

google.ads.admanager_v1.types.NativeStyle

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

Gets the latest state of a long-running operation.

Parameters

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

Returns

An Operation object.

Return type

Operation

list_native_styles(request: Optional[Union[google.ads.admanager_v1.types.native_style_service.ListNativeStylesRequest, 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.native_style_service.pagers.ListNativeStylesPager[source]¶

Lists NativeStyle 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_native_styles():
    # Create a client
    client = admanager_v1.NativeStyleServiceClient()

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

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

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

Parameters

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

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

Return type

google.ads.admanager_v1.services.native_style_service.pagers.ListNativeStylesPager

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 native_style_path(network_code: str, native_style: str) → str[source]¶: Returns a fully-qualified native_style 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_creative_template_path(path: str) → Dict[str, str][source]¶: Parses a creative_template 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_native_style_path(path: str) → Dict[str, str][source]¶: Parses a native_style 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 placement_path(network_code: str, placement: str) → str[source]¶: Returns a fully-qualified placement string.

property transport: google.ads.admanager_v1.services.native_style_service.transports.base.NativeStyleServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

NativeStyleServiceTransport

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

class google.ads.admanager_v1.services.native_style_service.pagers.ListNativeStylesPager(method: Callable[[...], google.ads.admanager_v1.types.native_style_service.ListNativeStylesResponse], request: google.ads.admanager_v1.types.native_style_service.ListNativeStylesRequest, response: google.ads.admanager_v1.types.native_style_service.ListNativeStylesResponse, *, 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_native_styles requests.

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

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

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

NativeStyleService¶

google-ads-admanager

Navigation

Related Topics