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.

AccountsService¶

class google.shopping.merchant_accounts_v1beta.services.accounts_service.AccountsServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.shopping.merchant_accounts_v1beta.services.accounts_service.transports.base.AccountsServiceTransport, typing.Callable[[...], google.shopping.merchant_accounts_v1beta.services.accounts_service.transports.base.AccountsServiceTransport]]] = '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 to support Accounts API.

Instantiates the accounts 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,AccountsServiceTransport,Callable[..., AccountsServiceTransport]]]) – 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 AccountsServiceTransport 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.

static account_path(account: str) → str¶: Returns a fully-qualified account string.

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 create_and_configure_account(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.CreateAndConfigureAccountRequest, dict]] = 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.accounts.Account[source]¶

Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new 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_create_and_configure_account():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceAsyncClient()

    # Initialize request argument(s)
    account = merchant_accounts_v1beta.Account()
    account.account_name = "account_name_value"
    account.language_code = "language_code_value"

    request = merchant_accounts_v1beta.CreateAndConfigureAccountRequest(
        account=account,
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.shopping.merchant_accounts_v1beta.types.CreateAndConfigureAccountRequest, dict]]) – The request object. Request message for the CreateAndConfigureAccount method.
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

An account.

Return type

google.shopping.merchant_accounts_v1beta.types.Account

async delete_account(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.DeleteAccountRequest, 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]]] = ()) → None[source]¶

Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the force parameter to override this.

# 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_delete_account():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceAsyncClient()

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

    # Make the request
    await client.delete_account(request=request)

Parameters

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

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.

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

AccountsServiceAsyncClient

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

AccountsServiceAsyncClient

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

AccountsServiceAsyncClient

async get_account(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.GetAccountRequest, 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.accounts.Account[source]¶

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

# 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_account():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceAsyncClient()

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

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

    # Handle the response
    print(response)

Parameters

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

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

An account.

Return type

google.shopping.merchant_accounts_v1beta.types.Account

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.

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

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_accounts(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.ListAccountsRequest, dict]] = 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.accounts_service.pagers.ListAccountsAsyncPager[source]¶

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to.

# 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_accounts():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceAsyncClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.ListAccountsRequest(
    )

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

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

Parameters

request (Optional[Union[google.shopping.merchant_accounts_v1beta.types.ListAccountsRequest, dict]]) – The request object. Request message for the ListAccounts method.
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 ListAccounts method.

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

Return type

google.shopping.merchant_accounts_v1beta.services.accounts_service.pagers.ListAccountsAsyncPager

async list_sub_accounts(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.ListSubAccountsRequest, dict]] = None, *, provider: 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.accounts_service.pagers.ListSubAccountsAsyncPager[source]¶

List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful ListAccounts method. This method will produce the same results as calling ListsAccounts with the following filter: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

# 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_sub_accounts():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceAsyncClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.ListSubAccountsRequest(
        provider="provider_value",
    )

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

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

Parameters

request (Optional[Union[google.shopping.merchant_accounts_v1beta.types.ListSubAccountsRequest, dict]]) – The request object. Request message for the ListSubAccounts method.
provider (str) –
Required. The parent account. Format: accounts/{account}

This corresponds to the provider 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 ListSubAccounts method.

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

Return type

google.shopping.merchant_accounts_v1beta.services.accounts_service.pagers.ListSubAccountsAsyncPager

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

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

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

static terms_of_service_path(version: str) → str¶: Returns a fully-qualified terms_of_service string.

property transport: google.shopping.merchant_accounts_v1beta.services.accounts_service.transports.base.AccountsServiceTransport¶

Returns the transport used by the client instance.

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

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

async update_account(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.UpdateAccountRequest, dict]] = None, *, account: Optional[google.shopping.merchant_accounts_v1beta.types.accounts.Account] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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.accounts.Account[source]¶

