Package google.shopping.merchant.accounts.v1beta

Índice

AccountIssueService

Serviço para oferecer suporte à API AccountIssueService.

ListAccountIssues

rpc ListAccountIssues(ListAccountIssuesRequest) returns (ListAccountIssuesResponse)

Lista todos os problemas de uma conta do Merchant Center.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

AccountTaxService

Gerencia os dados de configuração de impostos no nível da conta.

Esta API define o seguinte modelo de recurso:

  • AccountTax
GetAccountTax

rpc GetAccountTax(GetAccountTaxRequest) returns (AccountTax)

Retorna as regras fiscais que correspondem às condições de GetAccountTaxRequest

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListAccountTax

rpc ListAccountTax(ListAccountTaxRequest) returns (ListAccountTaxResponse)

Lista as configurações de tributos das subcontas apenas na sua conta do Merchant Center. Esse método só pode ser chamado em uma conta de múltiplos clientes. Caso contrário, um erro será retornado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateAccountTax

rpc UpdateAccountTax(UpdateAccountTaxRequest) returns (AccountTax)

Atualiza as configurações de tributos da conta.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

AccountsService

Serviço para oferecer suporte à API Accounts.

CreateAndConfigureAccount

rpc CreateAndConfigureAccount(CreateAndConfigureAccountRequest) returns (Account)

Cria uma conta independente do Merchant Center com configurações adicionais. Adiciona o usuário que faz a solicitação como administrador da nova conta.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

Exclui a conta especificada, independentemente do tipo: independente, MCA ou subconta. A exclusão de uma MCA também remove todas as subcontas dela. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Recupera uma conta da sua conta do Merchant Center. Depois de inserir, atualizar ou excluir uma conta, pode levar alguns minutos até que as alterações entrem em vigor.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Lista as contas acessíveis ao usuário que fez a chamada e correspondem às restrições da solicitação, como tamanho ou filtros da página. Isso não apenas lista as subcontas de uma MCA, mas todas as contas que o usuário que faz a chamada tem acesso, incluindo outras MCAs, contas vinculadas, contas independentes e assim por diante.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListSubAccounts

rpc ListSubAccounts(ListSubAccountsRequest) returns (ListSubAccountsResponse)

Liste todas as subcontas de uma determinada conta de múltiplos clientes. Esse é um wrapper de conveniência para o método ListAccounts mais eficiente. Esse método produzirá os mesmos resultados que chamar ListsAccounts com o seguinte filtro: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Atualiza uma conta independentemente do tipo: independente, MCA ou subconta. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

BusinessIdentityService

Serviço com suporte à API Business Identity.

GetBusinessIdentity

rpc GetBusinessIdentity(GetBusinessIdentityRequest) returns (BusinessIdentity)

Recupera a identidade comercial de uma conta.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateBusinessIdentity

rpc UpdateBusinessIdentity(UpdateBusinessIdentityRequest) returns (BusinessIdentity)

Atualiza a identidade comercial de uma conta. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

BusinessInfoService

Serviço para oferecer suporte à API Business Info.

GetBusinessInfo

rpc GetBusinessInfo(GetBusinessInfoRequest) returns (BusinessInfo)

Recupera as informações comerciais de uma conta.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateBusinessInfo

rpc UpdateBusinessInfo(UpdateBusinessInfoRequest) returns (BusinessInfo)

Atualiza as informações comerciais de uma conta. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

EmailPreferencesService

Serviço para oferecer suporte à API EmailPreferences.

Esse serviço só permite recuperar e atualizar as preferências de e-mail do usuário autenticado.

GetEmailPreferences

rpc GetEmailPreferences(GetEmailPreferencesRequest) returns (EmailPreferences)

Retorna as preferências de e-mail de um usuário da conta do Merchant Center.

Use o alias name=accounts/*/users/me/emailPreferences para receber as preferências do usuário autenticado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateEmailPreferences

rpc UpdateEmailPreferences(UpdateEmailPreferencesRequest) returns (EmailPreferences)

Atualiza as preferências de e-mail de um usuário da conta do Merchant Center. Os usuários da MCA devem especificar a MCA em vez de uma subconta da MCA.

As preferências que não forem selecionadas explicitamente na máscara de atualização não serão atualizadas.

É inválido que as atualizações especifiquem um valor de status de ativação NÃO CONFIRMADO.

Use o alias name=accounts/*/users/me/emailPreferences para atualizar as preferências do usuário autenticado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

HomepageService

Serviço para oferecer suporte a uma API para a página inicial de uma loja.

ClaimHomepage

rpc ClaimHomepage(ClaimHomepageRequest) returns (Homepage)

Reivindica a página inicial de uma loja. A execução desse método requer acesso de administrador.

Se a página inicial já tiver sido reivindicada, a verificação será refeita (a menos que o comerciante esteja isento da reivindicação, o que também é isento da verificação) e retornará uma resposta positiva. Se a propriedade não puder mais ser verificada, um erro será retornado, mas a reivindicação não será apagada. Em caso de falha, uma mensagem de erro canônica será retornada: * PERMISSION_DENIED: o usuário não tem as permissões necessárias nesta conta do MC; * FAILED_PRECONDITION: - a conta não é do Merchant Center; - conta do Merchant Center não tem uma página inicial; - falha na reivindicação (nesse caso, a mensagem de erro vai conter mais detalhes).

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
GetHomepage

rpc GetHomepage(GetHomepageRequest) returns (Homepage)

Recupera a página inicial de uma loja.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UnclaimHomepage

rpc UnclaimHomepage(UnclaimHomepageRequest) returns (Homepage)

Cancela a reivindicação da página inicial de uma loja. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateHomepage

rpc UpdateHomepage(UpdateHomepageRequest) returns (Homepage)

Atualiza a página inicial de uma loja. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

OnlineReturnPolicyService

O serviço facilita o gerenciamento da configuração da política de devolução por arrependimento de um comerciante, abrangendo políticas de devolução de anúncios e listagens sem custo financeiro

programas. Esta API define o seguinte modelo de recurso:

[OnlineReturnPolicy][google.shopping.merchant.accounts.v1.OnlineReturnPolicy]

GetOnlineReturnPolicy

rpc GetOnlineReturnPolicy(GetOnlineReturnPolicyRequest) returns (OnlineReturnPolicy)

Recebe uma política de devolução existente.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListOnlineReturnPolicies

rpc ListOnlineReturnPolicies(ListOnlineReturnPoliciesRequest) returns (ListOnlineReturnPoliciesResponse)

Lista todas as políticas de devolução.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

ProgramsService

Serviço para gerenciamento de programas.

Os programas oferecem um mecanismo para adicionar funcionalidades às contas do comerciante. Um exemplo típico disso é o programa de listagens de produto sem custo financeiro, que permite que os produtos da loja de um comerciante sejam exibidos no Google sem custo financeiro.

Esse serviço apresenta métodos para recuperar a participação de um comerciante em todos os programas disponíveis, além de métodos para ativar ou desativar explicitamente a participação em cada programa.

DisableProgram

rpc DisableProgram(DisableProgramRequest) returns (Program)

Desativa a participação no programa especificado para a conta. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
EnableProgram

rpc EnableProgram(EnableProgramRequest) returns (Program)

Ativa a participação no programa especificado para a conta. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
GetProgram

rpc GetProgram(GetProgramRequest) returns (Program)

Recupera o programa especificado para a conta.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListPrograms

rpc ListPrograms(ListProgramsRequest) returns (ListProgramsResponse)

Recupera todos os programas da conta.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

RegionsService

Gerencia a configuração das regiões.

Esta API define o seguinte modelo de recurso:

  • Region
CreateRegion

rpc CreateRegion(CreateRegionRequest) returns (Region)

Cria uma definição de região na sua conta do Merchant Center. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
DeleteRegion

rpc DeleteRegion(DeleteRegionRequest) returns (Empty)

Exclui uma definição de região da sua conta do Merchant Center. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
GetRegion

rpc GetRegion(GetRegionRequest) returns (Region)

Recupera uma região definida na sua conta do Merchant Center.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListRegions

rpc ListRegions(ListRegionsRequest) returns (ListRegionsResponse)

Lista as regiões na sua conta do Merchant Center.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateRegion

rpc UpdateRegion(UpdateRegionRequest) returns (Region)

Atualiza uma definição de região na sua conta do Merchant Center. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

ShippingSettingsService

Serviço para receber informações de configuração de frete da chamada do método por método da API Merchant.

GetShippingSettings

rpc GetShippingSettings(GetShippingSettingsRequest) returns (ShippingSettings)

Recuperar informações de configuração de frete.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
InsertShippingSettings

rpc InsertShippingSettings(InsertShippingSettingsRequest) returns (ShippingSettings)

Substituir a configuração de frete de um comerciante pela configuração de frete da solicitação. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

TermsOfServiceAgreementStateService

Serviço para oferecer suporte à API TermsOfServiceAgreementState.

GetTermsOfServiceAgreementState

rpc GetTermsOfServiceAgreementState(GetTermsOfServiceAgreementStateRequest) returns (TermsOfServiceAgreementState)

Retorna o estado de um contrato de Termos de Serviço.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
RetrieveForApplicationTermsOfServiceAgreementState

rpc RetrieveForApplicationTermsOfServiceAgreementState(RetrieveForApplicationTermsOfServiceAgreementStateRequest) returns (TermsOfServiceAgreementState)

Recupera o estado do contrato para os Termos de Serviço do aplicativo.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

TermsOfServiceService

Serviço para oferecer suporte à API TermsOfService.

AcceptTermsOfService

