ProposalService¶
- class google.ads.admanager_v1.services.proposal_service.ProposalServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.ads.admanager_v1.services.proposal_service.transports.base.ProposalServiceTransport, typing.Callable[[...], google.ads.admanager_v1.services.proposal_service.transports.base.ProposalServiceTransport]]] = 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
Proposalobjects.Instantiates the proposal 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,ProposalServiceTransport,Callable[..., ProposalServiceTransport]]]) – 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 ProposalServiceTransport 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_archive_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchArchiveProposalsRequest, 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.proposal_service.BatchArchiveProposalsResponse[source]¶
Archives
Proposalobjects.# 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_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchArchiveProposalsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_archive_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchArchiveProposalsRequest, dict]) – The request object. Request message for
BatchArchiveProposalsmethod.parent (str) –
Required. The parent resource where proposals will be archived. 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 Proposals to archive. Format:
networks/{network_code}/proposals/{proposal_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 message for BatchArchiveProposals method.
- Return type
- batch_create_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchCreateProposalsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.proposal_service.CreateProposalRequest]] = 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.proposal_service.BatchCreateProposalsResponse[source]¶
Creates
Proposalobjects.# 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_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) requests = admanager_v1.CreateProposalRequest() requests.parent = "parent_value" request = admanager_v1.BatchCreateProposalsRequest( parent="parent_value", requests=requests, ) # Make the request response = client.batch_create_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchCreateProposalsRequest, dict]) – The request object. Request object for
BatchCreateProposalsmethod.parent (str) –
Required. The parent resource where
Proposalswill be created. Format:networks/{network_code}The parent field in the CreateProposalRequest must match this field.This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.requests (MutableSequence[google.ads.admanager_v1.types.CreateProposalRequest]) –
Required. The
Proposalobjects 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 BatchCreateProposals method.
- Return type
- batch_discard_draft_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchDiscardDraftProposalsRequest, 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.proposal_service.BatchDiscardDraftProposalsResponse[source]¶
Discards drafts, or revert local modifications, of
Proposalobjects.# 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_discard_draft_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchDiscardDraftProposalsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_discard_draft_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchDiscardDraftProposalsRequest, dict]) – The request object. Request message for
BatchDiscardDraftProposalsmethod.parent (str) –
Required. The parent resource where proposals will be discarded. 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 Proposals to discard. Format:
networks/{network_code}/proposals/{proposal_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 message for BatchDiscardDraftProposals method.
- Return type
google.ads.admanager_v1.types.BatchDiscardDraftProposalsResponse
- batch_pause_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchPauseProposalsRequest, dict]] = None, *, parent: Optional[str] = None, names: Optional[MutableSequence[str]] = None, reason: 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.proposal_service.BatchPauseProposalsResponse[source]¶
Pauses
Proposalobjects.# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.ads import admanager_v1 def sample_batch_pause_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchPauseProposalsRequest( parent="parent_value", names=['names_value1', 'names_value2'], reason="reason_value", ) # Make the request response = client.batch_pause_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchPauseProposalsRequest, dict]) – The request object. Request message for
BatchPauseProposalsmethod.parent (str) –
Required. The parent resource where proposals will be paused. 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 Proposals to pause. Format:
networks/{network_code}/proposals/{proposal_id}This corresponds to the
namesfield on therequestinstance; ifrequestis provided, this should not be set.reason (str) –
Required. The reason for pausing the Proposals.
This corresponds to the
reasonfield 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 message for BatchPauseProposals method.
- Return type
- batch_push_to_order_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchPushToOrderProposalsRequest, 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.proposal_service.BatchPushToOrderProposalsResponse[source]¶
Push changes on
Proposals to correspondingOrders, after negotiations have been finalized.# 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_push_to_order_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchPushToOrderProposalsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_push_to_order_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchPushToOrderProposalsRequest, dict]) – The request object. Request message for
BatchPushToOrderProposalsmethod.parent (str) –
Required. The parent resource where proposals will be pushed to order. 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 Proposals to push to order. Format:
networks/{network_code}/proposals/{proposal_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 message for BatchPushToOrderProposals method.
- Return type
google.ads.admanager_v1.types.BatchPushToOrderProposalsResponse
- batch_redraft_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchRedraftProposalsRequest, 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.proposal_service.BatchRedraftProposalsResponse[source]¶
Redrafts
Proposalobjects for negotiation.# 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_redraft_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchRedraftProposalsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_redraft_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchRedraftProposalsRequest, dict]) – The request object. Request message for
BatchRedraftProposalsmethod.parent (str) –
Required. The parent resource where proposals will be redrafted. 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 Proposals to redraft. Format:
networks/{network_code}/proposals/{proposal_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 message for BatchRedraftProposals method.
- Return type
- batch_request_buyer_accept_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchRequestBuyerAcceptProposalsRequest, 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.proposal_service.BatchRequestBuyerAcceptProposalsResponse[source]¶
Requests buyer acceptance for
Proposalobjects.# 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_request_buyer_accept_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchRequestBuyerAcceptProposalsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_request_buyer_accept_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchRequestBuyerAcceptProposalsRequest, dict]) – The request object. Request message for
BatchRequestBuyerAcceptProposalsmethod.parent (str) –
Required. The parent resource where proposals will be accepted. 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 Proposals to request buyer accept. Format:
networks/{network_code}/proposals/{proposal_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 message for BatchRequestBuyerAcceptProposals method.
- Return type
google.ads.admanager_v1.types.BatchRequestBuyerAcceptProposalsResponse
- batch_request_buyer_review_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchRequestBuyerReviewProposalsRequest, 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.proposal_service.BatchRequestBuyerReviewProposalsResponse[source]¶
Requests buyer review for
Proposalobjects.# 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_request_buyer_review_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchRequestBuyerReviewProposalsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_request_buyer_review_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchRequestBuyerReviewProposalsRequest, dict]) – The request object. Request message for
BatchRequestBuyerReviewProposalsmethod.parent (str) –
Required. The parent resource where proposals will be reviewed. 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 Proposals to request buyer review. Format:
networks/{network_code}/proposals/{proposal_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 message for BatchRequestBuyerReviewProposals method.
- Return type
google.ads.admanager_v1.types.BatchRequestBuyerReviewProposalsResponse
- batch_reserve_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchReserveProposalsRequest, 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.proposal_service.BatchReserveProposalsResponse[source]¶
Reserves inventory for
Proposalobjects.# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.ads import admanager_v1 def sample_batch_reserve_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchReserveProposalsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_reserve_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchReserveProposalsRequest, dict]) – The request object. Request message for
BatchReserveProposalsmethod.parent (str) –
Required. The parent resource where proposals will be reserved. 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 Proposals to reserve. Format:
networks/{network_code}/proposals/{proposal_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 message for BatchReserveProposals method.
- Return type
- batch_resume_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchResumeProposalsRequest, 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.proposal_service.BatchResumeProposalsResponse[source]¶
Resumes
Proposalobjects.# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.ads import admanager_v1 def sample_batch_resume_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchResumeProposalsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_resume_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchResumeProposalsRequest, dict]) – The request object. Request message for
BatchResumeProposalsmethod.parent (str) –
Required. The parent resource where proposals will be resumed. 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 Proposals to resume. Format:
networks/{network_code}/proposals/{proposal_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 message for BatchResumeProposals method.
- Return type
- batch_terminate_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchTerminateProposalsRequest, 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.proposal_service.BatchTerminateProposalsResponse[source]¶
Terminates negotiation on
Proposalobjects.# 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_terminate_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchTerminateProposalsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_terminate_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchTerminateProposalsRequest, dict]) – The request object. Request message for
BatchTerminateProposalsmethod.parent (str) –
Required. The parent resource where proposals will be terminated. 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 Proposals to terminate. Format:
networks/{network_code}/proposals/{proposal_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 message for BatchTerminateProposals method.
- Return type
google.ads.admanager_v1.types.BatchTerminateProposalsResponse
- batch_unarchive_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchUnarchiveProposalsRequest, 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.proposal_service.BatchUnarchiveProposalsResponse[source]¶
Unarchives
Proposalobjects.# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.ads import admanager_v1 def sample_batch_unarchive_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchUnarchiveProposalsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request response = client.batch_unarchive_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchUnarchiveProposalsRequest, dict]) – The request object. Request message for
BatchUnarchiveProposalsmethod.parent (str) –
Required. The parent resource where proposals will be unarchived. 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 Proposals to unarchive. Format:
networks/{network_code}/proposals/{proposal_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 message for BatchUnarchiveProposals method.
- Return type
google.ads.admanager_v1.types.BatchUnarchiveProposalsResponse
- batch_update_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.BatchUpdateProposalsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.ads.admanager_v1.types.proposal_service.UpdateProposalRequest]] = 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.proposal_service.BatchUpdateProposalsResponse[source]¶
Batch updates
Proposalobjects.# 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_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.BatchUpdateProposalsRequest( parent="parent_value", ) # Make the request response = client.batch_update_proposals(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.BatchUpdateProposalsRequest, dict]) – The request object. Request object for
BatchUpdateProposalsmethod.parent (str) –
Required. The parent resource where
Proposalswill be updated. Format:networks/{network_code}The parent field in the UpdateProposalRequest must match this field.This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.requests (MutableSequence[google.ads.admanager_v1.types.UpdateProposalRequest]) –
Required. The
Proposalobjects to update. A maximum of 100 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 BatchUpdateProposals method.
- Return type
- 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 contact_path(network_code: str, contact: str) str[source]¶
Returns a fully-qualified contact 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_proposal(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.CreateProposalRequest, dict]] = None, *, parent: Optional[str] = None, proposal: Optional[google.ads.admanager_v1.types.proposal_messages.Proposal] = 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.proposal_messages.Proposal[source]¶
Creates a
Proposalobject.# 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_proposal(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.CreateProposalRequest( parent="parent_value", ) # Make the request response = client.create_proposal(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.CreateProposalRequest, dict]) – The request object. Request object for
CreateProposalmethod.parent (str) –
Required. The parent resource where this
Proposalwill be created. Format:networks/{network_code}This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.proposal (google.ads.admanager_v1.types.Proposal) – Required. The
Proposalto create. This corresponds to theproposalfield 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
A Proposal represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.
- Return type
- static custom_field_path(network_code: str, custom_field: str) str[source]¶
Returns a fully-qualified custom_field string.
- static custom_targeting_key_path(network_code: str, custom_targeting_key: str) str[source]¶
Returns a fully-qualified custom_targeting_key string.
- static custom_targeting_value_path(network_code: str, custom_targeting_value: str) str[source]¶
Returns a fully-qualified custom_targeting_value string.
- static device_capability_path(network_code: str, device_capability: str) str[source]¶
Returns a fully-qualified device_capability string.
- static device_category_path(network_code: str, device_category: str) str[source]¶
Returns a fully-qualified device_category string.
- static device_manufacturer_path(network_code: str, device_manufacturer: str) str[source]¶
Returns a fully-qualified device_manufacturer string.
- fetch_marketplace_comments(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.FetchMarketplaceCommentsRequest, 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.services.proposal_service.pagers.FetchMarketplaceCommentsPager[source]¶
Fetches MarketplaceComments made on
Proposals.# 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_fetch_marketplace_comments(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.FetchMarketplaceCommentsRequest( parent="parent_value", names=['names_value1', 'names_value2'], ) # Make the request page_result = client.fetch_marketplace_comments(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.FetchMarketplaceCommentsRequest, dict]) – The request object. Request message for
FetchMarketplaceCommentsmethod.parent (str) –
Required. The parent resource where MarketplaceComments will be fetched from. 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 Proposals for which to fetch marketplace comments. A maximum of 50 proposal names can be specified. Format:
networks/{network_code}/proposals/{proposal_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 message for FetchMarketplaceComments method.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.ads.admanager_v1.services.proposal_service.pagers.FetchMarketplaceCommentsPager
- 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_proposal(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.GetProposalRequest, 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.proposal_messages.Proposal[source]¶
Retrieves a
Proposalobject.# 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_proposal(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.GetProposalRequest( name="name_value", ) # Make the request response = client.get_proposal(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.GetProposalRequest, dict]) – The request object. Request object for
GetProposalmethod.name (str) –
Required. The resource name of the Proposal. Format:
networks/{network_code}/proposals/{proposal_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
A Proposal represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.
- Return type
- static inventory_url_path(network_code: str, inventory_url: str) str[source]¶
Returns a fully-qualified inventory_url string.
- static label_path(network_code: str, label: str) str[source]¶
Returns a fully-qualified label string.
- list_proposals(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.ListProposalsRequest, 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.proposal_service.pagers.ListProposalsPager[source]¶
Lists
Proposalobjects.# 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_proposals(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.ListProposalsRequest( parent="parent_value", ) # Make the request page_result = client.list_proposals(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.ListProposalsRequest, dict]) – The request object. Request object for
ListProposalsmethod.parent (str) –
Required. The parent, which owns this collection of Proposals. 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 ListProposalsRequest containing matching Proposal
objects.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.ads.admanager_v1.services.proposal_service.pagers.ListProposalsPager
- 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 order_path(network_code: str, order: str) str[source]¶
Returns a fully-qualified order 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_contact_path(path: str) Dict[str, str][source]¶
Parses a contact 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_field_path(path: str) Dict[str, str][source]¶
Parses a custom_field path into its component segments.
- static parse_custom_targeting_key_path(path: str) Dict[str, str][source]¶
Parses a custom_targeting_key path into its component segments.
- static parse_custom_targeting_value_path(path: str) Dict[str, str][source]¶
Parses a custom_targeting_value path into its component segments.
- static parse_device_capability_path(path: str) Dict[str, str][source]¶
Parses a device_capability path into its component segments.
- static parse_device_category_path(path: str) Dict[str, str][source]¶
Parses a device_category path into its component segments.
- static parse_device_manufacturer_path(path: str) Dict[str, str][source]¶
Parses a device_manufacturer path into its component segments.
- static parse_geo_target_path(path: str) Dict[str, str][source]¶
Parses a geo_target path into its component segments.
- static parse_inventory_url_path(path: str) Dict[str, str][source]¶
Parses a inventory_url path into its component segments.
- static parse_label_path(path: str) Dict[str, str][source]¶
Parses a label path into its component segments.
- static parse_mobile_carrier_path(path: str) Dict[str, str][source]¶
Parses a mobile_carrier path into its component segments.
- static parse_mobile_device_path(path: str) Dict[str, str][source]¶
Parses a mobile_device path into its component segments.
- static parse_mobile_device_submodel_path(path: str) Dict[str, str][source]¶
Parses a mobile_device_submodel path into its component segments.
- static parse_network_path(path: str) Dict[str, str][source]¶
Parses a network path into its component segments.
- static parse_operating_system_path(path: str) Dict[str, str][source]¶
Parses a operating_system path into its component segments.
- static parse_operating_system_version_path(path: str) Dict[str, str][source]¶
Parses a operating_system_version path into its component segments.
- static parse_order_path(path: str) Dict[str, str][source]¶
Parses a order path into its component segments.
- static parse_placement_path(path: str) Dict[str, str][source]¶
Parses a placement path into its component segments.
- static parse_proposal_path(path: str) Dict[str, str][source]¶
Parses a proposal 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_team_path(path: str) Dict[str, str][source]¶
Parses a team path into its component segments.
- static parse_user_path(path: str) Dict[str, str][source]¶
Parses a user path into its component segments.
- static placement_path(network_code: str, placement: str) str[source]¶
Returns a fully-qualified placement string.
- static proposal_path(network_code: str, proposal: str) str[source]¶
Returns a fully-qualified proposal 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.proposal_service.transports.base.ProposalServiceTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
ProposalServiceTransport
- 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_proposal(request: Optional[Union[google.ads.admanager_v1.types.proposal_service.UpdateProposalRequest, dict]] = None, *, proposal: Optional[google.ads.admanager_v1.types.proposal_messages.Proposal] = 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.proposal_messages.Proposal[source]¶
Updates a
Proposalobject.# 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_proposal(): # Create a client client = admanager_v1.ProposalServiceClient() # Initialize request argument(s) request = admanager_v1.UpdateProposalRequest( ) # Make the request response = client.update_proposal(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.UpdateProposalRequest, dict]) – The request object. Request object for
UpdateProposalmethod.proposal (google.ads.admanager_v1.types.Proposal) –
Required. The
Proposalto update.The
Proposal’snameis used to identify theProposalto update.This corresponds to the
proposalfield 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
A Proposal represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.
- Return type
- class google.ads.admanager_v1.services.proposal_service.pagers.FetchMarketplaceCommentsPager(method: Callable[[...], google.ads.admanager_v1.types.proposal_service.FetchMarketplaceCommentsResponse], request: google.ads.admanager_v1.types.proposal_service.FetchMarketplaceCommentsRequest, response: google.ads.admanager_v1.types.proposal_service.FetchMarketplaceCommentsResponse, *, 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
fetch_marketplace_commentsrequests.This class thinly wraps an initial
google.ads.admanager_v1.types.FetchMarketplaceCommentsResponseobject, and provides an__iter__method to iterate through itsmarketplace_commentsfield.If there are more pages, the
__iter__method will make additionalFetchMarketplaceCommentsrequests and continue to iterate through themarketplace_commentsfield on the corresponding responses.All the usual
google.ads.admanager_v1.types.FetchMarketplaceCommentsResponseattributes 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.FetchMarketplaceCommentsRequest) – The initial request object.
response (google.ads.admanager_v1.types.FetchMarketplaceCommentsResponse) – 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.
- class google.ads.admanager_v1.services.proposal_service.pagers.ListProposalsPager(method: Callable[[...], google.ads.admanager_v1.types.proposal_service.ListProposalsResponse], request: google.ads.admanager_v1.types.proposal_service.ListProposalsRequest, response: google.ads.admanager_v1.types.proposal_service.ListProposalsResponse, *, 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_proposalsrequests.This class thinly wraps an initial
google.ads.admanager_v1.types.ListProposalsResponseobject, and provides an__iter__method to iterate through itsproposalsfield.If there are more pages, the
__iter__method will make additionalListProposalsrequests and continue to iterate through theproposalsfield on the corresponding responses.All the usual
google.ads.admanager_v1.types.ListProposalsResponseattributes 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.ListProposalsRequest) – The initial request object.
response (google.ads.admanager_v1.types.ListProposalsResponse) – 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.