Índice
AccountIssueService
(interface)AccountsService
(interface)AutofeedSettingsService
(interface)BusinessIdentityService
(interface)BusinessInfoService
(interface)EmailPreferencesService
(interface)HomepageService
(interface)OnlineReturnPolicyService
(interface)ProgramsService
(interface)RegionsService
(interface)ShippingSettingsService
(interface)TermsOfServiceAgreementStateService
(interface)TermsOfServiceService
(interface)UserService
(interface)AcceptTermsOfServiceRequest
(mensagem)Accepted
(mensagem)AccessRight
(enum)Account
(mensagem)AccountAggregation
(mensagem)AccountIssue
(mensagem)AccountIssue.ImpactedDestination
(mensagem)AccountIssue.ImpactedDestination.Impact
(mensagem)AccountIssue.Severity
(enum)Address
(mensagem)AutofeedSettings
(mensagem)BusinessDayConfig
(mensagem)BusinessDayConfig.Weekday
(enum)BusinessIdentity
(mensagem)BusinessIdentity.IdentityAttribute
(mensagem)BusinessIdentity.IdentityAttribute.IdentityDeclaration
(enum)BusinessIdentity.PromotionsConsent
(enum)BusinessInfo
(mensagem)CarrierRate
(mensagem)ClaimHomepageRequest
(mensagem)CreateAndConfigureAccountRequest
(mensagem)CreateAndConfigureAccountRequest.AddAccountService
(mensagem)CreateRegionRequest
(mensagem)CreateUserRequest
(mensagem)CustomerService
(mensagem)CutoffTime
(mensagem)DeleteAccountRequest
(mensagem)DeleteRegionRequest
(mensagem)DeleteUserRequest
(mensagem)DeliveryTime
(mensagem)DisableProgramRequest
(mensagem)Distance
(mensagem)Distance.Unit
(enum)EmailPreferences
(mensagem)EmailPreferences.OptInState
(enum)EnableProgramRequest
(mensagem)GetAccountRequest
(mensagem)GetAutofeedSettingsRequest
(mensagem)GetBusinessIdentityRequest
(mensagem)GetBusinessInfoRequest
(mensagem)GetEmailPreferencesRequest
(mensagem)GetHomepageRequest
(mensagem)GetOnlineReturnPolicyRequest
(mensagem)GetProgramRequest
(mensagem)GetRegionRequest
(mensagem)GetShippingSettingsRequest
(mensagem)GetTermsOfServiceAgreementStateRequest
(mensagem)GetTermsOfServiceRequest
(mensagem)GetUserRequest
(mensagem)Headers
(mensagem)Homepage
(mensagem)InsertShippingSettingsRequest
(mensagem)ListAccountIssuesRequest
(mensagem)ListAccountIssuesResponse
(mensagem)ListAccountsRequest
(mensagem)ListAccountsResponse
(mensagem)ListOnlineReturnPoliciesRequest
(mensagem)ListOnlineReturnPoliciesResponse
(mensagem)ListProgramsRequest
(mensagem)ListProgramsResponse
(mensagem)ListRegionsRequest
(mensagem)ListRegionsResponse
(mensagem)ListSubAccountsRequest
(mensagem)ListSubAccountsResponse
(mensagem)ListUsersRequest
(mensagem)ListUsersResponse
(mensagem)LocationIdSet
(mensagem)MinimumOrderValueTable
(mensagem)MinimumOrderValueTable.StoreCodeSetWithMov
(mensagem)OnlineReturnPolicy
(mensagem)OnlineReturnPolicy.ItemCondition
(enum)OnlineReturnPolicy.Policy
(mensagem)OnlineReturnPolicy.Policy.Type
(enum)OnlineReturnPolicy.RestockingFee
(mensagem)OnlineReturnPolicy.ReturnMethod
(enum)OnlineReturnPolicy.ReturnShippingFee
(mensagem)OnlineReturnPolicy.ReturnShippingFee.Type
(enum)PhoneVerificationState
(enum)Program
(mensagem)Program.Requirement
(mensagem)Program.State
(enum)RateGroup
(mensagem)Region
(mensagem)Region.GeoTargetArea
(mensagem)Region.PostalCodeArea
(mensagem)Region.PostalCodeArea.PostalCodeRange
(mensagem)Required
(mensagem)RetrieveForApplicationTermsOfServiceAgreementStateRequest
(mensagem)RetrieveLatestTermsOfServiceRequest
(mensagem)Row
(mensagem)Service
(mensagem)Service.LoyaltyProgram
(mensagem)Service.LoyaltyProgram.LoyaltyProgramTiers
(mensagem)Service.ShipmentType
(enum)Service.StoreConfig
(mensagem)Service.StoreConfig.CutoffConfig
(mensagem)Service.StoreConfig.CutoffConfig.LocalCutoffTime
(mensagem)Service.StoreConfig.StoreServiceType
(enum)ShippingSettings
(mensagem)Table
(mensagem)TermsOfService
(mensagem)TermsOfServiceAgreementState
(mensagem)TermsOfServiceKind
(enum)TransitTable
(mensagem)TransitTable.TransitTimeRow
(mensagem)TransitTable.TransitTimeRow.TransitTimeValue
(mensagem)UnclaimHomepageRequest
(mensagem)UpdateAccountRequest
(mensagem)UpdateAutofeedSettingsRequest
(mensagem)UpdateBusinessIdentityRequest
(mensagem)UpdateBusinessInfoRequest
(mensagem)UpdateEmailPreferencesRequest
(mensagem)UpdateHomepageRequest
(mensagem)UpdateRegionRequest
(mensagem)UpdateUserRequest
(mensagem)User
(mensagem)User.State
(enum)Value
(mensagem)Warehouse
(mensagem)WarehouseBasedDeliveryTime
(mensagem)WarehouseCutoffTime
(mensagem)
AccountIssueService
Serviço para oferecer suporte à API AccountIssueService
.
ListAccountIssues |
---|
Lista todos os problemas da conta do Merchant Center.
|
AccountsService
Serviço para oferecer suporte à API Accounts.
CreateAndConfigureAccount |
---|
Cria uma conta independente do Merchant Center com uma configuração extra. Adiciona o usuário que faz a solicitação como administrador da nova conta.
|
DeleteAccount |
---|
Exclui a conta especificada, independentemente do tipo: independente, MCA ou subconta. A exclusão de uma MCA leva à exclusão de todas as subcontas dela. A execução desse método requer acesso de administrador. A exclusão só é bem-sucedida se a conta não fornecer serviços a nenhuma outra conta e não tiver ofertas processadas. Use o parâmetro
|
GetAccount |
---|
Recupera uma conta da sua conta do Merchant Center. Depois de inserir, atualizar ou excluir uma conta, pode levar vários minutos para que as mudanças entrem em vigor.
|
ListAccounts |
---|
Lista as contas acessíveis pelo usuário que fez a chamada e que correspondem às restrições da solicitação, como tamanho da página ou filtros. Isso não lista apenas as subcontas de uma MCA, mas todas as contas a que o usuário que faz a chamada tem acesso, incluindo outras MCAs, contas vinculadas, contas independentes e assim por diante. Se nenhum filtro for fornecido, ele vai retornar as contas em que o usuário foi adicionado diretamente.
|
ListSubAccounts |
---|
Lista todas as subcontas de uma determinada conta de múltiplos clientes. Esse é um wrapper prático para o método
|
UpdateAccount |
---|
Atualiza uma conta, seja ela independente, MCA ou subconta. A execução desse método requer acesso de administrador.
|
AutofeedSettingsService
Serviço para oferecer suporte à configuração de alimentação automática.
GetAutofeedSettings |
---|
Recupera as configurações de alimentação automática de uma conta.
|
UpdateAutofeedSettings |
---|
Atualiza as configurações de alimentação automática de uma conta.
|
BusinessIdentityService
Serviço para oferecer suporte à API business identity.
GetBusinessIdentity |
---|
Recupera a identidade comercial de uma conta.
|
UpdateBusinessIdentity |
---|
Atualiza a identidade comercial de uma conta. A execução desse método requer acesso de administrador.
|
BusinessInfoService
Serviço para oferecer suporte à API Business Information.
GetBusinessInfo |
---|
Recupera as informações comerciais de uma conta.
|
UpdateBusinessInfo |
---|
Atualiza as informações comerciais de uma conta. A execução desse método requer acesso de administrador.
|
EmailPreferencesService
Serviço para oferecer suporte à API EmailPreferences
.
GetEmailPreferences |
---|
Retorna as preferências de e-mail de um usuário da conta do Merchant Center. Esse serviço só permite recuperar e atualizar as preferências de e-mail do usuário autenticado. Use o alias name=accounts/*/users/me/emailPreferences para receber as preferências do usuário autenticado.
|
UpdateEmailPreferences |
---|
Atualiza as preferências de e-mail de um usuário da conta do Merchant Center. Os usuários da MCA precisam especificar a conta da MCA, e não uma subconta dela. 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 UNCONFIRMED. Use o alias name=accounts/*/users/me/emailPreferences para atualizar as preferências do usuário autenticado.
|
HomepageService
Serviço para oferecer suporte a uma API para a página inicial de uma loja.
ClaimHomepage |
---|
Reivindicar 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 de reivindicar, o que também isenta a verificação) e uma resposta de sucesso será retornada. Se não for possível verificar a propriedade, um erro será retornado, mas a reivindicação não será limpa. Em caso de falha, uma mensagem de erro canônico será retornada: * PERMISSION_DENIED: o usuário não tem as permissões necessárias na conta do MC. * FAILED_PRECONDITION: - A conta não é do Merchant Center. - A conta do MC não tem uma página inicial. - A reivindicação falhou. Nesse caso, a mensagem de erro vai conter mais detalhes.
|
GetHomepage |
---|
Recupera a página inicial de uma loja.
|
UnclaimHomepage |
---|
Cancela a reivindicação da página inicial de uma loja. A execução desse método requer acesso de administrador.
|
UpdateHomepage |
---|
Atualiza a página inicial de uma loja. A execução desse método requer acesso de administrador.
|
OnlineReturnPolicyService
O serviço facilita o gerenciamento da configuração da política de devolução por arrependimento de um comerciante, incluindo políticas de devolução para anúncios e listagens sem custo financeiro.
programas. Essa API define o seguinte modelo de recurso:
[OnlineReturnPolicy][google.shopping.merchant.accounts.v1.OnlineReturnPolicy]
GetOnlineReturnPolicy |
---|
Retorna uma política de devolução existente para um determinado comerciante.
|
ListOnlineReturnPolicies |
---|
Lista todas as políticas de devolução de um determinado comerciante.
|
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 produtos sem custo financeiro, que permite que os produtos da loja de um comerciante sejam mostrados no Google sem custo financeiro.
Esse serviço expõe 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 |
---|
Desative a participação no programa especificado para a conta. A execução desse método requer acesso de administrador.
|
EnableProgram |
---|
Ative a participação no programa especificado para a conta. A execução desse método requer acesso de administrador.
|
GetProgram |
---|
Recupera o programa especificado para a conta.
|
ListPrograms |
---|
Recupera todos os programas da conta.
|
RegionsService
Gerencia a configuração de regiões.
Essa API define o seguinte modelo de recurso:
Region
CreateRegion |
---|
Cria uma definição de região na sua conta do Merchant Center. A execução desse método requer acesso de administrador.
|
DeleteRegion |
---|
Exclui uma definição de região da sua conta do Merchant Center. A execução desse método requer acesso de administrador.
|
GetRegion |
---|
Recupera uma região definida na sua conta do Merchant Center.
|
ListRegions |
---|
Lista as regiões na sua conta do Merchant Center.
|
UpdateRegion |
---|
Atualiza a definição de uma região na sua conta do Merchant Center. A execução desse método requer acesso de administrador.
|
ShippingSettingsService
Serviço para receber informações de configuração de frete de chamada de método por método da API Merchant.
GetShippingSettings |
---|
Extrair informações das configurações de frete.
|
InsertShippingSettings |
---|
Substitua a configuração de frete de um comerciante pela configuração de frete de solicitação. A execução desse método requer acesso de administrador.
|
TermsOfServiceAgreementStateService
Serviço para oferecer suporte à API TermsOfServiceAgreementState
.
GetTermsOfServiceAgreementState |
---|
Retorna o estado de um contrato de Termos de Serviço.
|
RetrieveForApplicationTermsOfServiceAgreementState |
---|
Recupera o estado do acordo para os Termos de Serviço do aplicativo.
|
TermsOfServiceService
Serviço para oferecer suporte à API TermsOfService
.
AcceptTermsOfService |
---|
Aceita um
|
GetTermsOfService |
---|
Recupera o
|
RetrieveLatestTermsOfService |
---|
Recupera a versão mais recente do
|
UserService
Serviço para oferecer suporte à API do usuário.
CreateUser |
---|
Cria um usuário da conta do Merchant Center. A execução desse método requer acesso de administrador.
|
DeleteUser |
---|
Exclui um usuário da conta do Merchant Center. A execução desse método requer acesso de administrador. O usuário a ser excluído não pode ser o último administrador da conta. Além disso, a exclusão de um usuário é protegida se ele for gerenciado pelo Gerenciador de negócios.
|
GetUser |
---|
Recupera um usuário da conta do Merchant Center.
|
ListUsers |
---|
Lista todos os usuários de uma conta do Merchant Center.
|
UpdateUser |
---|
Atualiza um usuário da conta do Merchant Center. A execução desse método requer acesso de administrador.
|
AcceptTermsOfServiceRequest
Solicite mensagem para o método AcceptTermsOfService
.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso da versão dos Termos de Serviço. Formato: |
account |
Obrigatório. A conta para aceitar os TOS. |
region_ |
Obrigatório. Código regional, conforme definido pelo CLDR. É um país quando os TOS se aplicam especificamente a ele ou 001 quando se aplicam globalmente. |
Aceito
Descreve os Termos de Serviço aceitos.
Campos | |
---|---|
terms_ |
Os termsOfService aceitos. |
accepted_ |
A conta em que a aceitação foi registrada. Pode ser a própria conta ou, no caso de subcontas, a conta de MCA. |
valid_ |
Quando definido, indica que os TermsOfService aceitos são válidos apenas até o fim dessa 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.
Enums | |
---|---|
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 |
Os usuários com esse direito têm acesso a performance e insights. |
Conta
A mensagem Account
representa a conta de um comerciante nos anúncios do Shopping. É a entidade principal para gerenciar dados, configurações e interações do produto com os serviços do Google e provedores externos.
As contas podem operar como entidades independentes ou fazer parte de uma estrutura de conta de múltiplos clientes (MCA). Em uma configuração de MCA, a conta principal gerencia várias subcontas.
Criar uma conta envolve configurar atributos como nome, fuso horário e preferências de idioma.
A mensagem Account
é a entidade pai de muitos outros recursos, por exemplo, AccountRelationship
, Homepage
, BusinessInfo
e assim por diante.
Campos | |
---|---|
name |
Identificador. O nome do recurso da conta. Formato: |
account_ |
Apenas saída. O ID da conta. |
account_ |
Obrigatório. Um nome legível da conta. Consulte nome da loja e nome da empresa para mais informações. |
adult_ |
Indica se a conta tem conteúdo adulto. |
test_ |
Apenas saída. Indica se esta é uma conta de teste. |
time_ |
Obrigatório. O fuso horário da conta. Nas gravações, Para leituras, |
language_ |
Obrigatório. O código de idioma BCP-47 da conta, como |
AccountAggregation
Esse tipo não tem campos.
Payload AccountAggregation
.
AccountIssue
Um AccountIssue
.
Campos | |
---|---|
name |
Identificador. O nome do recurso do problema da conta. Formato: |
title |
O título localizado do problema. |
severity |
A gravidade geral do problema. |
impacted_ |
O impacto desse problema em vários destinos. |
detail |
Mais detalhes localizados sobre o problema. |
documentation_ |
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[] |
O impacto (negativo) para várias regiões no destino. |
reporting_ |
O contexto de relatório afetado. |
Impacto
O impacto do problema em uma região.
Campos | |
---|---|
region_ |
O código de região CLDR em que o problema se aplica. |
severity |
A gravidade do problema no destino e na região. |
Gravidade
Todas as gravidades possíveis.
Enums | |
---|---|
SEVERITY_UNSPECIFIED |
A gravidade é desconhecida. |
CRITICAL |
O problema faz com que as ofertas não sejam veiculadas. |
ERROR |
O problema pode afetar as ofertas (no futuro) ou indicar problemas com elas. |
SUGGESTION |
O problema é uma sugestão de melhoria. |
Endereço
Endereço de entrega do depósito.
Campos | |
---|---|
street_ |
Parte do endereço referente à rua. Por exemplo, |
city |
Obrigatório. Cidade, município ou comuna. Também pode incluir localidades ou sublocalidades dependentes (por exemplo, bairros ou subúrbios). |
administrative_ |
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_ |
Obrigatório. Código postal ou CEP (por exemplo, "94043"). |
region_ |
Obrigatório. Código de país CLDR (por exemplo, "US"). |
AutofeedSettings
Coleta de informações relacionadas às configurações de alimentação automática.
Campos | |
---|---|
name |
Identificador. O nome do recurso das configurações de alimentação automática. Formato: |
enable_ |
Obrigatório. Ativa ou desativa o rastreamento de produtos pelo feed automático para a conta. As contas de alimentação automática precisam atender a certas condições, que podem ser verificadas no campo |
eligible |
Apenas saída. Determina se o comerciante está qualificado para participar de um feed automático. |
BusinessDayConfig
Dias úteis do armazém.
Campos | |
---|---|
business_ |
Obrigatório. Dias úteis regulares. Não pode estar vazio. |
Dia da semana
Enums | |
---|---|
WEEKDAY_UNSPECIFIED |
|
MONDAY |
|
TUESDAY |
|
WEDNESDAY |
|
THURSDAY |
|
FRIDAY |
|
SATURDAY |
|
SUNDAY |
BusinessIdentity
Coleta de informações relacionadas à identidade de uma empresa.
Campos | |
---|---|
name |
Identificador. O nome do recurso da identidade da empresa. Formato: |
promotions_ |
Obrigatório. Se os atributos de identidade podem ser usados para promoções. |
black_ |
Opcional. Especifica se a empresa se identifica como de propriedade de negros. Esse campo opcional só vai estar disponível para comerciantes com um país de negócios definido como |
women_ |
Opcional. Especifica se a empresa se identifica como de propriedade de mulheres. Esse campo opcional só vai estar disponível para comerciantes com um país de negócios definido como |
veteran_ |
Opcional. Especifica se a empresa se identifica como de propriedade de veteranos de guerra. Esse campo opcional só vai estar disponível para comerciantes com um país de negócios definido como |
latino_ |
Opcional. Especifica se a empresa se identifica como de propriedade de latinos. Esse campo opcional só vai estar disponível para comerciantes com um país de negócios definido como |
small_ |
Opcional. Especifica se a empresa se identifica como pequena. Esse campo opcional só vai estar disponível para comerciantes com um país de negócios definido como |
IdentityAttribute
Todas as informações relacionadas a um atributo de identidade.
Campos | |
---|---|
identity_ |
Obrigatório. A declaração de identidade para esse atributo. |
IdentityDeclaration
Todas as configurações possíveis relacionadas à declaração de uma identidade.
Enums | |
---|---|
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 relacionadas a promoções relacionadas à identidade da empresa.
Enums | |
---|---|
PROMOTIONS_CONSENT_UNSPECIFIED |
Valor padrão que indica que nenhuma seleção foi feita. |
PROMOTIONS_CONSENT_GIVEN |
Indica que a conta consentiu com o uso da identidade da empresa para promoções. |
PROMOTIONS_CONSENT_DENIED |
Indica que a conta não consentiu com o uso da identidade da empresa para promoções. |
BusinessInfo
A mensagem BusinessInfo
contém informações essenciais sobre a empresa de um comerciante.
Essa mensagem captura os principais detalhes da empresa, como endereço físico, contatos de atendimento ao cliente e identificadores específicos da região.
Campos | |
---|---|
name |
Identificador. O nome do recurso das informações comerciais. Formato: |
address |
Opcional. O endereço da empresa. Somente os campos |
phone |
Apenas saída. O número de telefone da empresa. |
phone_ |
Apenas saída. O estado da verificação de telefone da empresa. |
customer_ |
Opcional. O atendimento ao cliente da empresa. |
korean_ |
Opcional. O número de registro comercial coreano de 10 dígitos separado por traços no formato: XXX-XX-XXXXX. |
CarrierRate
Uma lista de tarifas da operadora que pode ser referenciada por main_table
ou single_value
. Os serviços de operadoras com suporte estão definidos em https://support.google.com/merchants/answer/12577710?ref_topic=12570808&sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
Campos | |
---|---|
name |
Obrigatório. Nome da tarifa da operadora. Precisa ser exclusivo por grupo de tarifas. |
carrier |
Obrigatório. Serviço de operadora, como |
carrier_ |
Obrigatório. Serviço de operadora, como |
origin_ |
Obrigatório. Origem do envio para essa tarifa da transportadora. |
percentage_ |
Opcional. Modificador multiplicativo da taxa de frete como um número em notação decimal. Pode ser negativo. Por exemplo, |
flat_ |
Opcional. Modificador aditivo da taxa de frete. Pode ser negativo. Por exemplo, |
ClaimHomepageRequest
Solicite mensagem para o método ClaimHomepage
.
Campos | |
---|---|
name |
Obrigatório. O nome da página inicial a ser reivindicada. Formato: |
overwrite |
Opcional. Quando definida como |
CreateAndConfigureAccountRequest
Solicite mensagem para o método CreateAndConfigureAccount
.
Campos | |
---|---|
account |
Obrigatório. A conta a ser criada. |
users[] |
Opcional. Usuários a serem adicionados à conta. |
service[] |
Obrigatório. Um serviço de conta entre a conta a ser criada e a conta do provedor é inicializado como parte da criação. É necessário fornecer pelo menos um desses serviços. No momento, exatamente um deles precisa ser |
AddAccountService
Outras instruções para adicionar serviços de conta durante a criação da conta.
Campos | |
---|---|
Campo de união service_type . O tipo de serviço a ser adicionado. service_type pode ser apenas de um dos tipos a seguir: |
|
account_ |
O provedor é um agregador da conta. Payload para o tipo de serviço "Agregação de contas". |
provider |
Obrigatório. O provedor do serviço. Formato: |
CreateRegionRequest
Solicite mensagem para o método CreateRegion
.
Campos | |
---|---|
parent |
Obrigatório. A conta para a qual criar uma região. Formato: |
region_ |
Obrigatório. O identificador da região, exclusivo em todas as regiões da mesma conta. |
region |
Obrigatório. A região a ser criada. |
CreateUserRequest
Solicite mensagem para o método CreateUser
.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso da conta para a qual um usuário será criado. Formato: |
user_ |
Obrigatório. O endereço de e-mail do usuário (por exemplo, |
user |
Obrigatório. O usuário a ser criado. |
CustomerService
Informações de atendimento ao cliente.
Campos | |
---|---|
uri |
Opcional. O URI em que o atendimento ao cliente pode ser encontrado. |
email |
Opcional. O endereço de e-mail para contato com o atendimento ao cliente. |
phone |
Opcional. O número de telefone para entrar em contato com o atendimento ao cliente. |
CutoffTime
Definição do horário limite dos dias úteis.
Campos | |
---|---|
hour |
Obrigatório. Horário limite até o qual um pedido precisa ser feito para ser processado no mesmo dia. |
minute |
Obrigatório. Minuto do horário limite até o qual um pedido precisa ser feito para ser processado no mesmo dia. |
time_ |
Obrigatório. Identificador de fuso horário. Por exemplo, "Europe/Zurich". |
DeleteAccountRequest
Solicite mensagem para o método DeleteAccount
.
Campos | |
---|---|
name |
Obrigatório. O nome da conta a ser excluída. Formato: |
force |
Opcional. Se definido como |
DeleteRegionRequest
Solicite mensagem para o método DeleteRegion
.
Campos | |
---|---|
name |
Obrigatório. O nome da região a ser excluída. Formato: |
DeleteUserRequest
Solicite mensagem para o método DeleteUser
.
Campos | |
---|---|
name |
Obrigatório. O nome do usuário a ser excluído. Formato: Também é possível excluir o usuário correspondente ao autor da chamada usando |
DeliveryTime
Tempo gasto em vários aspectos, desde o pedido até a entrega do produto.
Campos | |
---|---|
warehouse_ |
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 de trânsito em [tempo de entrega][[google.shopping.content.bundles.ShippingSetting.DeliveryTime] precisa ser definido. |
min_ |
Número mínimo de dias úteis que são gastos em trânsito. 0 significa entrega no mesmo dia e 1 significa entrega no dia seguinte. É necessário definir |
max_ |
Número máximo de dias úteis que são gastos em trânsito. 0 significa entrega no mesmo dia e 1 significa entrega no dia seguinte. Precisa ser maior ou igual a |
cutoff_ |
Definição do horário limite dos dias úteis. Se não for configurado, o horário limite será 8h no horário padrão do Pacífico. |
min_ |
Número mínimo de dias úteis gastos antes do envio de um pedido. 0 significa envio no mesmo dia e 1 significa envio no dia seguinte. "min_handling_days" e "max_handling_days" precisam ser definidos ou não ao mesmo tempo. |
max_ |
Número máximo de dias úteis gastos antes do envio de um pedido. 0 significa envio no mesmo dia e 1 significa envio no dia seguinte. Precisa ser maior ou igual a |
transit_ |
Tabela de tempo de trânsito, número de dias úteis gastos em trânsito com base nas dimensões de linha e coluna. É possível definir |
handling_ |
Os dias úteis em que os pedidos podem ser processados. Se não forem informados, os dias úteis de segunda a sexta-feira serão considerados. |
transit_ |
Os dias úteis em que os pedidos podem estar em trânsito. Se não forem informados, os dias úteis de segunda a sexta-feira serão considerados. |
DisableProgramRequest
Mensagem de solicitação para o método DisableProgram.
Campos | |
---|---|
name |
Obrigatório. O nome do programa em que a participação da conta será desativada. Formato: |
Distância
Raio máximo de entrega. Isso é necessário apenas para o tipo de envio de entrega local.
Campos | |
---|---|
value |
Valor inteiro da distância. |
unit |
A unidade pode variar de acordo com o país e é parametrizada para incluir milhas e quilômetros. |
Unidade
A unidade pode variar de acordo com o país e é parametrizada para incluir milhas e quilômetros.
Enums | |
---|---|
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 / desativou. As preferências de e-mail não incluem anúncios obrigatórios, já que os usuários não podem desativar esse recurso.
Campos | |
---|---|
name |
Identificador. O nome das EmailPreferences. O endpoint só tem suporte para o usuário autenticado. |
news_ |
Opcional. Atualizações sobre novos recursos, dicas e práticas recomendadas. |
OptInState
Estado de ativação da preferência de e-mail.
Enums | |
---|---|
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 ativou o recebimento desse tipo de e-mail. |
UNCONFIRMED |
O usuário ativou o recebimento desse 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 apenas a determinados países). |
EnableProgramRequest
Mensagem de solicitação para o método EnableProgram.
Campos | |
---|---|
name |
Obrigatório. O nome do programa em que a participação da conta será ativada. Formato: |
GetAccountRequest
Solicite mensagem para o método GetAccount
.
Campos | |
---|---|
name |
Obrigatório. O nome da conta a ser recuperada. Formato: |
GetAutofeedSettingsRequest
Solicite mensagem para o método GetAutofeedSettings
.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso das configurações de alimentação automática. Formato: |
GetBusinessIdentityRequest
Solicite mensagem para o método GetBusinessIdentity
.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso da identidade da empresa. Formato: |
GetBusinessInfoRequest
Solicite mensagem para o método GetBusinessInfo
.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso das informações comerciais. Formato: |
GetEmailPreferencesRequest
Solicita uma mensagem para o método GetEmailPreferences.
Campos | |
---|---|
name |
Obrigatório. |
GetHomepageRequest
Solicite mensagem para o método GetHomepage
.
Campos | |
---|---|
name |
Obrigatório. O nome da página inicial a ser recuperada. Formato: |
GetOnlineReturnPolicyRequest
Solicite mensagem para o método GetOnlineReturnPolicy
.
Campos | |
---|---|
name |
Obrigatório. O nome da política de devolução a ser recuperada. Formato: |
GetProgramRequest
Mensagem de solicitação para o método GetProgram.
Campos | |
---|---|
name |
Obrigatório. O nome do programa a ser recuperado. Formato: |
GetRegionRequest
Solicite mensagem para o método GetRegion
.
Campos | |
---|---|
name |
Obrigatório. O nome da região a ser recuperada. Formato: |
GetShippingSettingsRequest
Solicite mensagem para o método GetShippingSetting
.
Campos | |
---|---|
name |
Obrigatório. O nome da configuração de frete a ser recuperada. Formato: |
GetTermsOfServiceAgreementStateRequest
Solicite mensagem para o método GetTermsOfServiceAgreementState
.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso da versão dos Termos de Serviço. Formato: |
GetTermsOfServiceRequest
Solicite mensagem para o método GetTermsOfService
.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso da versão dos Termos de Serviço. Formato: |
GetUserRequest
Solicite mensagem para o método GetUser
.
Campos | |
---|---|
name |
Obrigatório. O nome do usuário a ser recuperado. Formato: Também é possível recuperar o usuário correspondente ao autor da chamada usando |
Cabeçalhos
Uma lista não vazia de cabeçalhos de linha ou coluna de uma tabela. Exatamente um entre prices
, weights
, num_items
, postal_code_group_names
ou location
precisa ser definido.
Campos | |
---|---|
prices[] |
Obrigatório. Uma lista de limites máximos de preço de pedidos com tributos. O valor do último preço pode ser infinito definindo price amount_micros = -1. Por exemplo, |
weights[] |
Obrigatório. Uma lista de limites máximos de peso de pedidos inclusivos. O valor do último peso pode ser infinito definindo price amount_micros = -1. Por exemplo, |
number_ |
Obrigatório. Uma lista de número de limites superiores de itens inclusivos. O último valor pode ser |
postal_ |
Obrigatório. Uma lista de nomes de grupos postais. O último valor pode ser |
locations[] |
Obrigatório. Uma lista de conjuntos de IDs de local. Precisa estar preenchido. Só pode ser definido se todos os outros campos não estiverem definidos. |
Página inicial
A mensagem Homepage
representa a página inicial da loja de um comerciante no sistema.
A página inicial de um comerciante é o domínio principal em que os clientes interagem com a loja.
A página inicial pode ser reivindicada e verificada como prova de propriedade e permite que o comerciante desbloqueie recursos que exigem um site verificado. Para mais informações, consulte Sobre a verificação de URL de loja on-line.
Campos | |
---|---|
name |
Identificador. O nome do recurso da página inicial da loja. Formato: |
claimed |
Apenas saída. Se a página inicial foi reivindicada. Consulte https://support.google.com/merchants/answer/176793. |
uri |
Obrigatório. O URI (normalmente um URL) da página inicial da loja. |
InsertShippingSettingsRequest
Solicite mensagem para o método InsertShippingSetting
.
Campos | |
---|---|
parent |
Obrigatório. A conta em que esse produto será inserido. Formato: accounts/{account} |
shipping_ |
Obrigatório. A nova versão da conta. |
ListAccountIssuesRequest
Solicite mensagem para o método ListAccountIssues
.
Campos | |
---|---|
parent |
Obrigatório. O pai, que é proprietário dessa coleção de problemas. Formato: |
page_ |
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, no máximo 50 usuários serão retornados. O valor máximo é 100. Valores acima disso vão ser convertidos para 100. |
page_ |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
language_ |
Opcional. Os problemas na resposta terão campos legíveis por humanos no idioma especificado. O formato é BCP-47, como |
time_ |
Opcional. O fuso horário da IANA usado para localizar horários em campos legíveis por humanos. Por exemplo, "America/Los_Angeles". Se não for definido, "America/Los_Angeles" será usado. |
ListAccountIssuesResponse
Mensagem de resposta para o método ListAccountIssues
.
Campos | |
---|---|
account_ |
Os problemas da conta especificada. |
next_ |
Um token, que pode ser enviado como |
ListAccountsRequest
Solicite mensagem para o método ListAccounts
.
Campos | |
---|---|
page_ |
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, no máximo 250 contas serão retornadas. O valor máximo é 500. Valores acima disso são convertidos para 500. |
page_ |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
filter |
Opcional. Retorna apenas as contas que correspondem ao filtro. Para mais detalhes, consulte a referência da sintaxe de filtro. |
ListAccountsResponse
Mensagem de resposta para o método ListAccounts
.
Campos | |
---|---|
accounts[] |
As contas que correspondem ao |
next_ |
Um token, que pode ser enviado como |
ListOnlineReturnPoliciesRequest
Solicite mensagem para o método ListOnlineReturnPolicies
.
Campos | |
---|---|
parent |
Obrigatório. A conta do comerciante para listar as políticas de devolução. Formato: |
page_ |
Opcional. O número máximo de recursos |
page_ |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
ListOnlineReturnPoliciesResponse
Mensagem de resposta para o método ListOnlineReturnPolicies
.
Campos | |
---|---|
online_ |
As políticas de devolução recuperadas. |
next_ |
Um token, que pode ser enviado como |
ListProgramsRequest
Mensagem de solicitação para o método ListPrograms.
Campos | |
---|---|
parent |
Obrigatório. O nome da conta para a qual todos os programas serão recuperados. Formato: |
page_ |
Opcional. O número máximo de programas a serem retornados em uma única resposta. Se não for especificado (ou 0), um tamanho padrão de 1.000 será usado. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000. |
page_ |
Opcional. Um token de continuação recebido de uma chamada |
ListProgramsResponse
Mensagem de resposta para o método ListPrograms.
Campos | |
---|---|
programs[] |
Os programas da conta. |
next_ |
Um token que pode ser enviado como |
ListRegionsRequest
Solicite mensagem para o método ListRegions
.
Campos | |
---|---|
parent |
Obrigatório. A conta para listar as regiões. Formato: |
page_ |
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_ |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
ListRegionsResponse
Mensagem de resposta para o método ListRegions
.
Campos | |
---|---|
regions[] |
As regiões do comerciante especificado. |
next_ |
Um token, que pode ser enviado como |
ListSubAccountsRequest
Solicite mensagem para o método ListSubAccounts
.
Campos | |
---|---|
provider |
Obrigatório. A conta de familiar responsável. Formato: |
page_ |
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, no máximo 250 contas serão retornadas. O valor máximo é 500. Valores acima disso são convertidos para 500. |
page_ |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
ListSubAccountsResponse
Mensagem de resposta para o método ListSubAccounts
.
Campos | |
---|---|
accounts[] |
As contas para as quais a conta principal é um agregador. |
next_ |
Um token, que pode ser enviado como |
ListUsersRequest
Solicite mensagem para o método ListUsers
.
Campos | |
---|---|
parent |
Obrigatório. O pai, que é proprietário dessa coleção de usuários. Formato: |
page_ |
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, no máximo 50 usuários serão retornados. O valor máximo é 100. Valores acima disso vão ser convertidos para 100. |
page_ |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
ListUsersResponse
Mensagem de resposta para o método ListUsers
.
Campos | |
---|---|
users[] |
Os usuários da conta especificada. |
next_ |
Um token, que pode ser enviado como |
LocationIdSet
Uma lista de conjuntos de IDs de local. Precisa estar preenchido. Só pode ser definido se todos os outros campos não estiverem definidos.
Campos | |
---|---|
location_ |
Obrigatório. Uma lista não vazia de IDs de local. Elas precisam ser do mesmo tipo de local (por exemplo, estado). |
MinimumOrderValueTable
Tabela de valores mínimos de pedidos por loja para o tipo de fulfillment de retirada.
Campos | |
---|---|
store_ |
Obrigatório. Uma lista de conjuntos de códigos da loja que compartilham o mesmo valor mínimo do pedido (MOV). Pelo menos dois conjuntos são necessários, e o último precisa estar vazio, o que significa "MOV para todas as outras lojas". Cada código da loja só pode aparecer uma vez em todos os conjuntos. Todos os preços em um serviço precisam ter a mesma moeda. |
StoreCodeSetWithMov
Uma lista de conjuntos de códigos de loja que compartilham o mesmo valor mínimo do pedido. Pelo menos dois conjuntos são necessários, e o último precisa estar vazio, o que significa "MOV para todas as outras lojas". Cada código da loja só pode aparecer uma vez em todos os conjuntos. Todos os preços em um serviço precisam ter a mesma moeda.
Campos | |
---|---|
store_ |
Opcional. Uma lista de códigos de loja exclusivos ou vazia para o catch-all. |
value |
O valor mínimo do pedido para as lojas. |
OnlineReturnPolicy
Objeto Política de devolução on-line. Atualmente, esse campo é usado para representar políticas de devolução para anúncios e programas de listagens sem custo financeiro.
Campos | |
---|---|
name |
Identificador. |
return_ |
Apenas saída. ID da política de devolução gerado pelo Google. |
label |
Obrigatório. Esse campo representa o rótulo definido pelo usuário da política de devolução. É importante observar que o mesmo rótulo não pode ser usado em políticas de devolução diferentes 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 fornecidas na Etiqueta da política de devolução. O rótulo pode ter até 50 caracteres. |
countries[] |
Obrigatório. Os países de venda em que a política de devolução se aplica. Os valores precisam ser um código ISO 3166 de duas letras válido. |
policy |
A política de devolução. |
restocking_ |
A taxa de reposição que se aplica a todas as categorias de motivo da devolução. Isso será tratado como uma taxa de reposição sem custo financeiro se o valor não for definido. |
return_ |
Os métodos de devolução que os clientes podem usar para devolver um item. Esse valor não pode estar vazio, a menos que o tipo de política de devolução seja "noReturns". |
item_ |
As condições do item aceitas para devoluções não podem estar vazias, a menos que o tipo de política de devolução seja "noReturns". |
return_ |
A tarifa de frete de devolução. Só deve ser definido quando o cliente precisar fazer o download e imprimir a etiqueta de devolução. |
return_ |
Obrigatório. O URI da política de devolução. O Google pode usar isso para fazer uma verificação de sanidade da política. Precisa ser um URL válido. |
accept_ |
Este campo especifica se o comerciante aceita apenas produtos com defeito para devoluções. Ele é obrigatório. |
process_ |
O campo especifica o número de dias que os comerciantes levam para processar reembolsos. Ele é opcional. |
accept_ |
Este campo especifica se o comerciante permite que os clientes troquem produtos. Ele é obrigatório. |
ItemCondition
As condições do item disponível.
Enums | |
---|---|
ITEM_CONDITION_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
NEW |
Novo. |
USED |
Usado. |
Política
As políticas disponíveis.
Campos | |
---|---|
type |
Tipo de política. |
days |
O número de dias que os itens podem ser devolvidos após a entrega, sendo que um dia é definido como 24 horas após o carimbo de data/hora da entrega. Obrigatório para devoluções de |
Tipo
Tipos de política de devolução.
Enums | |
---|---|
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 |
Devolução ilimitada. |
RestockingFee
A taxa de reposição do estoque. Pode ser uma taxa fixa ou uma porcentagem mínima.
Campos | |
---|---|
Campo de união
|
|
fixed_ |
Taxa de reposição de estoque fixa. |
micro_ |
Porcentagem do preço total em micros. 15.000.000 significa que 15% do preço total serão cobrados. |
ReturnMethod
Os métodos de devolução disponíveis.
Enums | |
---|---|
RETURN_METHOD_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
BY_MAIL |
Devolução por correio. |
IN_STORE |
Devolução na loja. |
AT_A_KIOSK |
Devolução em um quiosque. |
ReturnShippingFee
A tarifa de frete de devolução. Pode ser uma taxa fixa ou um valor booleano para indicar que o cliente paga o custo real do frete.
Campos | |
---|---|
type |
Obrigatório. Tipo de taxa de frete de devolução. |
fixed_ |
Valor fixo da tarifa de frete de devolução. Esse valor só é aplicável quando o tipo é |
Tipo
Tipos de tarifa de frete de devolução.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
FIXED |
A tarifa de frete de devolução é um valor fixo. |
CUSTOMER_PAYING_ACTUAL_FEE |
Os clientes vão pagar a taxa de frete de devolução real. |
PhoneVerificationState
O estado da verificação do smartphone.
Enums | |
---|---|
PHONE_VERIFICATION_STATE_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
PHONE_VERIFICATION_STATE_VERIFIED |
O celular foi verificado. |
PHONE_VERIFICATION_STATE_UNVERIFIED |
O smartphone não está verificado |
Programa
Define a participação em um determinado programa para a conta especificada.
Os programas oferecem um mecanismo para adicionar funcionalidades às contas do comerciante. Um exemplo típico disso é o programa de listagens de produtos sem custo financeiro, que permite que os produtos da loja de um comerciante sejam mostrados no Google sem custo financeiro.
Campos | |
---|---|
name |
Identificador. O nome do recurso do programa. Formato: |
documentation_ |
Apenas saída. O URL de uma página de ajuda do Merchant Center que descreve o programa. |
state |
Apenas saída. O estado de participação da conta no programa. |
active_ |
Apenas saída. As regiões em que a conta está participando ativamente do programa. As regiões ativas são definidas como aquelas em que todos os requisitos do programa que afetam as regiões foram atendidos. Os códigos regionais são definidos pelo CLDR. É um país em que o programa se aplica especificamente a esse país ou |
unmet_ |
Apenas saída. Os requisitos que a conta ainda não atendeu e que estão afetando a participação no programa. |
Requisito
Define um requisito especificado para a participação no programa.
Campos | |
---|---|
title |
Apenas saída. Nome do requisito. |
documentation_ |
Apenas saída. O URL de uma página de ajuda que descreve o requisito. |
affected_ |
Apenas saída. As regiões que estão sendo afetadas por esse requisito não ser atendido. Os códigos regionais são definidos pelo CLDR. É um país em que o programa se aplica especificamente a esse país ou |
Estado
Possíveis estados de participação no programa da conta.
Enums | |
---|---|
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. Apenas o último pode ter um applicable_shipping_labels
vazio, o que significa "tudo o mais". As outras applicable_shipping_labels
não podem se sobrepor.
Campos | |
---|---|
applicable_ |
Obrigatório. Uma lista de rótulos para envio que define os produtos a que esse grupo de tarifas se aplica. Esta é uma disjunção: apenas um dos rótulos precisa corresponder para que o grupo de tarifas seja aplicado. Só pode estar vazio para o último grupo de tarifas de um serviço. |
subtables[] |
Opcional. Uma lista de subtabelas referenciadas por |
carrier_ |
Opcional. Uma lista de tarifas da operadora que pode ser referenciada por |
single_ |
O valor do grupo de tarifas (por exemplo, tarifa fixa de US $10). Só pode ser definido se |
main_ |
Uma tabela que define o grupo de tarifas, quando |
name |
Opcional. Nome do grupo de tarifas. Se definido, o ID 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 coleções de códigos postais ou, em alguns países, usar geotargets predefinidos. Para mais informações, consulte Configurar regiões .
Campos | |
---|---|
name |
Identificador. O nome do recurso da região. Formato: |
postal_ |
Opcional. Uma lista de códigos postais que define a área da região. |
geotarget_ |
Opcional. Uma lista de segmentações por área geográfica que define a área da região. |
regional_ |
Apenas saída. Indica se a região está qualificada para uso na configuração do inventário regional. |
shipping_ |
Apenas saída. Indica se a região está qualificada para uso na configuração dos serviços de frete. |
display_ |
Opcional. O nome de exibição da região. |
GeoTargetArea
Uma lista de segmentações por área geográfica que define a área da região.
Campos | |
---|---|
geotarget_ |
Obrigatório. Uma lista não vazia de IDs de local. Elas 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 pelo recurso ShippingSettings.postalCodeGroups
da conta.
Campos | |
---|---|
region_ |
Obrigatório. Código de território CLDR ou o país em que o grupo de CEPs é aplicado. |
postal_ |
Obrigatório. Um intervalo de códigos postais. |
PostalCodeRange
Um intervalo de códigos postais que define a área da região.
Campos | |
---|---|
begin |
Obrigatório. Um código postal ou um padrão do formulário prefixo* que indica o limite inferior incluído do intervalo que define a área. Exemplos de valores: |
end |
Opcional. Um código postal ou um padrão do formato |
Obrigatório
Descreve os Termos de Serviço que precisam ser aceitos.
Campos | |
---|---|
terms_ |
Os termsOfService que precisam ser aceitos. |
tos_ |
URL completo do arquivo dos Termos de Serviço. Esse campo é igual a TermsOfService.file_uri e foi adicionado aqui apenas para sua conveniência. |
RetrieveForApplicationTermsOfServiceAgreementStateRequest
Solicite mensagem para o método RetrieveForApplicationTermsOfServiceAgreementState
.
Campos | |
---|---|
parent |
Obrigatório. A conta para receber um formato TermsOfServiceAgreementState: |
RetrieveLatestTermsOfServiceRequest
Solicite mensagem para o método RetrieveLatestTermsOfService
.
Campos | |
---|---|
region_ |
Obrigatório. Código regional, conforme definido pelo CLDR. É um país quando os TOS se aplicam especificamente a ele ou 001 quando se aplicam globalmente. |
kind |
Obrigatório. O tipo a que esta versão dos Termos de Serviço se aplica. |
Linha
Inclua uma lista de células.
Campos | |
---|---|
cells[] |
Obrigatório. A lista de células que constituem a linha. Precisa ter o mesmo comprimento de |
Serviço
Serviço de frete.
Campos | |
---|---|
delivery_ |
Obrigatório. O código de território CLDR dos países a que o serviço se aplica. |
rate_ |
Opcional. Definições do grupo de taxas de frete. Apenas o último pode ter um |
loyalty_ |
Opcional. Programas de fidelidade a que esse serviço de frete está limitado. |
service_ |
Obrigatório. Nome do serviço em formato livre. Precisa ser exclusivo na conta de destino. |
active |
Obrigatório. Um booleano que expõe o status ativo do serviço de frete. |
currency_ |
O código CLDR da moeda a que este serviço se aplica. Precisa corresponder ao dos preços nos grupos de tarifas. |
delivery_ |
Obrigatório. Tempo gasto em vários aspectos, desde o pedido até a entrega do produto. |
shipment_ |
Tipo de local para onde o serviço envia pedidos. |
minimum_ |
Valor mínimo do pedido para esse serviço. Se definido, indica que os clientes precisam gastar pelo menos esse valor. Todos os preços em um serviço precisam ter a mesma moeda. Não pode ser definido com minimum_order_value_table. |
minimum_ |
Tabela de valores mínimos de pedidos por loja para o tipo de fulfillment de retirada. Não pode ser definido com minimum_order_value. |
store_ |
Uma lista de lojas de onde os produtos são enviados. Isso é válido apenas para o tipo de envio de entrega local. |
LoyaltyProgram
Programa de fidelidade fornecido por um comerciante.
Campos | |
---|---|
loyalty_ |
Opcional. Nível do programa de fidelidade deste serviço de frete. |
program_ |
Este é o rótulo do programa de fidelidade definido nas configurações correspondentes no Merchant Center. Esse subatributo permite que o Google mapeie o programa de fidelidade para ofertas qualificadas. |
LoyaltyProgramTiers
Subconjunto de um programa de fidelidade do comerciante.
Campos | |
---|---|
tier_ |
O subatributo rótulo do 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 frete do serviço de frete.
Enums | |
---|---|
SHIPMENT_TYPE_UNSPECIFIED |
Este serviço não especificou o tipo de envio. |
DELIVERY |
Esse serviço envia pedidos para um endereço escolhido pelo cliente. |
LOCAL_DELIVERY |
Esse serviço envia pedidos para um endereço escolhido pelo cliente. O pedido é enviado de uma loja local próxima. |
COLLECTION_POINT |
Esse serviço envia pedidos para um endereço escolhido pelo cliente. O pedido é enviado de um ponto de coleta. |
StoreConfig
Uma lista de lojas de onde os produtos são enviados. Isso é válido apenas para o tipo de envio de entrega local.
Campos | |
---|---|
store_ |
Opcional. Uma lista de códigos de lojas que oferecem entrega local. Se estiver vazio, |
store_ |
Indica se todas as lojas ou lojas selecionadas listadas pelo comerciante oferecem entrega local. |
cutoff_ |
As configurações relacionadas à entrega local são encerradas para o dia. |
service_ |
Raio máximo de entrega. Isso é necessário apenas para o tipo de envio de entrega local. |
CutoffConfig
As configurações relacionadas à entrega local são encerradas para o dia.
Campos | |
---|---|
local_ |
Hora em que a entrega local termina no dia. |
store_ |
Válido apenas para fulfillment de entrega local. Representa o horário limite como o número de horas antes do fechamento da loja. Mutuamente exclusivo com |
no_ |
Os comerciantes podem desativar a exibição da entrega local em n+1 dia quando têm um serviço de frete configurado para a entrega local em n dias. Por exemplo, se o serviço de frete definir a entrega no mesmo dia e o prazo tiver passado, definir esse campo como |
LocalCutoffTime
Hora em que a entrega local termina no dia.
Campos | |
---|---|
hour |
Os pedidos de entrega local em uma hora precisam ser feitos até esse horário para serem processados no mesmo dia. |
minute |
Os pedidos de entrega local precisam ser feitos até esse horário para serem processados no mesmo dia. |
StoreServiceType
Indica se todas as lojas ou apenas algumas das listadas pelo comerciante oferecem entrega local.
Enums | |
---|---|
STORE_SERVICE_TYPE_UNSPECIFIED |
Não especificou o tipo de serviço da loja. |
ALL_STORES |
Indica se todas as lojas, atuais e futuras, listadas pelo 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 da conta do comerciante.
Campos | |
---|---|
name |
Identificador. O nome do recurso da configuração de frete. Formato: |
services[] |
Opcional. A lista de serviços da conta de destino. |
warehouses[] |
Opcional. Uma lista de depósitos que podem ser referenciados em |
etag |
Obrigatório. Esse campo é usado para evitar problemas assíncronos. Verifique se os dados de configuração de frete não mudaram entre as chamadas de recebimento e inserção. O usuário precisa seguir estas etapas:
|
Tabela
Uma tabela que define o grupo de tarifas, quando single_value
não é expressivo o suficiente.
Campos | |
---|---|
rows[] |
Obrigatório. A lista de linhas que constituem a tabela. Precisa ter o mesmo comprimento de |
name |
Nome da tabela. Obrigatório para subtabelas, ignorado para a tabela principal. |
row_ |
Obrigatório. Cabeçalhos das linhas da tabela. |
column_ |
Cabeçalhos das colunas da tabela. Opcional: se não for definido, a tabela terá apenas uma dimensão. |
TermsOfService
A mensagem TermsOfService
representa uma versão específica dos Termos de Serviço que os comerciantes precisam aceitar para acessar determinados recursos ou serviços. Consulte https://support.google.com/merchants/answer/160173).
Essa mensagem é importante para o processo de integração, garantindo que os comerciantes concordem com os contratos legais necessários para usar o serviço. Os comerciantes podem extrair os Termos de Serviço mais recentes de um determinado kind
e region
usando RetrieveLatestTermsOfService
e aceitá-los conforme necessário usando AcceptTermsOfService
.
Campos | |
---|---|
name |
Identificador. O nome do recurso da versão dos Termos de Serviço. Formato: |
region_ |
Código regional, conforme definido pelo CLDR. É um país em que os TOS se aplicam especificamente a esse país ou |
kind |
O tipo a que esta versão dos Termos de Serviço se aplica. |
external |
Se esta versão dos Termos de Serviço é externa. As versões externas dos Termos de Serviço só podem ser acordadas por processos externos, e não diretamente pelo comerciante por meio da interface ou da API. |
file_ |
URI do arquivo de termos de serviço que precisa ser exibido para os usuários que assinarem. |
TermsOfServiceAgreementState
Esse recurso representa o estado do contrato de uma determinada conta e os tipos de termos de serviço. O estado é o seguinte:
- Se o comerciante aceitou os Termos de Serviço: aceito será preenchido. Caso contrário, ele vai estar vazio
- Se o comerciante precisar assinar os Termos de Serviço: obrigatório será preenchido. Caso contrário, ele vai ficar vazio.
Tanto required quanto accepted podem estar presentes. Nesse caso, os termos de serviço 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 com um acordo válido. Ao aceitar novos termos de serviço, esperamos que os terceiros mostrem o texto associado ao contrato de termos de serviço. O URL do arquivo que contém o texto é adicionado à mensagem obrigatória abaixo como tos_file_uri. A aceitação real dos Termos de Serviço é feita chamando "accept" no recurso TermsOfService.
Campos | |
---|---|
name |
Identificador. O nome do recurso da versão dos Termos de Serviço. Formato: |
region_ |
Código regional, conforme definido em https://cldr.unicode.org/. País a que o estado atual se aplica. |
terms_ |
Termos de Serviço associados à versão específica. |
accepted |
Os termos de serviço aceitos desse tipo e para o region_code associado |
required |
Os Termos de Serviço necessários |
TermsOfServiceKind
O tipo TermsOfService.
Enums | |
---|---|
TERMS_OF_SERVICE_KIND_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
MERCHANT_CENTER |
Aplicativo do Merchant Center. |
TransitTable
Tabela de tempo de 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_ |
Obrigatório. Uma lista de nomes de regiões |
transit_ |
Obrigatório. Uma lista de rótulos de tempo em trânsito. O último valor pode ser |
rows[] |
Obrigatório. Se houver apenas um conjunto de dimensões de |
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 corresponde a uma postal_code_group_names
e as colunas (valores) a uma transit_time_labels
.
Campos | |
---|---|
values[] |
Obrigatório. Período de tempo em trânsito (mínimo-máximo) em dias úteis. |
TransitTimeValue
Período de tempo em trânsito (mínimo-máximo) em dias úteis.
Campos | |
---|---|
min_ |
Período mínimo de trânsito em dias úteis. 0 significa entrega no mesmo dia e 1 significa entrega no dia seguinte. |
max_ |
Precisa ser maior ou igual a |
UnclaimHomepageRequest
Solicite mensagem para o método UnclaimHomepage
.
Campos | |
---|---|
name |
Obrigatório. O nome da página inicial a ser revertida. Formato: |
UpdateAccountRequest
Solicite mensagem para o método UpdateAccount
.
Campos | |
---|---|
account |
Obrigatório. A nova versão da conta. |
update_ |
Opcional. Lista de campos que estão sendo atualizados. Os campos a seguir são aceitos (em
|
UpdateAutofeedSettingsRequest
Solicite mensagem para o método UpdateAutofeedSettings
.
Campos | |
---|---|
autofeed_ |
Obrigatório. A nova versão da configuração de alimentação automática. |
update_ |
Obrigatório. Lista de campos que estão sendo atualizados. |
UpdateBusinessIdentityRequest
Solicite mensagem para o método UpdateBusinessIdentity
.
Campos | |
---|---|
business_ |
Obrigatório. A nova versão da identidade da empresa. |
update_ |
Opcional. Lista de campos que estão sendo atualizados. Os campos a seguir são aceitos (em
|
UpdateBusinessInfoRequest
Solicite mensagem para o método UpdateBusinessInfo
.
Campos | |
---|---|
business_ |
Obrigatório. A nova versão das informações comerciais. |
update_ |
Opcional. Lista de campos que estão sendo atualizados. Os campos a seguir são aceitos (em
|
UpdateEmailPreferencesRequest
Solicita uma mensagem para o método UpdateEmailPreferences.
Campos | |
---|---|
email_ |
Obrigatório. As preferências de e-mail serão atualizadas. |
update_ |
Obrigatório. Lista de campos que estão sendo atualizados. Os campos a seguir são aceitos (em
|
UpdateHomepageRequest
Solicite mensagem para o método UpdateHomepage
.
Campos | |
---|---|
homepage |
Obrigatório. A nova versão da página inicial. |
update_ |
Opcional. Lista de campos que estão sendo atualizados. Os campos a seguir são aceitos (em
|
UpdateRegionRequest
Solicite mensagem para o método UpdateRegion
.
Campos | |
---|---|
region |
Obrigatório. A região atualizada. |
update_ |
Opcional. A máscara de campo separada por vírgulas que indica os campos a serem atualizados. Exemplo: |
UpdateUserRequest
Solicite mensagem para o método UpdateUser
.
Campos | |
---|---|
user |
Obrigatório. A nova versão do usuário. Use |
update_ |
Opcional. Lista de campos que estão sendo atualizados. Os campos a seguir são aceitos (em
|
Usuário
A mensagem User
representa um usuário associado a uma conta do Merchant Center. Ele é usado para gerenciar as permissões do usuário e os direitos de acesso na conta. Para mais informações, consulte as Perguntas frequentes sobre pessoas e níveis de acesso.
Campos | |
---|---|
name |
Identificador. O nome do recurso do usuário. Formato: Use |
state |
Apenas saída. O estado do usuário. |
access_ |
Opcional. Os direitos de acesso do usuário. |
Estado
Os estados possíveis de um usuário.
Enums | |
---|---|
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 é verificado. |
Valor
O valor único de um grupo de tarifas ou o valor da célula de uma tabela de grupo de tarifas. Exatamente um dos seguintes valores precisa ser definido: no_shipping
, flat_rate
, price_percentage
, carrier_rateName
, subtable_name
.
Campos | |
---|---|
no_ |
Se for verdadeiro, o produto não poderá ser enviado. Precisa ser verdadeiro quando definido e só pode ser definido se todos os outros campos não estiverem definidos. |
flat_ |
Uma taxa fixa. Só pode ser definido se todos os outros campos não estiverem definidos. |
price_ |
Uma porcentagem do preço representada como um número em notação decimal (por exemplo, |
carrier_ |
O nome de uma tarifa de transportadora que se refere a uma tarifa de transportadora definida no mesmo grupo de tarifas. Só pode ser definido se todos os outros campos não estiverem definidos. |
subtable |
O nome de uma subtabela. Só pode ser definido em células de tabela (por exemplo, não para valores únicos) e somente se todos os outros campos não estiverem definidos. |
Depósito
Um depósito de atendimento, que armazena e processa o inventário.
Campos | |
---|---|
name |
Obrigatório. O nome do warehouse. Precisa ser exclusivo na conta. |
shipping_ |
Obrigatório. Endereço de entrega do depósito. |
cutoff_ |
Obrigatório. O horário mais tarde do dia em que um pedido pode ser aceito e começar a ser processado. Os pedidos posteriores serão processados no dia seguinte. O tempo é baseado no código postal do depósito. |
handling_ |
Obrigatório. O número de dias que o depósito leva para embalar e enviar um item. Isso está no nível do depósito, mas pode ser substituído no nível da oferta com base nos atributos de um item. |
business_ |
Dias úteis do armazém. Se não for definido, será de segunda a sexta-feira por padrão. |
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 de trânsito em delivery_time
pode ser definido.
Campos | |
---|---|
carrier |
Obrigatório. Operadora, como |
carrier_ |
Obrigatório. Serviço de operadora, como |
warehouse |
Obrigatório. Nome do warehouse. Ele precisa corresponder a [warehouse][ShippingSetting.warehouses.name] |
WarehouseCutoffTime
O horário mais tarde do dia em que um pedido pode ser aceito e começar a ser processado. Os pedidos posteriores serão processados no dia seguinte. O tempo é baseado no código postal do depósito.
Campos | |
---|---|
hour |
Obrigatório. Hora do horário limite até o qual um pedido precisa ser feito para ser processado no mesmo dia pelo depósito. A hora é baseada no fuso horário do depósito. |
minute |
Obrigatório. Minuto do horário limite até o qual um pedido precisa ser feito para ser processado no mesmo dia pelo depósito. O minuto é baseado no fuso horário do depósito. |