rpc AcceptTermsOfService(AcceptTermsOfServiceRequest) returns (Empty)

Aceita um TermsOfService. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
GetTermsOfService

rpc GetTermsOfService(GetTermsOfServiceRequest) returns (TermsOfService)

Recupera o TermsOfService associado à versão fornecida.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
RetrieveLatestTermsOfService

rpc RetrieveLatestTermsOfService(RetrieveLatestTermsOfServiceRequest) returns (TermsOfService)

Recupera a versão mais recente do TermsOfService para um determinado kind e region_code.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

UserService

Serviço para dar suporte à API do usuário.

CreateUser

rpc CreateUser(CreateUserRequest) returns (User)

Cria um usuário da conta do Merchant Center. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
DeleteUser

rpc DeleteUser(DeleteUserRequest) returns (Empty)

Exclui um usuário da conta do Merchant Center. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
GetUser

rpc GetUser(GetUserRequest) returns (User)

Recupera um usuário da conta do Merchant Center.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListUsers

rpc ListUsers(ListUsersRequest) returns (ListUsersResponse)

Lista todos os usuários de uma conta do Merchant Center.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateUser

rpc UpdateUser(UpdateUserRequest) returns (User)

Atualiza um usuário da conta do Merchant Center. A execução desse método requer acesso de administrador.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

AcceptTermsOfServiceRequest

Solicite mensagem para o método AcceptTermsOfService.

Campos
name

string

Obrigatório. O nome do recurso da versão dos Termos de Serviço. Formato: termsOfService/{version}
account

string

Obrigatório. A conta em que os TOS serão aceitos.
region_code

string

Obrigatório. É o código de região, conforme definido pelo CLDR. os Termos de Serviço se aplicam especificamente a esse país ou o 001 quando se aplica a todo o mundo.

Convite aceito

Descreve os Termos de Serviço aceitos.

Campos
terms_of_service

string

Os termsOfService aceitos.
accepted_by

string

A conta em que a aceitação foi registrada. Pode ser a própria conta ou, no caso de subcontas, a conta da MCA.
valid_until

Date

Quando definido, ele declara que os TermsOfService aceitos são válidos apenas até o final desta data (em UTC). Uma nova precisa ser aceita antes disso. As informações dos TermsOfService obrigatórios estão na mensagem Obrigatório.

AccessRight

O direito de acesso.

Tipos enumerados
ACCESS_RIGHT_UNSPECIFIED Valor padrão. Esse valor não é usado.
STANDARD Direitos de acesso padrão.
ADMIN Direitos de acesso de administrador.
PERFORMANCE_REPORTING Usuários com esse direito têm acesso a performance e insights.

Conta

Uma conta.

Campos
name

string

Identificador. O nome de recurso da conta. Formato: accounts/{account}
account_id

int64

Apenas saída. O ID da conta.
account_name

string

Obrigatório. Um nome legível da conta. Consulte o nome da loja e o nome da empresa para mais informações.
adult_content

bool

Indica se esta conta possui conteúdo adulto.
test_account

bool

Apenas saída. Indica se esta é uma conta de teste.
time_zone

TimeZone

Obrigatório. O fuso horário da conta.

Nas gravações, time_zone define reporting_time_zone e display_time_zone.

Para leituras, time_zone sempre retorna o display_time_zone. Se display_time_zone não existir para sua conta, time_zone estará vazio.
language_code

string

Obrigatório. O código de idioma BCP-47 da conta, como en-US ou sr-Latn.

AccountIssue

Um AccountIssue.

Campos
name

string

Identificador. O nome do recurso do problema da conta. Formato: accounts/{account}/issues/{id}
title

string

O título localizado do problema.
severity

Severity

A gravidade geral do problema.
impacted_destinations[]

ImpactedDestination

O impacto que esse problema tem em vários destinos.
detail

string

Mais detalhes localizados sobre o problema.
documentation_uri

string

Link para a Central de Ajuda do Merchant Center com mais informações sobre o problema e como corrigi-lo.

ImpactedDestination

O impacto do problema em um destino.

Campos
impacts[]

Impact

O impacto (negativo) para várias regiões no destino especificado.
reporting_context

ReportingContextEnum

O contexto do relatório afetado.

Impacto

O impacto do problema em uma região.

Campos
region_code

string

O código regional do CLDR em que esse problema se aplica.
severity

Severity

A gravidade do problema no destino e na região.

Gravidade

Todas as gravidades possíveis do problema.

Tipos enumerados
SEVERITY_UNSPECIFIED A gravidade é desconhecida.
CRITICAL Esse problema faz com que as ofertas não sejam veiculadas.
ERROR O problema pode afetar as ofertas (no futuro) ou ser um indicador de problemas com elas.
SUGGESTION O problema é uma sugestão de melhoria.

AccountTax

As configurações fiscais de uma conta do comerciante. Todos os métodos exigem o papel de administrador.

Campos
name

string

Identificador. O nome da configuração de tributos. Formato: "{account_tax.name=accounts/{account}}"
account

int64

Apenas saída. O ID da conta a que essas configurações de tributos pertencem.
tax_rules[]

TaxRule

Regras fiscais. "Defina as regras fiscais em cada região. Nenhum tributo será apresentado se uma região não tiver uma regra."

Endereço

Endereço de entrega do depósito.

Campos
street_address

string

Parte do endereço no nível da rua. Por exemplo, 111w 31st Street.
city

string

Obrigatório. Cidade, município ou comuna. Também pode incluir localidades ou sublocalidades dependentes (por exemplo, bairros ou subúrbios).
administrative_area

string

Obrigatório. Subdivisão administrativa de nível superior do país. Por exemplo, um estado como a Califórnia ("CA") ou uma província como Quebec ("QC").
postal_code

string

Obrigatório. Código postal ou CEP (por exemplo, "94043").
region_code

string

Obrigatório. Código do país do CLDR (por exemplo, "US").

BusinessDayConfig

Dias úteis do armazém.

Campos
business_days[]

Weekday

Obrigatório. Dias úteis normais. Não pode ficar em branco.

Dia da semana

Tipos enumerados
WEEKDAY_UNSPECIFIED
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY

BusinessIdentity

Coleta de informações relacionadas à identidade de uma empresa.

Campos
name

string

Identificador. O nome do recurso da identidade da empresa. Formato: accounts/{account}/businessIdentity
black_owned

IdentityAttribute

Opcional. Especifica se a empresa se identifica como sendo de empreendedores negros. Este campo opcional só vai estar disponível para comerciantes com o país de negócios definido como US. Ela também não se aplica a marketplaces ou vendedores de marketplaces.
women_owned

IdentityAttribute

Opcional. Especifica se a empresa se identifica como uma empresa de propriedade de mulheres. Este campo opcional só vai estar disponível para comerciantes com o país de negócios definido como US. Ela também não se aplica a marketplaces ou vendedores de marketplaces.
veteran_owned

IdentityAttribute

Opcional. Especifica se a empresa se identifica como sendo de propriedade de veteranos. Este campo opcional só vai estar disponível para comerciantes com o país de negócios definido como US. Ela também não se aplica a marketplaces ou vendedores de marketplaces.
latino_owned

IdentityAttribute

Opcional. Especifica se a empresa se identifica como sendo de propriedade de latinos. Este campo opcional só vai estar disponível para comerciantes com o país de negócios definido como US. Ela também não se aplica a marketplaces ou vendedores de marketplaces.
small_business

IdentityAttribute

Opcional. Especifica se a empresa se identifica como pequena. Este campo opcional só vai estar disponível para comerciantes com o país de negócios definido como US. Ela também não se aplica a marketplaces.

IdentityAttribute

Todas as informações relacionadas a um atributo de identidade.

Campos
identity_declaration

IdentityDeclaration

Obrigatório. A declaração de identidade deste atributo.

IdentityDeclaration

Todas as configurações possíveis relacionadas à declaração de uma identidade.

Tipos enumerados
IDENTITY_DECLARATION_UNSPECIFIED Valor padrão que indica que nenhuma seleção foi feita.
SELF_IDENTIFIES_AS Indica que a conta se identifica com o atributo.
DOES_NOT_SELF_IDENTIFY_AS Indica que a conta não se identifica com o atributo.

PromotionsConsent

Todas as configurações possíveis sobre promoções relacionadas à identidade da empresa.

Tipos enumerados

BusinessInfo

Coleta de informações relacionadas a uma empresa.

Campos
name

string

Identificador. O nome do recurso das informações da empresa. Formato: accounts/{account}/businessInfo
address

PostalAddress

Opcional. O endereço da empresa.
phone

PhoneNumber

Opcional. O número de telefone da empresa.
phone_verification_state

PhoneVerificationState

Apenas saída. O estado de confirmação do telefone da empresa.
customer_service

CustomerService

Opcional. O atendimento ao cliente da empresa.

CarrierRate

Uma lista de taxas de transportadoras que podem ser indicadas por main_table ou single_value.

Campos
name

string

Obrigatório. Nome da taxa da transportadora. Precisa ser exclusivo por grupo de taxas.
carrier

string

Obrigatório. Serviço da operadora, como "UPS" ou "Fedex".
carrier_service

string

Obrigatório. Serviço da operadora, como "ground" ou "2 days".
origin_postal_code

string

Obrigatório. Origem do envio para esta taxa da transportadora.
percentage_adjustment

string

Opcional. Modificador de taxa de frete multiplicativa como um número em notação decimal. Pode ser negativo. Por exemplo, "5.4" aumenta a taxa em 5,4%, "-3" diminui a taxa em 3%.
flat_adjustment

Price

