As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

ProgramsService¶

class google.shopping.merchant_accounts_v1beta.services.programs_service.ProgramsServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.shopping.merchant_accounts_v1beta.services.programs_service.transports.base.ProgramsServiceTransport, typing.Callable[[...], google.shopping.merchant_accounts_v1beta.services.programs_service.transports.base.ProgramsServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Service for program management.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the Free product listings program, which enables products from a merchant’s store to be shown across Google for free.

This service exposes methods to retrieve a merchant’s participation in all available programs, in addition to methods for explicitly enabling or disabling participation in each program.

Instantiates the programs service async 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,ProgramsServiceTransport,Callable[..., ProgramsServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the ProgramsServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async disable_program(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.programs.DisableProgramRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, 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.shopping.merchant_accounts_v1beta.types.programs.Program[source]¶

Disable participation in the specified program for the account. Executing this method requires admin access.

# 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.shopping import merchant_accounts_v1beta

async def sample_disable_program():
    # Create a client
    client = merchant_accounts_v1beta.ProgramsServiceAsyncClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.DisableProgramRequest(
        name="name_value",
    )

    # Make the request
    response = await client.disable_program(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.shopping.merchant_accounts_v1beta.types.DisableProgramRequest, dict]]) – The request object. Request message for the DisableProgram method.
name (str) –
Required. The name of the program for which to disable participation for the given account. Format: accounts/{account}/programs/{program}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Defines participation in a given program for the specified account.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant’s store to be shown across Google for free.

Return type

google.shopping.merchant_accounts_v1beta.types.Program

async enable_program(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.programs.EnableProgramRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, 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.shopping.merchant_accounts_v1beta.types.programs.Program[source]¶

Enable participation in the specified program for the account. Executing this method requires admin access.

# 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.shopping import merchant_accounts_v1beta

async def sample_enable_program():
    # Create a client
    client = merchant_accounts_v1beta.ProgramsServiceAsyncClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.EnableProgramRequest(
        name="name_value",
    )

    # Make the request
    response = await client.enable_program(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.shopping.merchant_accounts_v1beta.types.EnableProgramRequest, dict]]) – The request object. Request message for the EnableProgram method.
name (str) –
Required. The name of the program for which to enable participation for the given account. Format: accounts/{account}/programs/{program}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Defines participation in a given program for the specified account.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant’s store to be shown across Google for free.

Return type

google.shopping.merchant_accounts_v1beta.types.Program

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

ProgramsServiceAsyncClient

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

ProgramsServiceAsyncClient

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

ProgramsServiceAsyncClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_program(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.programs.GetProgramRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, 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.shopping.merchant_accounts_v1beta.types.programs.Program[source]¶

Retrieves the specified program for the account.

# 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.shopping import merchant_accounts_v1beta

async def sample_get_program():
    # Create a client
    client = merchant_accounts_v1beta.ProgramsServiceAsyncClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.GetProgramRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_program(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.shopping.merchant_accounts_v1beta.types.GetProgramRequest, dict]]) – The request object. Request message for the GetProgram method.
name (str) –
Required. The name of the program to retrieve. Format: accounts/{account}/programs/{program}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Defines participation in a given program for the specified account.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant’s store to be shown across Google for free.

Return type

google.shopping.merchant_accounts_v1beta.types.Program

classmethod get_transport_class(label: Optional[str] = None) → Type[google.shopping.merchant_accounts_v1beta.services.programs_service.transports.base.ProgramsServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_programs(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.programs.ListProgramsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, 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.shopping.merchant_accounts_v1beta.services.programs_service.pagers.ListProgramsAsyncPager[source]¶

Retrieves all programs for the account.

# 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.shopping import merchant_accounts_v1beta

async def sample_list_programs():
    # Create a client
    client = merchant_accounts_v1beta.ProgramsServiceAsyncClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.ListProgramsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.shopping.merchant_accounts_v1beta.types.ListProgramsRequest, dict]]) – The request object. Request message for the ListPrograms method.
parent (str) –
Required. The name of the account for which to retrieve all programs. Format: accounts/{account}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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 the ListPrograms method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.shopping.merchant_accounts_v1beta.services.programs_service.pagers.ListProgramsAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_program_path(path: str) → Dict[str, str]¶: Parses a program path into its component segments.

static program_path(account: str, program: str) → str¶: Returns a fully-qualified program string.

property transport: google.shopping.merchant_accounts_v1beta.services.programs_service.transports.base.ProgramsServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: ProgramsServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

class google.shopping.merchant_accounts_v1beta.services.programs_service.ProgramsServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.shopping.merchant_accounts_v1beta.services.programs_service.transports.base.ProgramsServiceTransport, typing.Callable[[...], google.shopping.merchant_accounts_v1beta.services.programs_service.transports.base.ProgramsServiceTransport]]] = 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]¶

Service for program management.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the Free product listings program, which enables products from a merchant’s store to be shown across Google for free.

This service exposes methods to retrieve a merchant’s participation in all available programs, in addition to methods for explicitly enabling or disabling participation in each program.

Instantiates the programs 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,ProgramsServiceTransport,Callable[..., ProgramsServiceTransport]]]) – 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 ProgramsServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

