YieldGroupService¶
- class google.ads.admanager_v1.services.yield_group_service.YieldGroupServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.ads.admanager_v1.services.yield_group_service.transports.base.YieldGroupServiceTransport, typing.Callable[[...], google.ads.admanager_v1.services.yield_group_service.transports.base.YieldGroupServiceTransport]]] = 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
YieldGroupobjects.Instantiates the yield group 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,YieldGroupServiceTransport,Callable[..., YieldGroupServiceTransport]]]) – 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 YieldGroupServiceTransport 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_endpointproperty can be used to override the default endpoint provided by the client whentransportis not explicitly provided. Only if this property is not set andtransportwas 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_sourceproperty 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_domainproperty can be used to override the default “googleapis.com” universe. Note that theapi_endpointproperty still takes precedence; anduniverse_domainis 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_category_path(network_code: str, ad_category: str) str[source]¶
Returns a fully-qualified ad_category string.
- static ad_spot_path(network_code: str, ad_spot: str) str[source]¶
Returns a fully-qualified ad_spot string.
- 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
- 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_yield_groups(request: Optional[Union[google.ads.admanager_v1.types.yield_group_service.BatchActivateYieldGroupsRequest, 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.yield_group_service.BatchActivateYieldGroupsResponse[source]¶
Activates a list of
YieldGroupobjects.# 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_yield_groups(): # Create a client client = admanager_v1.YieldGroupServiceClient() # Initialize request argument(s) request = admanager_v1.BatchActivateYieldGroupsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_activate_yield_groups(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchActivateYieldGroupsRequest, dict]) – The request object. Request object for
BatchActivateYieldGroupsmethod.parent (str) –
Required. The parent, which owns this collection of
YieldGroups. Format:networks/{network_code}This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.names (MutableSequence[str]) –
Required. The resource names of the
YieldGroupsto activate. Format:networks/{network_code}/yieldGroups/{yield_group_id}This corresponds to the
namesfield on therequestinstance; ifrequestis 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 BatchActivateYieldGroups method.
- Return type
google.ads.admanager_v1.types.BatchActivateYieldGroupsResponse
- batch_archive_yield_groups(request: Optional[Union[google.ads.admanager_v1.types.yield_group_service.BatchArchiveYieldGroupsRequest, 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.yield_group_service.BatchArchiveYieldGroupsResponse[source]¶
Archives a list of
YieldGroupobjects.# 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_yield_groups(): # Create a client client = admanager_v1.YieldGroupServiceClient() # Initialize request argument(s) request = admanager_v1.BatchArchiveYieldGroupsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_archive_yield_groups(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchArchiveYieldGroupsRequest, dict]) – The request object. Request object for
BatchArchiveYieldGroupsmethod.parent (str) –
Required. The parent, which owns this collection of
YieldGroups. Format:networks/{network_code}This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.names (MutableSequence[str]) –
Required. The resource names of the
YieldGroupsto archive. Format:networks/{network_code}/yieldGroups/{yield_group_id}This corresponds to the
namesfield on therequestinstance; ifrequestis 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 BatchArchiveYieldGroups method.
- Return type
google.ads.admanager_v1.types.BatchArchiveYieldGroupsResponse
- batch_create_yield_groups(request: Optional[Union[google.ads.admanager_v1.types.yield_group_service.BatchCreateYieldGroupsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.yield_group_service.CreateYieldGroupRequest]] = 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.yield_group_service.BatchCreateYieldGroupsResponse[source]¶
Batch creates
YieldGroupobjects.# 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_yield_groups(): # Create a client client = admanager_v1.YieldGroupServiceClient() # Initialize request argument(s) requests = admanager_v1.CreateYieldGroupRequest() requests.parent = "parent_value" request = admanager_v1.BatchCreateYieldGroupsRequest( parent="parent_value", requests=requests, ) # Make the request response = client.batch_create_yield_groups(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchCreateYieldGroupsRequest, dict]) – The request object. Request object for
BatchCreateYieldGroupsmethod.parent (str) –
Required. The parent resource where
YieldGroupswill be created. Format:networks/{network_code}The parent field in theCreateYieldGroupRequestmust match this field.This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.requests (MutableSequence[google.ads.admanager_v1.types.CreateYieldGroupRequest]) –
Required. The
YieldGroupobjects to create. A maximum of 100 objects can be created in a batch.This corresponds to the
requestsfield on therequestinstance; ifrequestis 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 BatchCreateYieldGroups method.
- Return type
google.ads.admanager_v1.types.BatchCreateYieldGroupsResponse
- batch_deactivate_yield_groups(request: Optional[Union[google.ads.admanager_v1.types.yield_group_service.BatchDeactivateYieldGroupsRequest, 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.yield_group_service.BatchDeactivateYieldGroupsResponse[source]¶
Deactivates a list of
YieldGroupobjects.# 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_yield_groups(): # Create a client client = admanager_v1.YieldGroupServiceClient() # Initialize request argument(s) request = admanager_v1.BatchDeactivateYieldGroupsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_deactivate_yield_groups(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchDeactivateYieldGroupsRequest, dict]) – The request object. Request object for
BatchDeactivateYieldGroupsmethod.parent (str) –
Required. The parent, which owns this collection of
YieldGroups. Format:networks/{network_code}This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.names (MutableSequence[str]) –
Required. The resource names of the
YieldGroupsto deactivate. Format:networks/{network_code}/yieldGroups/{yield_group_id}This corresponds to the
namesfield on therequestinstance; ifrequestis 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 BatchDeactivateYieldGroups method.
- Return type
google.ads.admanager_v1.types.BatchDeactivateYieldGroupsResponse
- batch_update_yield_groups(request: Optional[Union[google.ads.admanager_v1.types.yield_group_service.BatchUpdateYieldGroupsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.yield_group_service.UpdateYieldGroupRequest]] = 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.yield_group_service.BatchUpdateYieldGroupsResponse[source]¶
Batch updates
YieldGroupobjects.# 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_yield_groups(): # Create a client client = admanager_v1.YieldGroupServiceClient() # Initialize request argument(s) request = admanager_v1.BatchUpdateYieldGroupsRequest( parent="parent_value", ) # Make the request response = client.batch_update_yield_groups(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchUpdateYieldGroupsRequest, dict]) – The request object. Request object for
BatchUpdateYieldGroupsmethod.parent (str) –
Required. The parent resource where
YieldGroupswill be updated. Format:networks/{network_code}The parent field in theUpdateYieldGroupRequestmust match this field.This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.requests (MutableSequence[google.ads.admanager_v1.types.UpdateYieldGroupRequest]) –
Required. The
YieldGroupobjects to update. A maximum of 10 objects can be updated in a batch.This corresponds to the
requestsfield on therequestinstance; ifrequestis 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 BatchUpdateYieldGroups method.
- Return type
google.ads.admanager_v1.types.BatchUpdateYieldGroupsResponse
- 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_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 company_path(network_code: str, company: str) str[source]¶
Returns a fully-qualified company string.
- static content_bundle_path(network_code: str, content_bundle: str) str[source]¶
Returns a fully-qualified content_bundle string.
- static content_label_path(network_code: str, content_label: str) str[source]¶
Returns a fully-qualified content_label string.
- static content_path(network_code: str, content: str) str[source]¶
Returns a fully-qualified content string.
- create_yield_group(request: Optional[Union[google.ads.admanager_v1.types.yield_group_service.CreateYieldGroupRequest, dict]] = None, *, parent: Optional[str] = None, yield_group: Optional[google.ads.admanager_v1.types.yield_group_messages.YieldGroup] = 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.yield_group_messages.YieldGroup[source]¶
Creates a
YieldGroupobject.# 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_yield_group(): # Create a client client = admanager_v1.YieldGroupServiceClient() # Initialize request argument(s) request = admanager_v1.CreateYieldGroupRequest( parent="parent_value", ) # Make the request response = client.create_yield_group(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.CreateYieldGroupRequest, dict]) – The request object. Request object for
CreateYieldGroupmethod.parent (str) –
Required. The parent resource where this
YieldGroupwill be created. Format:networks/{network_code}This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.yield_group (google.ads.admanager_v1.types.YieldGroup) – Required. The
YieldGroupto create. This corresponds to theyield_groupfield on therequestinstance; ifrequestis 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
Represents a segment of inventory and a set of yield partners that can monetize that inventory.
- Return type
- 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
- 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
- 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
- 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
- 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
Operationobject.- Return type
Operation
- get_yield_group(request: Optional[Union[google.ads.admanager_v1.types.yield_group_service.GetYieldGroupRequest, 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.yield_group_messages.YieldGroup[source]¶
Retrieves a
YieldGroupobject.# 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_yield_group(): # Create a client client = admanager_v1.YieldGroupServiceClient() # Initialize request argument(s) request = admanager_v1.GetYieldGroupRequest( name="name_value", ) # Make the request response = client.get_yield_group(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.GetYieldGroupRequest, dict]) – The request object. Request object for
GetYieldGroupmethod.name (str) –
Required. The resource name of the
YieldGroup. Format:networks/{network_code}/yieldGroups/{yield_group_id}This corresponds to the
namefield on therequestinstance; ifrequestis 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
Represents a segment of inventory and a set of yield partners that can monetize that inventory.
- Return type
- static inventory_url_path(network_code: str, inventory_url: str) str[source]¶
Returns a fully-qualified inventory_url string.
- list_yield_groups(request: Optional[Union[google.ads.admanager_v1.types.yield_group_service.ListYieldGroupsRequest, 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.yield_group_service.pagers.ListYieldGroupsPager[source]¶
Lists
YieldGroupobjects.# 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_yield_groups(): # Create a client client = admanager_v1.YieldGroupServiceClient() # Initialize request argument(s) request = admanager_v1.ListYieldGroupsRequest( parent="parent_value", ) # Make the request page_result = client.list_yield_groups(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.ListYieldGroupsRequest, dict]) – The request object. Request object for
ListYieldGroupsmethod.parent (str) –
Required. The parent, which owns this collection of
YieldGroups. Format:networks/{network_code}This corresponds to the
parentfield on therequestinstance; ifrequestis 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 ListYieldGroupsRequest containing matching YieldGroup
objects.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.ads.admanager_v1.services.yield_group_service.pagers.ListYieldGroupsPager
- 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 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_category_path(path: str) Dict[str, str][source]¶
Parses a ad_category path into its component segments.
- static parse_ad_spot_path(path: str) Dict[str, str][source]¶
Parses a ad_spot path into its component segments.
- static parse_ad_unit_path(path: str) Dict[str, str][source]¶
Parses a ad_unit path into its component segments.
- static parse_application_path(path: str) Dict[str, str][source]¶
Parses a application path into its component segments.
- static parse_audience_segment_path(path: str) Dict[str, str][source]¶
Parses a audience_segment path into its component segments.
- static parse_bandwidth_group_path(path: str) Dict[str, str][source]¶
Parses a bandwidth_group path into its component segments.
- static parse_browser_language_path(path: str) Dict[str, str][source]¶
Parses a browser_language path into its component segments.
- static parse_browser_path(path: str) Dict[str, str][source]¶
Parses a browser path into its component segments.
- static parse_cms_metadata_value_path(path: str) Dict[str, str][source]¶
Parses a cms_metadata_value path into its component segments.
- static parse_common_billing_account_path(path: str) Dict[str, str][source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str][source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str][source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str][source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str][source]¶
Parse a project path into its component segments.
- static parse_company_path(path: str) Dict[str, str][source]¶
Parses a company path into its component segments.
- static parse_content_bundle_path(path: str) Dict[str, str][source]¶
Parses a content_bundle path into its component segments.
- static parse_content_label_path(path: str) Dict[str, str][source]¶
Parses a content_label 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_inventory_url_path(path: str) Dict[str, str][source]¶
Parses a inventory_url 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_taxonomy_category_path(path: str) Dict[str, str][source]¶
Parses a taxonomy_category path into its component segments.
- static parse_yield_group_path(path: str) Dict[str, str][source]¶
Parses a yield_group path into its component segments.
- static placement_path(network_code: str, placement: str) str[source]¶
Returns a fully-qualified placement string.
- static taxonomy_category_path(network_code: str, taxonomy_category: str) str[source]¶
Returns a fully-qualified taxonomy_category string.
- property transport: google.ads.admanager_v1.services.yield_group_service.transports.base.YieldGroupServiceTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
YieldGroupServiceTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
The universe domain used by the client instance.
- Return type
- update_yield_group(request: Optional[Union[google.ads.admanager_v1.types.yield_group_service.UpdateYieldGroupRequest, dict]] = None, *, yield_group: Optional[google.ads.admanager_v1.types.yield_group_messages.YieldGroup] = 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.yield_group_messages.YieldGroup[source]¶
Updates a
YieldGroupobject.# 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_yield_group(): # Create a client client = admanager_v1.YieldGroupServiceClient() # Initialize request argument(s) request = admanager_v1.UpdateYieldGroupRequest( ) # Make the request response = client.update_yield_group(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.UpdateYieldGroupRequest, dict]) – The request object. Request object for
UpdateYieldGroupmethod.yield_group (google.ads.admanager_v1.types.YieldGroup) –
Required. The
YieldGroupto update.The
YieldGroup’snameis used to identify theYieldGroupto update.This corresponds to the
yield_groupfield on therequestinstance; ifrequestis 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_maskfield on therequestinstance; ifrequestis 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
Represents a segment of inventory and a set of yield partners that can monetize that inventory.
- Return type
- class google.ads.admanager_v1.services.yield_group_service.pagers.ListYieldGroupsPager(method: Callable[[...], google.ads.admanager_v1.types.yield_group_service.ListYieldGroupsResponse], request: google.ads.admanager_v1.types.yield_group_service.ListYieldGroupsRequest, response: google.ads.admanager_v1.types.yield_group_service.ListYieldGroupsResponse, *, 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_yield_groupsrequests.This class thinly wraps an initial
google.ads.admanager_v1.types.ListYieldGroupsResponseobject, and provides an__iter__method to iterate through itsyield_groupsfield.If there are more pages, the
__iter__method will make additionalListYieldGroupsrequests and continue to iterate through theyield_groupsfield on the corresponding responses.All the usual
google.ads.admanager_v1.types.ListYieldGroupsResponseattributes 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.ListYieldGroupsRequest) – The initial request object.
response (google.ads.admanager_v1.types.ListYieldGroupsResponse) – 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.