Opcional. Modificador aditivo da taxa de frete. Pode ser negativo. Por exemplo, { "amount_micros": 1, "currency_code" : "USD" } adiciona R $1,00 à taxa, { "amount_micros": -3, "currency_code" : "USD" } remove R $3,00 da taxa.

ClaimHomepageRequest

Solicite mensagem para o método ClaimHomepage.

Campos
name

string

Obrigatório. O nome da página inicial a ser reivindicada. Formato: accounts/{account}/homepage

CreateAndConfigureAccountRequest

Solicite mensagem para o método CreateAndConfigureAccount.

Campos
account

Account

Obrigatório. A conta a ser criada.
users[]

CreateUserRequest

Opcional. Usuários a serem adicionados à conta.
service[]

AddAccountService

Opcional. Se especificado, um serviço de conta entre a conta que será criada e a do provedor será inicializado como parte da criação.
accept_terms_of_service

AcceptTermsOfService

Opcional. Os Termos de Serviço (ToS) devem ser aceitos imediatamente após a criação da conta.

AcceptTermsOfService

Referência a um recurso de Termos de Serviço.

Campos
name

string

Obrigatório. O nome do recurso da versão dos Termos de Serviço.
region_code

string

Obrigatório. É o código de região, conforme definido pelo CLDR. Os TOS são válidos para os países em que os Termos de Serviço se aplicam especificamente a ele ou 001 quando são globais.

AddAccountService

Instruções adicionais para adicionar serviços durante a criação da conta.

Campos
Campo de união service_type. No momento, oferece suporte apenas ao tipo de conta de familiar responsável multicliente. service_type pode ser apenas de um dos tipos a seguir:
account_aggregation

Empty

O provedor é um agregador da conta.
provider

string

Opcional. O provedor do serviço. Formato: accounts/{account}

CreateRegionRequest

Solicite mensagem para o método CreateRegion.

Campos
parent

string

Obrigatório. A conta para a qual criar uma região. Formato: accounts/{account}
region_id

string

Obrigatório. O identificador da região, exclusivo em todas as regiões da mesma conta.
region

Region

Obrigatório. A região a ser criada.

CreateUserRequest

Solicite mensagem para o método CreateUser.

Campos
parent

string

Obrigatório. O nome do recurso da conta para a qual um usuário será criado. Formato: accounts/{account}
user_id

string

Obrigatório. O endereço de e-mail do usuário (por exemplo, john.doe@gmail.com).
user

User

Obrigatório. O usuário a ser criado.

CustomerService

Informações do atendimento ao cliente.

Campos
uri

string

Opcional. O URI em que o atendimento ao cliente pode ser encontrado.
email

string

Opcional. O endereço de e-mail para contato com o atendimento ao cliente.
phone

PhoneNumber

Opcional. O número de telefone para o qual o atendimento ao cliente pode ser chamado.

CutoffTime

Definição do horário limite para dias úteis.

Campos
hour

int32

Obrigatório. Hora do horário limite até que um pedido seja feito para ser processado no mesmo dia.
minute

int32

Obrigatório. Minuto do horário limite até o momento em que um pedido precisa ser feito para ser processado no mesmo dia.
time_zone

string

Obrigatório. Identificador de fuso horário, por exemplo, "Europa/Zurique".

DeleteAccountRequest

Solicite mensagem para o método DeleteAccount.

Campos
name

string

Obrigatório. O nome da conta a ser excluída. Formato: accounts/{account}

DeleteRegionRequest

Solicite mensagem para o método DeleteRegion.

Campos
name

string

Obrigatório. O nome da região a ser excluída. Formato: accounts/{account}/regions/{region}

DeleteUserRequest

Solicite mensagem para o método DeleteUser.

Campos
name

string

Obrigatório. O nome do usuário a ser excluído. Formato: accounts/{account}/users/{email}

Também é possível excluir o usuário correspondente ao autor da chamada usando me em vez de um endereço de e-mail, como em accounts/{account}/users/me.

DeliveryTime

Tempo gasto em vários aspectos do pedido até a entrega do produto.

Campos
warehouse_based_delivery_times[]

WarehouseBasedDeliveryTime