disable_program(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.programs.DisableProgramRequest, 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.shopping.merchant_accounts_v1beta.types.programs.Program[source]¶

Disable participation in the specified program for the account. Executing this method requires admin access.

# 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.shopping import merchant_accounts_v1beta

def sample_disable_program():
    # Create a client
    client = merchant_accounts_v1beta.ProgramsServiceClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.DisableProgramRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.shopping.merchant_accounts_v1beta.types.DisableProgramRequest, dict]) – The request object. Request message for the DisableProgram method.
name (str) –
Required. The name of the program for which to disable participation for the given account. Format: accounts/{account}/programs/{program}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

Defines participation in a given program for the specified account.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant’s store to be shown across Google for free.

Return type

google.shopping.merchant_accounts_v1beta.types.Program

enable_program(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.programs.EnableProgramRequest, 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.shopping.merchant_accounts_v1beta.types.programs.Program[source]¶

Enable participation in the specified program for the account. Executing this method requires admin access.

# 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.shopping import merchant_accounts_v1beta

def sample_enable_program():
    # Create a client
    client = merchant_accounts_v1beta.ProgramsServiceClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.EnableProgramRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.shopping.merchant_accounts_v1beta.types.EnableProgramRequest, dict]) – The request object. Request message for the EnableProgram method.
name (str) –
Required. The name of the program for which to enable participation for the given account. Format: accounts/{account}/programs/{program}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

Defines participation in a given program for the specified account.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant’s store to be shown across Google for free.

Return type

google.shopping.merchant_accounts_v1beta.types.Program

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

ProgramsServiceClient

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

ProgramsServiceClient

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

ProgramsServiceClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_program(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.programs.GetProgramRequest, 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.shopping.merchant_accounts_v1beta.types.programs.Program[source]¶

Retrieves the specified program for the account.

# 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.shopping import merchant_accounts_v1beta

def sample_get_program():
    # Create a client
    client = merchant_accounts_v1beta.ProgramsServiceClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.GetProgramRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.shopping.merchant_accounts_v1beta.types.GetProgramRequest, dict]) – The request object. Request message for the GetProgram method.
name (str) –
Required. The name of the program to retrieve. Format: accounts/{account}/programs/{program}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

Defines participation in a given program for the specified account.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant’s store to be shown across Google for free.

Return type

google.shopping.merchant_accounts_v1beta.types.Program

list_programs(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.programs.ListProgramsRequest, 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.shopping.merchant_accounts_v1beta.services.programs_service.pagers.ListProgramsPager[source]¶

Retrieves all programs for the account.

# 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.shopping import merchant_accounts_v1beta

def sample_list_programs():
    # Create a client
    client = merchant_accounts_v1beta.ProgramsServiceClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.ListProgramsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.shopping.merchant_accounts_v1beta.types.ListProgramsRequest, dict]) – The request object. Request message for the ListPrograms method.
parent (str) –
Required. The name of the account for which to retrieve all programs. Format: accounts/{account}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

Response message for the ListPrograms method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.shopping.merchant_accounts_v1beta.services.programs_service.pagers.ListProgramsPager

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

static program_path(account: str, program: str) → str[source]¶: Returns a fully-qualified program string.

property transport: google.shopping.merchant_accounts_v1beta.services.programs_service.transports.base.ProgramsServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

ProgramsServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

class google.shopping.merchant_accounts_v1beta.services.programs_service.pagers.ListProgramsAsyncPager(method: Callable[[...], Awaitable[google.shopping.merchant_accounts_v1beta.types.programs.ListProgramsResponse]], request: google.shopping.merchant_accounts_v1beta.types.programs.ListProgramsRequest, response: google.shopping.merchant_accounts_v1beta.types.programs.ListProgramsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, 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_programs requests.

This class thinly wraps an initial google.shopping.merchant_accounts_v1beta.types.ListProgramsResponse object, and provides an __aiter__ method to iterate through its programs field.

If there are more pages, the __aiter__ method will make additional ListPrograms requests and continue to iterate through the programs field on the corresponding responses.

All the usual google.shopping.merchant_accounts_v1beta.types.ListProgramsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.shopping.merchant_accounts_v1beta.types.ListProgramsRequest) – The initial request object.
response (google.shopping.merchant_accounts_v1beta.types.ListProgramsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.shopping.merchant_accounts_v1beta.services.programs_service.pagers.ListProgramsPager(method: Callable[[...], google.shopping.merchant_accounts_v1beta.types.programs.ListProgramsResponse], request: google.shopping.merchant_accounts_v1beta.types.programs.ListProgramsRequest, response: google.shopping.merchant_accounts_v1beta.types.programs.ListProgramsResponse, *, 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_programs requests.

This class thinly wraps an initial google.shopping.merchant_accounts_v1beta.types.ListProgramsResponse object, and provides an __iter__ method to iterate through its programs field.

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

All the usual google.shopping.merchant_accounts_v1beta.types.ListProgramsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.shopping.merchant_accounts_v1beta.types.ListProgramsRequest) – The initial request object.
response (google.shopping.merchant_accounts_v1beta.types.ListProgramsResponse) – 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.

ProgramsService¶

google-shopping-merchant-accounts

Navigation

Related Topics