Updates an account regardless of its type: standalone, MCA or sub-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_update_account():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceAsyncClient()

    # Initialize request argument(s)
    account = merchant_accounts_v1beta.Account()
    account.account_name = "account_name_value"
    account.language_code = "language_code_value"

    request = merchant_accounts_v1beta.UpdateAccountRequest(
        account=account,
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.shopping.merchant_accounts_v1beta.types.UpdateAccountRequest, dict]]) – The request object. Request message for the UpdateAccount method.
account (google.shopping.merchant_accounts_v1beta.types.Account) –
Required. The new version of the account.

This corresponds to the account field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. List of fields being updated.

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

An account.

Return type

google.shopping.merchant_accounts_v1beta.types.Account

static user_path(account: str, email: str) → str¶: Returns a fully-qualified user string.

class google.shopping.merchant_accounts_v1beta.services.accounts_service.AccountsServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.shopping.merchant_accounts_v1beta.services.accounts_service.transports.base.AccountsServiceTransport, typing.Callable[[...], google.shopping.merchant_accounts_v1beta.services.accounts_service.transports.base.AccountsServiceTransport]]] = 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 to support Accounts API.

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

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

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

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

Raises

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

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

Warning

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

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

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.

create_and_configure_account(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.CreateAndConfigureAccountRequest, 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.shopping.merchant_accounts_v1beta.types.accounts.Account[source]¶

Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new 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_create_and_configure_account():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceClient()

    # Initialize request argument(s)
    account = merchant_accounts_v1beta.Account()
    account.account_name = "account_name_value"
    account.language_code = "language_code_value"

    request = merchant_accounts_v1beta.CreateAndConfigureAccountRequest(
        account=account,
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.shopping.merchant_accounts_v1beta.types.CreateAndConfigureAccountRequest, dict]) – The request object. Request message for the CreateAndConfigureAccount 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 account.

Return type

google.shopping.merchant_accounts_v1beta.types.Account

delete_account(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.DeleteAccountRequest, 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]]] = ()) → None[source]¶

Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the force parameter to override this.

# 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_delete_account():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceClient()

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

    # Make the request
    client.delete_account(request=request)

Parameters

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

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.

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

AccountsServiceClient

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

AccountsServiceClient

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

AccountsServiceClient

get_account(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.GetAccountRequest, 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.accounts.Account[source]¶

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

# 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_account():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

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

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

An account.

Return type

google.shopping.merchant_accounts_v1beta.types.Account

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.

list_accounts(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.ListAccountsRequest, 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.shopping.merchant_accounts_v1beta.services.accounts_service.pagers.ListAccountsPager[source]¶

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to.

# 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_accounts():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.ListAccountsRequest(
    )

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

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

Parameters

request (Union[google.shopping.merchant_accounts_v1beta.types.ListAccountsRequest, dict]) – The request object. Request message for the ListAccounts 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

Response message for the ListAccounts method.

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

Return type

google.shopping.merchant_accounts_v1beta.services.accounts_service.pagers.ListAccountsPager

list_sub_accounts(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.ListSubAccountsRequest, dict]] = None, *, provider: 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.accounts_service.pagers.ListSubAccountsPager[source]¶

List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful ListAccounts method. This method will produce the same results as calling ListsAccounts with the following filter: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

# 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_sub_accounts():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceClient()

    # Initialize request argument(s)
    request = merchant_accounts_v1beta.ListSubAccountsRequest(
        provider="provider_value",
    )

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

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

Parameters

request (Union[google.shopping.merchant_accounts_v1beta.types.ListSubAccountsRequest, dict]) – The request object. Request message for the ListSubAccounts method.
provider (str) –
Required. The parent account. Format: accounts/{account}

This corresponds to the provider 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 ListSubAccounts method.

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

Return type

google.shopping.merchant_accounts_v1beta.services.accounts_service.pagers.ListSubAccountsPager

static parse_account_path(path: str) → Dict[str, str][source]¶: Parses a account 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_terms_of_service_path(path: str) → Dict[str, str][source]¶: Parses a terms_of_service path into its component segments.

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

static terms_of_service_path(version: str) → str[source]¶: Returns a fully-qualified terms_of_service string.

property transport: google.shopping.merchant_accounts_v1beta.services.accounts_service.transports.base.AccountsServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

AccountsServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

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

update_account(request: Optional[Union[google.shopping.merchant_accounts_v1beta.types.accounts.UpdateAccountRequest, dict]] = None, *, account: Optional[google.shopping.merchant_accounts_v1beta.types.accounts.Account] = 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.shopping.merchant_accounts_v1beta.types.accounts.Account[source]¶

Updates an account regardless of its type: standalone, MCA or sub-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_update_account():
    # Create a client
    client = merchant_accounts_v1beta.AccountsServiceClient()

    # Initialize request argument(s)
    account = merchant_accounts_v1beta.Account()
    account.account_name = "account_name_value"
    account.language_code = "language_code_value"

    request = merchant_accounts_v1beta.UpdateAccountRequest(
        account=account,
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.shopping.merchant_accounts_v1beta.types.UpdateAccountRequest, dict]) – The request object. Request message for the UpdateAccount method.
account (google.shopping.merchant_accounts_v1beta.types.Account) –
Required. The new version of the account.

This corresponds to the account field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. List of fields being updated.

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

Returns

An account.

Return type

google.shopping.merchant_accounts_v1beta.types.Account

static user_path(account: str, email: str) → str[source]¶: Returns a fully-qualified user string.

class google.shopping.merchant_accounts_v1beta.services.accounts_service.pagers.ListAccountsAsyncPager(method: Callable[[...], Awaitable[google.shopping.merchant_accounts_v1beta.types.accounts.ListAccountsResponse]], request: google.shopping.merchant_accounts_v1beta.types.accounts.ListAccountsRequest, response: google.shopping.merchant_accounts_v1beta.types.accounts.ListAccountsResponse, *, 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_accounts requests.

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

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

All the usual google.shopping.merchant_accounts_v1beta.types.ListAccountsResponse 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.ListAccountsRequest) – The initial request object.
response (google.shopping.merchant_accounts_v1beta.types.ListAccountsResponse) – 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.accounts_service.pagers.ListAccountsPager(method: Callable[[...], google.shopping.merchant_accounts_v1beta.types.accounts.ListAccountsResponse], request: google.shopping.merchant_accounts_v1beta.types.accounts.ListAccountsRequest, response: google.shopping.merchant_accounts_v1beta.types.accounts.ListAccountsResponse, *, 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_accounts requests.

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

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

All the usual google.shopping.merchant_accounts_v1beta.types.ListAccountsResponse 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.ListAccountsRequest) – The initial request object.
response (google.shopping.merchant_accounts_v1beta.types.ListAccountsResponse) – 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.shopping.merchant_accounts_v1beta.services.accounts_service.pagers.ListSubAccountsAsyncPager(method: Callable[[...], Awaitable[google.shopping.merchant_accounts_v1beta.types.accounts.ListSubAccountsResponse]], request: google.shopping.merchant_accounts_v1beta.types.accounts.ListSubAccountsRequest, response: google.shopping.merchant_accounts_v1beta.types.accounts.ListSubAccountsResponse, *, 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_sub_accounts requests.

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

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

All the usual google.shopping.merchant_accounts_v1beta.types.ListSubAccountsResponse 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.ListSubAccountsRequest) – The initial request object.
response (google.shopping.merchant_accounts_v1beta.types.ListSubAccountsResponse) – 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.accounts_service.pagers.ListSubAccountsPager(method: Callable[[...], google.shopping.merchant_accounts_v1beta.types.accounts.ListSubAccountsResponse], request: google.shopping.merchant_accounts_v1beta.types.accounts.ListSubAccountsRequest, response: google.shopping.merchant_accounts_v1beta.types.accounts.ListSubAccountsResponse, *, 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_sub_accounts requests.

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

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

All the usual google.shopping.merchant_accounts_v1beta.types.ListSubAccountsResponse 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.ListSubAccountsRequest) – The initial request object.
response (google.shopping.merchant_accounts_v1beta.types.ListSubAccountsResponse) – 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.

AccountsService¶

google-shopping-merchant-accounts

Navigation

Related Topics