Opcional. Indica que o tempo de entrega deve ser calculado por armazém (local de origem do frete) com base nas configurações da transportadora selecionada. Quando definido, nenhum outro campo relacionado ao tempo em trânsito no [tempo de entrega][[google.shopping.content.bundles.ShippingSetting.DeliveryTime] precisa ser definido.
min_transit_days

int32

Número mínimo de dias úteis gasto em trânsito. 0 significa entrega no mesmo dia, 1 significa entrega no dia seguinte. Defina min_transit_days, max_transit_days ou transit_time_table, mas não ambos.
max_transit_days

int32

Número máximo de dias úteis gastos em trânsito. 0 significa entrega no mesmo dia, 1 significa entrega no dia seguinte. Precisa ser maior ou igual a min_transit_days.
cutoff_time

CutoffTime

Definição do horário limite para dias úteis. Se ele não for configurado, o horário limite será definido como 8h PST.
min_handling_days

int32

Número mínimo de dias úteis gastos antes do envio de um pedido. 0 significa enviado no mesmo dia, 1 significa enviado no dia seguinte.
max_handling_days

int32

O número máximo de dias úteis é gasto antes do envio de um pedido. 0 significa enviado no mesmo dia, 1 significa enviado no dia seguinte. Precisa ser maior ou igual a min_handling_days.
transit_time_table

TransitTable

Tabela de tempo em trânsito, número de dias úteis gastos em trânsito com base nas dimensões de linha e coluna. É possível definir min_transit_days, max_transit_days ou transit_time_table, mas não ambos.
handling_business_day_config

BusinessDayConfig

Os dias úteis durante os quais os pedidos podem ser processados. Se não for informado, serão considerados dias úteis de segunda a sexta-feira.
transit_business_day_config

BusinessDayConfig

Os dias úteis durante os quais os pedidos podem estar em trânsito. Se não for informado, serão considerados dias úteis de segunda a sexta-feira.

DisableProgramRequest

Mensagem de solicitação para o métodoDisableProgram.

Campos
name

string

Obrigatório. O nome do programa em que a participação da conta será desativada. Formato: accounts/{account}/programs/{program}

Distância

Raio máximo de entrega. Isso é necessário apenas para o tipo de frete para entrega local.

Campos
value

int64

Valor inteiro da distância.
unit

Unit

A unidade pode diferir com base no país. Ela é parametrizada para incluir milhas e quilômetros.

Unidade

A unidade pode diferir com base no país. Ela é parametrizada para incluir milhas e quilômetros.

Tipos enumerados
UNIT_UNSPECIFIED Unidade não especificada
MILES Unidade em milhas
KILOMETERS Unidade em quilômetros

EmailPreferences

As categorias de notificações que o usuário ativou ou desativou. As preferências de e-mail não incluem avisos obrigatórios porque os usuários não podem desativar essa opção.

Campos
name

string

Identificador. O nome de EmailPreferences. O endpoint só recebe suporte do usuário autenticado.
news_and_tips

OptInState

Opcional. Atualizações sobre novos recursos, dicas e práticas recomendadas.

OptInState

Estado de ativação da preferência de e-mail.

Tipos enumerados
OPT_IN_STATE_UNSPECIFIED O status de ativação não foi especificado.
OPTED_OUT O usuário desativou o recebimento desse tipo de e-mail.
OPTED_IN O usuário optou por receber este tipo de e-mail.
UNCONFIRMED O usuário optou por receber esse tipo de e-mail, e o e-mail de confirmação foi enviado, mas o usuário ainda não confirmou a ativação (aplicável somente a alguns países).

EnableProgramRequest

Mensagem de solicitação para o método EnableProgram.

Campos
name

string

Obrigatório. O nome do programa no qual ativar a participação para a conta em questão. Formato: accounts/{account}/programs/{program}

GetAccountRequest

Solicite mensagem para o método GetAccount.

Campos
name

string

Obrigatório. O nome da conta a ser recuperada. Formato: accounts/{account}

GetAccountTaxRequest

Solicitação para obter configurações de impostos

Campos
name

string

Obrigatório. O nome do qual as configurações de impostos serão recuperadas

GetBusinessIdentityRequest

Solicite mensagem para o método GetBusinessIdentity.

Campos
name

string

Obrigatório. O nome do recurso da identidade da empresa. Formato: accounts/{account}/businessIdentity

GetBusinessInfoRequest

Solicite mensagem para o método GetBusinessInfo.

Campos
name

string

Obrigatório. O nome do recurso das informações da empresa. Formato: accounts/{account}/businessInfo

GetEmailPreferencesRequest

Mensagem de solicitação para o método GetEmailPreferences.

Campos
name

string

Obrigatório. EmailPreferences: o nome do recurso. Formato: accounts/{account}/users/{email}/emailPreferences

GetHomepageRequest

Solicite mensagem para o método GetHomepage.

Campos
name

string

Obrigatório. O nome da página inicial a ser recuperada. Formato: accounts/{account}/homepage

GetOnlineReturnPolicyRequest

Solicite mensagem para o método GetOnlineReturnPolicy.

Campos
name

string

Obrigatório. O nome da política de devolução a ser recuperada. Formato: accounts/{account}/onlineReturnPolicies/{return_policy}

GetProgramRequest

Mensagem de solicitação para o método GetProgram.

Campos
name

string

Obrigatório. O nome do programa a ser recuperado. Formato: accounts/{account}/programs/{program}

GetRegionRequest

Solicite mensagem para o método GetRegion.

Campos
name

string

Obrigatório. O nome da região a ser recuperada. Formato: accounts/{account}/regions/{region}

GetShippingSettingsRequest

Solicite mensagem para o método GetShippingSetting.

Campos
name

string

Obrigatório. O nome da configuração de frete a ser recuperada. Formato: accounts/{account}/shippingsetting

GetTermsOfServiceAgreementStateRequest

Solicite mensagem para o método GetTermsOfServiceAgreementState.

Campos
name

string

Obrigatório. O nome do recurso da versão dos Termos de Serviço. Formato: accounts/{account}/termsOfServiceAgreementState/{identifier}

GetTermsOfServiceRequest

Solicite mensagem para o método GetTermsOfService.

Campos
name

string

Obrigatório. O nome do recurso da versão dos Termos de Serviço. Formato: termsOfService/{version}

GetUserRequest

Solicite mensagem para o método GetUser.

Campos
name

string

Obrigatório. O nome do usuário a ser recuperado. Formato: accounts/{account}/users/{email}

Também é possível extrair o usuário correspondente ao autor da chamada usando me em vez de um endereço de e-mail, como em accounts/{account}/users/me.

Cabeçalhos

Uma lista não vazia de cabeçalhos de linha ou coluna para uma tabela. Exatamente um de prices, weights, num_items, postal_code_group_names ou location precisa ser definido.

Campos
prices[]

Price

Obrigatório. Uma lista de limites superiores para preços de pedidos inclusivos. O valor do último preço pode ser infinito ao definir o preço amount_micros = -1. Por exemplo, [{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}] representa os cabeçalhos "<= US $10", "<= US $500" e "> US$ 500". Todos os preços de um serviço precisam ter a mesma moeda. Não pode ficar em branco. Precisa ser positivo, exceto -1. Só poderá ser definido se todos os outros campos não estiverem definidos.
weights[]

Weight

Obrigatório. Uma lista de limites superiores de ponderação de ordem inclusiva. O valor do último peso pode ser infinito, definindo preço amount_micros = -1. Por exemplo, [{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}] representa os cabeçalhos "<= 10 kg", "<= 50 kg" e "> 50 kg". Todos os pesos em um serviço precisam ter a mesma unidade. Não pode ficar em branco. Precisa ser positivo, exceto -1. Só poderá ser definido se todos os outros campos não estiverem definidos.
number_of_items[]

string

Obrigatório. Uma lista de números inclusivos de limites superiores de itens. O último valor pode ser "infinity". Por exemplo, ["10", "50", "infinity"] representa os cabeçalhos "<= 10 items", "<= 50 items" e "> 50 items". Não pode ficar em branco. Só poderá ser definido se todos os outros campos não estiverem definidos.
postal_code_group_names[]

string

Obrigatório. Uma lista de nomes de grupos postais. O último valor pode ser "all other locations". Exemplo: ["zone 1", "zone 2", "all other locations"]. Os grupos de CEPs indicados precisam corresponder ao país de entrega do serviço. Não pode ficar em branco. Só poderá ser definido se todos os outros campos não estiverem definidos.
locations[]

LocationIdSet

Obrigatório. Uma lista de conjuntos de IDs de local. Não pode ficar em branco. Só poderá ser definido se todos os outros campos não estiverem definidos.

Página inicial

A página inicial de uma loja.

Campos
name

string

Identificador. O nome do recurso da página inicial da loja. Formato: accounts/{account}/homepage
claimed

bool

Apenas saída. Se a página inicial foi reivindicada. Consulte https://support.google.com/merchants/answer/176793.
uri

string

Obrigatório. O URI (normalmente um URL) da página inicial da loja.

InsertShippingSettingsRequest

Solicite mensagem para o método InsertShippingSetting.

Campos
parent

string

Obrigatório. A conta em que este produto será inserido. Formato: accounts/{account}
shipping_setting

ShippingSettings

Obrigatório. A nova versão da conta.

ListAccountIssuesRequest

Solicite mensagem para o método ListAccountIssues.

Campos
parent

string

Obrigatório. O pai, proprietário dessa coleção de problemas. Formato: accounts/{account}
page_size

int32

Opcional. O número máximo de problemas a serem retornados. O serviço pode retornar menos que esse valor. Se não for especificado, serão retornados no máximo 50 usuários. O valor máximo é 100. Valores acima de 100 serão forçados para 100.
page_token

string

Opcional. Um token de página recebido de uma chamada ListAccountIssues anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListAccountIssues precisam corresponder à chamada que forneceu o token da página.
language_code

string

Opcional. Os problemas na resposta terão campos legíveis na linguagem indicada. O formato é BCP-47, como en-US ou sr-Latn. Se nenhum valor for fornecido, en-US será usado.
time_zone

TimeZone

Opcional. O fuso horário IANA usado para localizar horários em campos legíveis por humanos. Por exemplo, "América/Los_Angeles". Se não for definido, 'América/Los_Angeles' será usado.

ListAccountIssuesResponse

Mensagem de resposta para o método ListAccountIssues.

Campos
account_issues[]

AccountIssue

Os problemas da conta especificada.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListAccountTaxRequest

Solicitar a listagem de todas as configurações de tributos da subconta apenas para o comerciante solicitante. Esse método só pode ser chamado em uma conta de múltiplos clientes. Caso contrário, um erro será exibido.

Campos
parent

string

Obrigatório. A entidade pai, proprietária desse conjunto de tributos da conta. Formato: accounts/{account}
page_size

int32

O número máximo de configurações de tributos a serem retornados na resposta, usado para paginação.
page_token

string

O token retornado pela solicitação anterior.

ListAccountTaxResponse

Resposta à solicitação de lista de impostos da conta. Esse método só pode ser chamado em uma conta de múltiplos clientes. Caso contrário, retornará um erro.

Campos
account_taxes[]

AccountTax

Página de configurações de accounttax
next_page_token

string

O token para recuperação da próxima página de configurações de tributos da conta.

ListAccountsRequest

Solicite mensagem para o método ListAccounts.

Campos
page_size

int32

Opcional. O número máximo de contas a serem retornadas. O serviço pode retornar menos que esse valor. Se não for especificado, serão retornadas no máximo 250 contas. O valor máximo é 500. Valores acima de 500 serão forçados para 500.
page_token

string

Opcional. Um token de página recebido de uma chamada ListAccounts anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListAccounts precisam corresponder à chamada que forneceu o token da página.
filter

string

Opcional. Um filtro opcional para retornar apenas contas que correspondem ao filtro.

Confira alguns exemplos de filtros válidos:

  • accountName = "*store*" AND relationship(providerId = 123)
  • relationship(providerId = 123 AND service(type = "ACCOUNT_AGGREGATION"))
  • (accountName = "storeA") OR (accountName = "storeB")
  • relationship(service( handshakeState = "APPROVED" AND type = "ACCOUNT_MANAGEMENT"))
  • relationship(callerHasAccessToProvider() AND externalAccountId = "extAcctId" AND accountIdAlias = "alias")
  • (relationship(service(type = "ACCOUNT_MANAGEMENT") AND service(handshakeState = "PENDING"))) OR (accountName = "store" AND relationship(...))

Os filtros no nível da conta têm a seguinte semântica:

  • accountName Refere-se ao campo accountName da conta.
  • relationship(...) Isso se refere a uma relação que a conta tem com outra conta. Dentro da função, essa relação pode ser mais especificada.

Os filtros no nível relação têm a seguinte semântica:

  • providerId Refere-se ao ID numérico da conta que é o outro membro do relacionamento. Por exemplo, se o filtro precisar se limitar a contas que têm um relacionamento com a conta accounts/name/123, providerId deverá ser filtrado como providerId = 123.
  • callerHasAccessToProvider() Isso restringe as contas resultantes àquelas que têm um relacionamento com outra conta em que o usuário que fez a chamada também tem acesso ao outro membro da relação (ou ao provedor).
  • externalAccountId Refere-se ao ID da conta externa configurada para o relacionamento.
  • accountIdAlias Refere-se ao alias do ID da conta configurado para a relação.
  • service(...) Refere-se a um serviço prestado como parte do relacionamento. Observação: uma relação entre duas contas pode incluir vários serviços.

Os filtros no nível service têm a seguinte semântica:

  • handshakeState Refere-se ao estado de handshake do serviço. Quando um serviço é estabelecido, às vezes ele precisa ser aprovado pelo outro ou por ambos os membros do relacionamento primeiro. Portanto, um serviço pode estar no estado PENDING ou APPROVED.
  • type Refere-se ao tipo do serviço. Os valores possíveis são:
    • ACCOUNT_MANAGEMENT O provedor gerencia a conta.
    • ACCOUNT_AGGREGATION O provedor é um agregador da conta.

O filtro segue um subconjunto da especificação do filtro AIP e a gramática EBNF formal. A gramática desse filtro é mais restritiva e específica.

filter
    : accountFilterDisj
    | accountFilterConj
    ;
accountFilterDisj
    : "(" accountFilterConj " OR " accountFilterConj ")"
    ;
accountFilterConj
    : accountFilter {" AND " accountFilter}
    ;
accountFilter
    : accountNameFilter | relationshipFn
    ;
accountNameFilter
    : "accountName" comparator value
    ;
relationshipFn
    : "relationship(" relationshipConj ")"
    ;
relationshipConj
    : relationshipFilter {" AND " relationshipFilter}
    ;
relationshipFilter
    : "providerId = " numValue
    | "callerHasAccessToProvider()"
    | "externalAccountId" comparator value
    | "accountIdAlias" comparator value
    | serviceFn
    ;
serviceFn
    : "service(" serviceConj ")"
    ;
serviceConj
    : serviceFilter {" AND " serviceFilter}
    ;
serviceFilter
    : handshakeStateFilter
    | typeFilter
    ;
handshakeStateFilter
    : "handshakeState = " value
    ;
typeFilter
    : "type = " value
    ;
comparator
    : " = " | " != "
    ;

Além disso, o seguinte se aplica:

  • Cada campo em conjunto só pode aparecer uma vez. Por exemplo, só é possível filtrar accountName uma vez no nível da conta, ou só é possível filtrar por providerId uma vez em cada nível de relação.
  • Para campos de string (como accountName ou accountIdAlias), é possível expressar um operador CONTAINS colocando a consulta em *. Por exemplo, accountName = "*foo*" retornaria todas as contas com um accountName contendo foo. Ortogonalmente, é possível expressar um operador NOT_CONTAINS usando !=. Por exemplo, accountName != "*foo*" retornaria todas as contas com um accountName que não contém foo. Observação: é possível pesquisar contas com um accountName que contenha o caractere de estrela * usando ***.
  • Os espaços em branco adicionais são ignorados.
  • Todos os valores, exceto os numéricos, devem ser colocados entre aspas duplas.
  • Em caso de disjunção, as conjunções de cada lado precisam usar parênteses, mesmo que tenham apenas uma expressão. Parênteses não são permitidos em nenhum outro lugar, exceto para invocações de função (como relationship ou service). Isso expressa claramente que as conjunções são mais fortes do que as disjunções de maneira lógica.

ListAccountsResponse

Mensagem de resposta para o método ListAccounts.

Campos
accounts[]

Account

As contas que correspondem ao ListAccountsRequest.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListOnlineReturnPoliciesRequest

Solicite mensagem para o método ListOnlineReturnPolicies.

Campos
parent

string

Obrigatório. A conta do comerciante em que as políticas de devolução serão listadas. Formato: accounts/{account}
page_size

int32

Opcional. O número máximo de recursos OnlineReturnPolicy a serem retornados. O serviço vai retornar menos do que esse valor se o número de políticas de devolução do comerciante especificado for menor que o de pageSize. O valor padrão é 10. O valor máximo é 100. Se um valor maior que o máximo for especificado, pageSize será padronizado para o máximo
page_token

string

Opcional. Um token de página recebido de uma chamada ListOnlineReturnPolicies anterior. Forneça o token da página para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListOnlineReturnPolicies precisam corresponder à chamada que forneceu o token da página. O token retornado como nextPageToken na resposta à solicitação anterior.

ListOnlineReturnPoliciesResponse

Mensagem de resposta para o método ListOnlineReturnPolicies.

Campos
online_return_policies[]

OnlineReturnPolicy

As políticas de devolução recuperadas.
next_page_token

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListProgramsRequest

Mensagem de solicitação para o método ListPrograms.

Campos
parent

string

Obrigatório. O nome da conta para a qual recuperar todos os programas. Formato: accounts/{account}
page_size

int32

Opcional. O número máximo de programas a serem retornados em uma única resposta. Se não for especificado (ou 0), será usado um tamanho padrão de 1.000. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
page_token

string

Opcional. Um token de continuação, recebido de uma chamada ListPrograms anterior. Forneça isso para recuperar a próxima página.

ListProgramsResponse

Mensagem de resposta para o método ListPrograms.

Campos
programs[]

Program

Os programas da conta especificada.
next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListRegionsRequest

Solicite mensagem para o método ListRegions.

Campos
parent

string

Obrigatório. A conta para listar as regiões. Formato: accounts/{account}
page_size

int32

Opcional. O número máximo de regiões a serem retornadas. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 50 regiões serão retornadas. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
page_token

string

Opcional. Um token de página recebido de uma chamada ListRegions anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListRegions precisam corresponder à chamada que forneceu o token da página.

ListRegionsResponse

Mensagem de resposta para o método ListRegions.

Campos
regions[]

Region

As regiões do comerciante especificado.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListSubAccountsRequest

Solicite mensagem para o método ListSubAccounts.

Campos
provider

string

Obrigatório. A conta de familiar responsável. Formato: accounts/{account}
page_size

int32

Opcional. O número máximo de contas a serem retornadas. O serviço pode retornar menos que esse valor. Se não for especificado, serão retornadas no máximo 250 contas. O valor máximo é 500. Valores acima de 500 serão forçados para 500.
page_token

string

Opcional. Um token de página recebido de uma chamada ListAccounts anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListAccounts precisam corresponder à chamada que forneceu o token da página.

ListSubAccountsResponse

Mensagem de resposta para o método ListSubAccounts.

Campos
accounts[]

Account

As contas para as quais a conta principal fornecida é um agregador.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListUsersRequest

Solicite mensagem para o método ListUsers.

Campos
parent

string

Obrigatório. O pai, que é proprietário dessa coleção de usuários. Formato: `accounts/{account}
page_size

int32

Opcional. O número máximo de usuários a serem retornados. O serviço pode retornar menos que esse valor. Se não for especificado, serão retornados no máximo 50 usuários. O valor máximo é 100. Valores acima de 100 serão forçados para 100.
page_token

string

Opcional. Um token de página recebido de uma chamada ListUsers anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListUsers precisam corresponder à chamada que forneceu o token da página.

ListUsersResponse

Mensagem de resposta para o método ListUsers.

Campos
users[]

User

Os usuários da conta especificada.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

LocationIdSet

Uma lista de conjuntos de IDs de local. Não pode ficar em branco. Só poderá ser definido se todos os outros campos não estiverem definidos.

Campos
location_ids[]

string

Obrigatório. Uma lista não vazia de IDs de locais. Todos eles precisam ser do mesmo tipo de local (por exemplo, estado).

MinimumOrderValueTable

Tabela de valores mínimos de pedido por loja para o tipo de processamento do pedido para retirada.

Campos
store_code_set_with_movs[]

StoreCodeSetWithMov

Obrigatório. Uma lista de conjuntos de códigos de loja que compartilham o mesmo valor mínimo do pedido (MOV, na sigla em inglês). São necessários pelo menos dois conjuntos, e o último precisa estar vazio, o que significa "MOV para todas as outras lojas". Cada código de loja só pode aparecer uma vez em todos os conjuntos. Todos os preços de um serviço precisam ter a mesma moeda.

StoreCodeSetWithMov

Uma lista de conjuntos de códigos da loja que compartilham o mesmo valor mínimo do pedido. São necessários pelo menos dois conjuntos, e o último precisa estar vazio, o que significa "MOV para todas as outras lojas". Cada código de loja só pode aparecer uma vez em todos os conjuntos. Todos os preços de um serviço precisam ter a mesma moeda.

Campos
store_codes[]

string

Opcional. Uma lista de códigos de loja exclusivos ou vazia para "pega-tudo".
value

Price

O valor mínimo do pedido das lojas indicadas.

OnlineReturnPolicy

Objeto da Política de devolução on-line. No momento, ele é usado para representar as políticas de devolução de programas de anúncios e listagens sem custo financeiro.

Campos
name

string

Identificador. OnlineReturnPolicy: o nome do recurso. Formato: accounts/{account}/onlineReturnPolicies/{return_policy}
return_policy_id

string

Apenas saída. ID da política de devolução gerado pelo Google.
label

string

Esse campo representa a etiqueta exclusiva definida pelo usuário da política de devolução. É importante ressaltar que a mesma etiqueta não pode ser usada em diferentes políticas de devolução para o mesmo país. A menos que um produto especifique um atributo de rótulo específico, as políticas serão marcadas automaticamente como "padrão". Para atribuir uma política de devolução personalizada a determinados grupos de produtos, siga as instruções na etiqueta da política de devolução. O rótulo pode ter até 50 caracteres.
countries[]

string

Os países de venda em que a política de devolução se aplica. Os valores precisam ser um código ISO 3166 válido de duas letras.
policy

Policy

A política de devolução.
restocking_fee

RestockingFee

A taxa de reposição de estoque que se aplica a todas as categorias de motivos de devolução. Esse valor será tratado como uma taxa de reposição sem custo financeiro se o valor não for definido.
return_methods[]

ReturnMethod

Os métodos de devolução que os clientes podem usar para devolver um item. Esse valor não pode ficar em branco, a menos que o tipo de política de devolução seja noReturns.
item_conditions[]

ItemCondition

As condições do item aceitas para devoluções não podem ficar em branco, a menos que o tipo de política de devolução seja "noReturns".
return_shipping_fee

ReturnShippingFee

A taxa de frete da devolução. Deve ser definido apenas quando o cliente precisa fazer o download e imprimir a etiqueta de devolução.
return_policy_uri

string

O URI da política de devolução. Isso pode ser usado pelo Google para verificar a integridade da política. Precisa ser um URL válido.
accept_defective_only

bool

Este campo especifica se o comerciante aceita devoluções de produtos com defeito e é obrigatório.
process_refund_days

int32

O campo especifica o número de dias que os comerciantes levam para processar reembolsos. É opcional.
accept_exchange

bool

Este campo especifica se o comerciante permite que os clientes troquem produtos. É obrigatório.

ItemCondition

As condições do item disponíveis.

Tipos enumerados
ITEM_CONDITION_UNSPECIFIED Valor padrão. Esse valor não é usado.
NEW Novo.
USED Usado.

Política

As políticas disponíveis.

Campos
type

Type

Tipo de política.
days

int64

O número de dias em que os itens podem ser devolvidos após a entrega. Um dia é definido como 24 horas após o carimbo de data/hora da entrega. Obrigatório para devoluções de NUMBER_OF_DAYS_AFTER_DELIVERY.

Tipo

Tipos de política de devolução.

Tipos enumerados
TYPE_UNSPECIFIED Valor padrão. Esse valor não é usado.
NUMBER_OF_DAYS_AFTER_DELIVERY O número de dias em que uma devolução é válida após a entrega.
NO_RETURNS Sem devolução.
LIFETIME_RETURNS O tempo de vida útil volta.

RestockingFee

A taxa de reposição de estoque. Pode ser uma taxa fixa ou um micro%.

Campos

Campo de união type.

type pode ser apenas de um dos tipos a seguir:
fixed_fee

Price

Taxa fixa de reposição de estoque.
micro_percent

int32

Porcentagem do preço total em micros. 15.000.000 significa que 15% do preço total será cobrado.

ReturnMethod

Os métodos de retorno disponíveis.

Tipos enumerados
RETURN_METHOD_UNSPECIFIED Valor padrão. Esse valor não é usado.
BY_MAIL Devolver por correio.
IN_STORE Devolver na loja.
AT_A_KIOSK Volte em um quiosque.

ReturnShippingFee

A taxa de frete da devolução. Pode ser uma taxa fixa ou um valor booleano para indicar que o cliente paga o custo real de frete.

Campos
type

Type

Tipo de taxa de frete da devolução.
fixed_fee

Price

Valor fixo da taxa de frete de devolução. Esse valor só é aplicável quando o tipo é FIXED. A taxa de frete de devolução será considerada sem custo financeiro se o tipo for FIXED e esse valor não estiver definido.

Tipo

Tipos de taxa de frete de devolução.

Tipos enumerados
TYPE_UNSPECIFIED Valor padrão. Esse valor não é usado.
FIXED A taxa de frete da devolução é um valor fixo.
CUSTOMER_PAYING_ACTUAL_FEE Os clientes vão pagar a taxa real de frete de devolução.

PhoneVerificationState

O estado de verificação do telefone.

Tipos enumerados
PHONE_VERIFICATION_STATE_UNSPECIFIED Valor padrão. Esse valor não é usado.
PHONE_VERIFICATION_STATE_VERIFIED O telefone foi verificado.
PHONE_VERIFICATION_STATE_UNVERIFIED O telefone não foi verificado

Program

Define a participação da conta especificada em um determinado programa.

Os programas oferecem um mecanismo para adicionar funcionalidades às contas do comerciante. Um exemplo típico disso é o programa de listagens de produto sem custo financeiro, que permite que os produtos da loja de um comerciante sejam exibidos no Google sem custo financeiro.

Campos
name

string

Identificador. O nome de recurso do programa. Formato: accounts/{account}/programs/{program}
documentation_uri

string

Apenas saída. O URL de uma página de ajuda do Merchant Center que descreve o programa.
state

State

Apenas saída. O estado de participação da conta no programa.
active_region_codes[]

string

Apenas saída. As regiões em que a conta está participando ativamente do programa. As regiões ativas são aquelas em que todos os requisitos do programa que afetam as regiões foram atendidos.

Os códigos de região são definidos pelo CLDR. O programa pode ser aplicado especificamente a esse país ou 001 quando o programa for globalmente aplicado.
unmet_requirements[]

Requirement

Apenas saída. Os requisitos que a conta ainda não atende e que afetam a participação no programa.

Requisito

Define um requisito especificado para a participação no programa.

Campos
title

string

Apenas saída. Nome do requisito.
documentation_uri

string

Apenas saída. O URL de uma página de ajuda que descreve o requisito.
affected_region_codes[]

string

Apenas saída. As regiões afetadas atualmente por esse requisito não estão sendo atendidas.

Os códigos de região são definidos pelo CLDR. O programa pode ser aplicado especificamente a esse país ou 001 quando o programa for globalmente aplicado.

Estado

Possíveis estados de participação no programa da conta.

Tipos enumerados
STATE_UNSPECIFIED Valor padrão. Esse valor não é usado.
NOT_ELIGIBLE A conta não está qualificada para participar do programa.
ELIGIBLE A conta está qualificada para participar do programa.
ENABLED O programa está ativado para a conta.

RateGroup

Definições do grupo de taxas de frete. Somente o último pode ter um applicable_shipping_labels vazio, o que significa "todo o restante". Os outros applicable_shipping_labels não podem se sobrepor.

Campos
applicable_shipping_labels[]

string

Obrigatório. Uma lista de rótulos para envio que definem os produtos aos quais esse grupo de taxas se aplica. Isso é uma disjunção: apenas um dos rótulos precisa corresponder para que o grupo de taxas seja aplicado. Pode estar em branco somente para o último grupo de tarifas de um serviço.
subtables[]

Table

Opcional. Uma lista de subtabelas referenciadas por main_table. Só poderá ser definido se main_table estiver definido.
carrier_rates[]

CarrierRate

Opcional. Uma lista de taxas de transportadoras que podem ser indicadas por main_table ou single_value.
single_value

Value

O valor do grupo de taxas (por exemplo, taxa fixa de US $10). Só poderá ser definido se main_table e subtables não estiverem definidos.
main_table

Table

Uma tabela que define o grupo de taxas, quando single_value não é expressivo o suficiente. Só poderá ser definido se single_value não estiver definido.
name

string

Opcional. Nome do grupo de taxas. Se definido, precisa ser exclusivo no serviço de frete.

Região

Representa uma região geográfica que pode ser usada como destino com os serviços RegionalInventory e ShippingSettings. É possível definir regiões como conjuntos de códigos postais ou, em alguns países, usando segmentações por área geográfica predefinidas. Saiba mais em Configurar regiões .

Campos
name

string

Identificador. O nome do recurso da região. Formato: accounts/{account}/regions/{region}
postal_code_area

PostalCodeArea

Opcional. Uma lista de códigos postais que define a área da região.
geotarget_area

GeoTargetArea

Opcional. Uma lista de segmentações geográficas que define a área da região.
regional_inventory_eligible

BoolValue

Apenas saída. Indica se a região está qualificada para uso na configuração do inventário regional.
shipping_eligible

BoolValue

Apenas saída. Indica se a região está qualificada para uso na configuração dos serviços de frete.
display_name

string

Opcional. O nome de exibição da região.

GeoTargetArea

Uma lista de segmentações geográficas que define a área da região.

Campos
geotarget_criteria_ids[]

int64

Obrigatório. Uma lista não vazia de IDs de locais. Todos eles precisam ser do mesmo tipo de local (por exemplo, estado).

PostalCodeArea

Uma lista de códigos postais que define a área da região. Observação: todas as regiões definidas usando códigos postais podem ser acessadas por meio do recurso ShippingSettings.postalCodeGroups da conta.

Campos
region_code

string

Obrigatório. Código do território CLDR ou o país a que o grupo de códigos postais se aplica.
postal_codes[]

PostalCodeRange

Obrigatório. Um intervalo de códigos postais.

PostalCodeRange

Um intervalo de códigos postais que define a área da região.

Campos
begin

string

Obrigatório. Um código postal ou um padrão de formato prefixo* que indica o limite inferior inclusivo do intervalo que define a área. Exemplos de valores: 94108, 9410*, 9*.
end

string

Opcional. Um código postal ou um padrão no formato prefix*, que indica o limite superior inclusivo do intervalo que define a área. Ele deve ter o mesmo comprimento que postalCodeRangeBegin: se postalCodeRangeBegin é um código postal, então postalCodeRangeEnd precisa ser código postal também. Se postalCodeRangeBegin é um padrão, postalCodeRangeEnd precisa ser padrão com o mesmo comprimento de prefixo. Opcional: se não for definida, a área será definida como sendo todos os códigos postais correspondentes a postalCodeRangeBegin.

Obrigatório

Descreve os Termos de Serviço que precisam ser aceitos.

Campos
terms_of_service

string

Os termsOfService que precisam ser aceitos.
tos_file_uri

string

URL completo do arquivo dos Termos de Serviço. Este campo é o mesmo que TermsOfService.file_uri, é adicionado aqui apenas por conveniência.

RetrieveForApplicationTermsOfServiceAgreementStateRequest

Solicite mensagem para o método RetrieveForApplicationTermsOfServiceAgreementState.

Campos
parent

string

Obrigatório. A conta em que será possível receber um formato dos Termos de Serviço de estado: accounts/{account}

RetrieveLatestTermsOfServiceRequest

Solicite mensagem para o método RetrieveLatestTermsOfService.

Campos
region_code

string

É o código de região, conforme definido pelo CLDR. os Termos de Serviço se aplicam especificamente a esse país ou o 001 quando se aplica a todo o mundo.
kind

TermsOfServiceKind

O Tipo a que este Termos de Serviço se aplica.

Linha

Inclua uma lista de células.

Campos
cells[]

Value

Obrigatório. A lista de células que constituem a linha. Precisa ter o mesmo comprimento que columnHeaders para tabelas bidimensionais e um comprimento de 1 para tabelas unidimensionais.

Serviço

Serviço de frete.

Campos
delivery_countries[]

string

Obrigatório. O código de território CLDR dos países a que o serviço se aplica.
rate_groups[]

RateGroup

Opcional. Definições do grupo de taxas de frete. Somente o último pode ter um applicable_shipping_labels vazio, o que significa "todo o restante". Os outros applicable_shipping_labels não podem se sobrepor.
loyalty_programs[]

LoyaltyProgram

Opcional. Programas de fidelidade a que este serviço de frete está limitado.
service_name

string

Obrigatório. Nome em formato livre do serviço. Precisa ser exclusivo na conta de destino.
active

bool

Obrigatório. Um booleano que expõe o status ativo do serviço de frete.
currency_code

string

O código CLDR da moeda a que este serviço se aplica. Precisa corresponder ao preço dos grupos de tarifas.
delivery_time

DeliveryTime

Obrigatório. Tempo gasto em vários aspectos do pedido até a entrega do produto.
shipment_type

ShipmentType

Tipo de locais para onde este serviço envia pedidos.
minimum_order_value

Price

Valor mínimo do pedido para este serviço. Se definido, indica que os clientes terão que gastar pelo menos esse valor. Todos os preços de um serviço precisam ter a mesma moeda. Não pode ser definido junto comminimum_order_value_table.
minimum_order_value_table

MinimumOrderValueTable

Tabela de valores mínimos de pedido por loja para o tipo de processamento do pedido para retirada. Não pode ser definido junto comminimum_order_value.
store_config

StoreConfig

Uma lista de lojas de onde seus produtos são entregues. Válido apenas para o tipo de frete para entrega local.

LoyaltyProgram

Programa de fidelidade fornecido por um comerciante.

Campos
loyalty_program_tiers[]

LoyaltyProgramTiers

Opcional. Nível do programa de fidelidade deste serviço de frete.
program_label

string

Este é o rótulo do programa de fidelidade definido nas configurações do programa no Merchant Center. Com esse subatributo, o Google pode mapear seu programa de fidelidade para ofertas qualificadas.

LoyaltyProgramTiers

Subconjunto de um programa de fidelidade de comerciantes.

Campos
tier_label

string

O subatributo rótulo de nível [tier_label] diferencia os benefícios do nível da oferta entre cada nível. Esse valor também é definido nas configurações do programa no Merchant Center e é obrigatório para mudanças na fonte de dados, mesmo que seu programa de fidelidade tenha apenas um nível.

ShipmentType

Tipo de envio do serviço de frete.

Tipos enumerados
SHIPMENT_TYPE_UNSPECIFIED Este serviço não especificou o tipo de remessa.
DELIVERY Este serviço envia os pedidos para um endereço escolhido pelo cliente.
LOCAL_DELIVERY Este serviço envia os pedidos para um endereço escolhido pelo cliente. O pedido é enviado de uma loja próxima.
COLLECTION_POINT Este serviço envia os pedidos para um endereço escolhido pelo cliente. O pedido é enviado de um local de coleta.

StoreConfig

Uma lista de lojas de onde seus produtos são entregues. Válido apenas para o tipo de frete para entrega local.

Campos
store_codes[]

string

Opcional. Uma lista de códigos de loja que oferecem entrega local. Se estiver vazio, all_stores precisará ser verdadeiro.
store_service_type

StoreServiceType

Indica se todas as lojas ou lojas selecionadas listadas por esse comerciante oferecem entrega local.
cutoff_config

CutoffConfig

As configurações relacionadas à entrega local terminam no dia.
service_radius

Distance

Raio máximo de entrega. Isso é necessário apenas para o tipo de frete para entrega local.

CutoffConfig

As configurações relacionadas à entrega local terminam no dia.

Campos
local_cutoff_time

LocalCutoffTime

Horário em que a entrega local do dia termina.
store_close_offset_hours

int64

Válido apenas com processamento do pedido de entrega local. O horário limite é representado pelo número de horas antes do fechamento da loja. Mutuamente exclusivo com local_cutoff_time.
no_delivery_post_cutoff

bool

Os comerciantes podem desativar a exibição da entrega local de n + 1 dia se tiverem um serviço de frete configurado para a entrega local com n dias. Por exemplo, se o serviço de frete definir a entrega no mesmo dia e já tiver passado do limite, definir esse campo como true vai fazer com que a taxa de serviço de frete calculada retorne NO_DELIVERY_POST_CUTOFF. No mesmo exemplo, definir esse campo como false faz com que o tempo de envio calculado seja um dia. Isso é apenas para entrega local.

LocalCutoffTime

Horário em que a entrega local do dia termina.

Campos
hour

int64

Os pedidos de entrega local por hora precisam ser feitos para que o processamento seja feito no mesmo dia.
minute

int64

Os pedidos de entrega local em minutos precisam ser feitos por para serem processados no mesmo dia.

StoreServiceType

Indica se todas as lojas ou lojas selecionadas listadas pelo comerciante oferecem entrega local.

Tipos enumerados
STORE_SERVICE_TYPE_UNSPECIFIED O tipo de serviço da loja não foi especificado.
ALL_STORES Indica se todas as lojas, atuais e futuras, listadas por esse comerciante oferecem entrega local.
SELECTED_STORES Indica que apenas as lojas listadas em store_codes estão qualificadas para entrega local.

ShippingSettings

A [configuração de frete](https://support.google.com/merchants/answer/6069284) da conta do comerciante.

Campos
name

string

Identificador. O nome do recurso da configuração de frete. Formato: accounts/{account}/shippingSetting
services[]

Service

Opcional. A lista de serviços da conta de destino.
warehouses[]

Warehouse

Opcional. Uma lista de warehouses que podem ser referenciados em services.
etag

string

Obrigatório. Esse campo é usado para evitar problemas assíncronos. Verifique se os dados das configurações de frete não foram alterados entre "Receber chamada" e "Inserir chamada". O usuário deve seguir estas etapas:

  1. Defina o campo etag como uma string vazia para criar a configuração de frete inicial.

  2. Após a criação inicial, chame o método "get" para receber uma etag e os dados atuais da configuração de envio antes de chamar "insert".

  3. Modifique para exibir as informações de configuração de frete desejadas.

  4. Chame o método insert com as informações de configuração de envio desejadas usando a etag da etapa 2.

  5. Se os dados da configuração de frete tiverem mudado entre as etapas 2 e 4. A solicitação de inserção falhará porque a etag será alterada sempre que os dados de configuração de frete mudarem. O usuário deve repetir as etapas 2 e 4 com a nova ETag.

Tabela

Uma tabela que define o grupo de taxas, quando single_value não é expressivo o suficiente.

Campos
rows[]

Row

Obrigatório. A lista de linhas que constituem a tabela. Precisa ter o mesmo comprimento que row_headers.
name

string

Nome da tabela. Obrigatório para subtabelas, ignorado para a tabela principal.
row_headers

Headers

Obrigatório. Cabeçalhos das linhas da tabela.
column_headers

Headers

Cabeçalhos das colunas da tabela. Opcional: se ela não for definida, a tabela terá apenas uma dimensão.

TaxRule

Convenção do tipo principal

porcentagem micro : 100% = 1.000.000 e 1% = 10 000 não podem ser negativos.

Informações sobre presença física e parâmetros relacionados aplicáveis a pedidos entregues na área coberta por um único administrador tributário. O Nexus é criado quando um comerciante faz negócios em uma área administrada por um administrador fiscal (somente os estados dos EUA são compatíveis com a configuração de presença física). Se o comerciante tiver presença física em um estado dos EUA, ele precisará pagar impostos a todas as autoridades fiscais associadas ao destino de envio. Próximo ID : 8.

Campos
region_code

string

Código da região a que esta regra é aplicável
shipping_taxed

bool

Se definido, o frete é cobrado à mesma taxa do produto quando ele for entregue na área desse administrador. Só pode ser definido em estados dos EUA sem categoria.
effective_time_period

Interval

Obrigatório. Período em que esta regra entra em vigor. Se a duração estiver ausente do effective_time listado, isso significa que ela está no futuro. O início desse período é inclusivo, e o final é exclusivo.
Campo de união location. Descreva o local por meio de um intervalo de código postal ou de um ID de critérios. location só pode ser de um dos seguintes tipos:
location_id

int64

O "admin_id" ou o "criteria_id" da região em que essa regra é aplicável.
post_code_range

TaxPostalCodeRange

O intervalo de códigos postais ao qual essa regra é aplicável.
Campo de união rate_calculation. Como calcular a taxa de impostos para as entregas na área desse administrador? Pode ser definido apenas em estados dos EUA. rate_calculation só pode ser de um dos seguintes tipos:
use_google_rate

bool

Taxa que depende do local de entrega: se o comerciante tiver vínculo com um estado correspondente dos EUA, as taxas das autoridades com jurisdição sobre a área de entrega serão somadas.
self_specified_rate_micros

int64

Uma taxa fixa especificada em micros, em que 100% = 1_000_000. Adequado para estados com base na origem.

TaxPostalCodeRange

Um intervalo de códigos postais que define a área.

Campos
start

string

Obrigatório. O início do intervalo de código postal, que também é o menor no intervalo.
end

string

Fim do intervalo de códigos postais. Se não for especificado, será igual a "start".

TermsOfService

TermsOfService.

Campos
name

string

Identificador. O nome do recurso da versão dos Termos de Serviço. Formato: termsOfService/{version}
region_code

string

É o código de região, conforme definido pelo CLDR. Os Termos de Serviço se aplicam especificamente a esse país ou 001 quando a mesma TermsOfService pode ser assinada em qualquer país. No entanto, ao assinar um TOS que se aplica globalmente, ainda esperamos que um país específico seja fornecido, que deve ser o país da empresa do comerciante ou o país de participação no programa.
kind

TermsOfServiceKind

O Tipo a que este Termos de Serviço se aplica.
external

bool

Se esta versão dos Termos de Serviço é externa. As versões externas dos Termos de Serviço só podem ser aceitas por processos externos, e não diretamente pelo comerciante pela interface ou API.
file_uri

string

URI para o arquivo dos Termos de Serviço que precisa ser exibido para os usuários assinantes.

TermsOfServiceAgreementState

Esse recurso representa o estado do contrato de uma determinada conta e o tipo dos Termos de Serviço. O estado é o seguinte:

  • Se o comerciante aceitou os Termos de Serviço: accepted será preenchido. Caso contrário, estará em branco.
  • Se o comerciante precisar assinar os Termos de Serviço: required será preenchido. Caso contrário, estará em branco.

Os valores obrigatório e aceito podem estar presentes. Nesse caso, os Termos de Serviço do accepted terão uma data de validade definida no campo valid_until. Os Termos de Serviço do required precisam ser aceitos antes de valid_until para que a conta continue tendo um contrato válido. Ao aceitar novos Termos de Serviço, esperamos que terceiros mostrem o texto associado ao contrato em questão. O URL do arquivo que contém o texto é adicionado na mensagem obrigatória abaixo como tos_file_uri. A aceitação real dos Termos de Serviço é feita chamando "aceitar" no recurso TermsOfService.

Campos
name

string

Identificador. O nome do recurso da versão dos Termos de Serviço. Formato: accounts/{account}/termsOfServiceAgreementState/{identifier}
region_code

string

Código de região, conforme definido por https://cldr.unicode.org/. Este é o país ao qual o estado atual se aplica.
terms_of_service_kind

TermsOfServiceKind

Tipo dos Termos de Serviço associados à versão específica.
accepted

Accepted

Os Termos de Serviço aceitos para este tipo e para o region_code associado
required

Required

Os Termos de Serviço obrigatórios

TermsOfServiceKind

O tipo dos Termos de Serviço.

Tipos enumerados
TERMS_OF_SERVICE_KIND_UNSPECIFIED Valor padrão. Esse valor não é usado.
MERCHANT_CENTER aplicativo do Merchant Center.

TransitTable

Tabela de tempo em trânsito, número de dias úteis gastos em trânsito com base nas dimensões de linha e coluna. É possível definir min_transit_days, max_transit_days ou transit_time_table, mas não ambos.

Campos
postal_code_group_names[]

string

Obrigatório. Uma lista de nomes de regiões Region.name O último valor pode ser "all other locations". Exemplo: ["zone 1", "zone 2", "all other locations"]. Os grupos de CEPs indicados precisam corresponder ao país de entrega do serviço.
transit_time_labels[]

string

Obrigatório. Uma lista de rótulos de tempo em trânsito. O último valor pode ser "all other labels". Exemplo: ["food", "electronics", "all other labels"].
rows[]

TransitTimeRow

Obrigatório. Se houver apenas um conjunto de dimensões de postal_code_group_names ou transit_time_labels, haverá várias linhas, cada uma com um valor para essa dimensão. Se houver duas dimensões, cada linha corresponderá a um postal_code_group_names e as colunas (valores) a uma transit_time_labels.

TransitTimeRow

Se houver apenas um conjunto de dimensões de postal_code_group_names ou transit_time_labels, haverá várias linhas, cada uma com um valor para essa dimensão. Se houver duas dimensões, cada linha corresponderá a um postal_code_group_names e as colunas (valores) a uma transit_time_labels.

Campos
values[]

TransitTimeValue

Obrigatório. Intervalo de tempo em trânsito (mín.-máx.) em dias úteis.

TransitTimeValue

Intervalo de tempo em trânsito (mín.-máx.) em dias úteis.

Campos
min_transit_days

int32

Intervalo de tempo mínimo em trânsito em dias úteis. 0 significa entrega no mesmo dia, 1 significa entrega no dia seguinte.
max_transit_days

int32

Precisa ser maior ou igual a min_transit_days.

UnclaimHomepageRequest

Solicite mensagem para o método UnclaimHomepage.

Campos
name

string

Obrigatório. O nome da página inicial para cancelar a reivindicação. Formato: accounts/{account}/homepage

UpdateAccountRequest

Solicite mensagem para o método UpdateAccount.

Campos
account

Account

Obrigatório. A nova versão da conta.
update_mask

FieldMask

Obrigatório. Lista de campos que estão sendo atualizados.

UpdateAccountTaxRequest

Solicitação para atualizar as configurações de impostos

Campos
account_tax

AccountTax

Obrigatório. A configuração de tributos que será atualizada
update_mask

FieldMask

Lista de campos a serem atualizados

UpdateBusinessIdentityRequest

Solicite mensagem para o método UpdateBusinessIdentity.

Campos
business_identity

BusinessIdentity

Obrigatório. A nova versão da identidade da empresa.
update_mask

FieldMask

Obrigatório. Lista de campos que estão sendo atualizados.

UpdateBusinessInfoRequest

Solicite mensagem para o método UpdateBusinessInfo.

Campos
business_info

BusinessInfo

Obrigatório. A nova versão das informações comerciais.
update_mask

FieldMask

Obrigatório. Lista de campos que estão sendo atualizados.

UpdateEmailPreferencesRequest

Mensagem de solicitação para o método UpdateEmailPreferences.

Campos
email_preferences

EmailPreferences

Obrigatório. Preferências de e-mail a serem atualizadas.
update_mask

FieldMask

Obrigatório. Lista de campos que estão sendo atualizados.

UpdateHomepageRequest

Solicite mensagem para o método UpdateHomepage.

Campos
homepage

Homepage

Obrigatório. A nova versão da página inicial.
update_mask

FieldMask

Obrigatório. Lista de campos que estão sendo atualizados.

UpdateRegionRequest

Solicite mensagem para o método UpdateRegion.

Campos
region

Region

Obrigatório. A região atualizada.
update_mask

FieldMask

Opcional. Máscara de campo separada por vírgulas que indica os campos a serem atualizados. Exemplo: "displayName,postalCodeArea.regionCode".

UpdateUserRequest

Solicite mensagem para o método UpdateUser.

Campos
user

User

Obrigatório. A nova versão do usuário.

Também é possível atualizar o usuário correspondente ao autor da chamada usando me em vez de um endereço de e-mail no campo de nome, como em accounts/{account}/users/me.
update_mask

FieldMask

Obrigatório. Lista de campos que estão sendo atualizados.

Usuário

Um usuário.

Campos
name

string

Identificador. O nome de recurso do usuário. Formato: accounts/{account}/user/{user}
state

State

Apenas saída. O estado do usuário.
access_rights[]

AccessRight

Opcional. Os direitos de acesso que o usuário tem.

Estado

Os possíveis estados de um usuário.

Tipos enumerados
STATE_UNSPECIFIED Valor padrão. Esse valor não é usado.
PENDING A confirmação do usuário está pendente. Nesse estado, o usuário precisa aceitar o convite antes de realizar outras ações.
VERIFIED O usuário foi verificado.

Valor

O valor único de um grupo de taxas ou o valor da célula de uma tabela do grupo de taxas. Exatamente um de no_shipping, flat_rate, price_percentage, carrier_rateName ou subtable_name precisa ser definido.

Campos
no_shipping

bool

Se verdadeiro, o produto não pode ser enviado. Precisa ser "true" quando definido. Só poderá ser definido se todos os outros campos não estiverem definidos.
flat_rate

Price

Uma taxa fixa. Só poderá ser definido se todos os outros campos não estiverem definidos.
price_percentage

string

Uma porcentagem do preço representada como um número em notação decimal (por exemplo, "5.4"). Só poderá ser definido se todos os outros campos não estiverem definidos.
carrier_rate

string

O nome de uma taxa de transportadora que se refere a uma taxa da transportadora definida no mesmo grupo de taxas. Só poderá ser definido se todos os outros campos não estiverem definidos.
subtable

string

O nome de uma subtabela. Só pode ser definido em células da tabela (por exemplo, não para valores únicos) e somente se todos os outros campos não estiverem definidos.

Warehouse

Um armazém de atendimento de pedidos, que armazena e administra o estoque. Próxima tag: 7

Campos
name

string

Obrigatório. O nome do warehouse. Precisa ser exclusivo na conta.
shipping_address

Address

Obrigatório. Endereço de entrega do depósito.
cutoff_time

WarehouseCutoffTime

Obrigatório. A última hora do dia para aceitar e iniciar o processamento de um pedido. Pedidos posteriores serão processados no dia seguinte. O horário é baseado no CEP do armazém.
handling_days

int64

Obrigatório. O número de dias que leva para este depósito embalar e enviar um item. Ele está no nível do armazém, mas pode ser substituído no nível da oferta com base nos atributos de um item.
business_day_config

BusinessDayConfig

Dias úteis do armazém. Se não for definida, o padrão será de segunda a sexta-feira.

WarehouseBasedDeliveryTime

Indica que o tempo de entrega deve ser calculado por armazém (local de origem do frete) com base nas configurações da transportadora selecionada. Quando definido, nenhum outro campo relacionado ao tempo em trânsito no delivery_time precisa ser definido.

Campos
carrier

string

Obrigatório. Operadora, como "UPS" ou "Fedex".
carrier_service

string

Obrigatório. Serviço da operadora, como "ground" ou "2 days". O nome do serviço precisa estar na lista eddSupportedServices.
warehouse

string

Obrigatório. Nome do warehouse. Deve corresponder a [warehouse][ShippingSetting.warehouses.name].

WarehouseCutoffTime

A última hora do dia para aceitar e iniciar o processamento de um pedido. Pedidos posteriores serão processados no dia seguinte. O horário é baseado no CEP do armazém.

Campos
hour

int32

Obrigatório. Hora do horário limite até o qual um pedido precisa ser feito para ser processado no mesmo dia pelo armazém. O horário é baseado no fuso horário do armazém.
minute

int32

Obrigatório. Minuto do horário limite até o qual um pedido precisa ser feito para ser processado no mesmo dia pelo armazém. O minuto é baseado no fuso horário do armazém.