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 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.

AccountsService

Serviço para oferecer suporte à API Accounts.

CreateAndConfigureAccount

rpc CreateAndConfigureAccount(CreateAndConfigureAccountRequest) returns (Account)

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.

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 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 force para substituir isso.

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 vários minutos para que as mudanças 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 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.

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)

Lista todas as subcontas de uma determinada conta de múltiplos clientes. Esse é um wrapper prático para o método ListAccounts mais poderoso. Esse método vai 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, seja ela 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.

AutofeedSettingsService

Serviço para oferecer suporte à configuração de alimentação automática.

GetAutofeedSettings

rpc GetAutofeedSettings(GetAutofeedSettingsRequest) returns (AutofeedSettings)

Recupera as configurações de alimentação automática 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.

UpdateAutofeedSettings

rpc UpdateAutofeedSettings(UpdateAutofeedSettingsRequest) returns (AutofeedSettings)

Atualiza as configurações de alimentação automática 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.

BusinessIdentityService

Serviço para oferecer 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 Information.

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.

GetEmailPreferences

rpc GetEmailPreferences(GetEmailPreferencesRequest) returns (EmailPreferences)

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.

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 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.

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)

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.

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, 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

rpc GetOnlineReturnPolicy(GetOnlineReturnPolicyRequest) returns (OnlineReturnPolicy)

Retorna uma política de devolução existente para um determinado comerciante.

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 de um determinado comerciante.

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 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

rpc DisableProgram(DisableProgramRequest) returns (Program)

Desative 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)

Ative 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 de regiões.

Essa 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 a definição de uma 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 de chamada de método por método da API Merchant.

GetShippingSettings

rpc GetShippingSettings(GetShippingSettingsRequest) returns (ShippingSettings)

Extrair informações das configurações 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)

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.

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 acordo 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 oferecer 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. 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.

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 para aceitar os TOS.

region_code

string

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_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 de MCA.

valid_until

Date

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

string

Identificador. O nome do 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 nome da loja e nome da empresa para mais informações.

adult_content

bool

Indica se a conta tem 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 display_time_zone. Se display_time_zone não existir na 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.

AccountAggregation

Esse tipo não tem campos.

Payload AccountAggregation.

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 desse problema 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.

reporting_context

ReportingContextEnum

O contexto de relatório afetado.

Impacto

O impacto do problema em uma região.

Campos
region_code

string

O código de região CLDR em que o problema se aplica.

severity

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_address

string

Parte do endereço referente à 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 de país CLDR (por exemplo, "US").

AutofeedSettings

Coleta de informações relacionadas às configurações de alimentação automática.

Campos
name

string

Identificador. O nome do recurso das configurações de alimentação automática. Formato: accounts/{account}/autofeedSettings.

enable_products

bool

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. A conta não pode ser um marketplace. Quando o feed automático é ativado pela primeira vez, os produtos geralmente aparecem instantaneamente. Quando você reativar, pode levar até 24 horas para que os produtos apareçam.

eligible

bool

Apenas saída. Determina se o comerciante está qualificado para participar de um feed automático.

BusinessDayConfig

Dias úteis do armazém.

Campos
business_days[]

Weekday

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

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 de propriedade de negros. Esse campo opcional só vai estar disponível para comerciantes com um 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 de propriedade de mulheres. Esse campo opcional só vai estar disponível para comerciantes com um 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 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 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 de propriedade de latinos. Esse campo opcional só vai estar disponível para comerciantes com um 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. Esse campo opcional só vai estar disponível para comerciantes com um país de negócios definido como US. Também não é aplicável a marketplaces.

IdentityAttribute

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

Campos
identity_declaration

IdentityDeclaration

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

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

string

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

address

PostalAddress

Opcional. O endereço da empresa. Somente os campos region_code, address_lines, postal_code, administrative_area e locality são aceitos. Todos os outros campos são ignorados.

phone

PhoneNumber

Apenas saída. O número de telefone da empresa.

phone_verification_state

PhoneVerificationState

Apenas saída. O estado da verificação de telefone da empresa.

customer_service

CustomerService

Opcional. O atendimento ao cliente da empresa.

korean_business_registration_number

string

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

string

Obrigatório. Nome da tarifa da operadora. Precisa ser exclusivo por grupo de tarifas.

carrier

string

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

carrier_service

string

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

origin_postal_code

string

Obrigatório. Origem do envio para essa tarifa da transportadora.

percentage_adjustment

string

Opcional. Modificador multiplicativo da taxa de frete como um número em notação decimal. Pode ser negativo. Por exemplo, "5.4" aumenta a taxa em 5,4%, e "-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 US $1 à taxa, e { "amount_micros": -3, "currency_code" : "USD" } remove US $3 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

overwrite

bool

Opcional. Quando definida como true, essa opção remove qualquer reivindicação existente no site solicitado e a substitui por uma reivindicação da conta que faz a solicitação.

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

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 account_aggregation, o que significa que você só pode criar subcontas, não contas independentes usando esse método. Outros serviços account_management ou product_management podem ser fornecidos.

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_aggregation

AccountAggregation

O provedor é um agregador da conta. Payload para o tipo de serviço "Agregação de contas".

provider

string

Obrigatório. 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 de 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 entrar em contato com o atendimento ao cliente.

CutoffTime

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

Campos
hour

int32

Obrigatório. Horário limite até o qual um pedido precisa ser feito para ser processado no mesmo dia.

minute

int32

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

time_zone

string

Obrigatório. Identificador de fuso horário. Por exemplo, "Europe/Zurich".

DeleteAccountRequest

Solicite mensagem para o método DeleteAccount.

Campos
name

string

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

force

bool

Opcional. Se definido como true, a conta será excluída mesmo que forneça serviços a outras contas ou tenha processado ofertas.

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, desde o 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 de trânsito em [tempo de entrega][[google.shopping.content.bundles.ShippingSetting.DeliveryTime] precisa ser definido.

min_transit_days

int32

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 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 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 min_transit_days.

cutoff_time

CutoffTime

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_handling_days

int32

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_handling_days

int32

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 min_handling_days. "min_handling_days" e "max_handling_days" precisam ser definidos ou não ao mesmo tempo.

transit_time_table

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.

handling_business_day_config

BusinessDayConfig

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_business_day_config

BusinessDayConfig

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

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 envio de entrega local.

Campos
value

int64

Valor inteiro da distância.

unit

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

string

Identificador. O nome das EmailPreferences. O endpoint só tem suporte para o 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.

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

string

Obrigatório. O nome do programa em que a participação da conta será ativada. 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}

GetAutofeedSettingsRequest

Solicite mensagem para o método GetAutofeedSettings.

Campos
name

string

Obrigatório. O nome do recurso das configurações de alimentação automática. Formato: accounts/{account}/autofeedSettings

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 comerciais. Formato: accounts/{account}/businessInfo

GetEmailPreferencesRequest

Solicita uma mensagem 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} O formato do identificador é: {TermsOfServiceKind}-{country}

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 recuperar 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 de uma tabela. Exatamente um entre prices, weights, num_items, postal_code_group_names ou location precisa ser definido.

Campos
prices[]

Price

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, [{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}] representa os cabeçalhos "<= $10", "<= $500" e "> $500". Todos os preços em um serviço precisam ter a mesma moeda. Precisa estar preenchido. Precisa ser positivo, exceto -1. Só pode ser definido se todos os outros campos não estiverem definidos.

weights[]

Weight

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, [{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}] representa os cabeçalhos "<= 10kg", "<= 50kg" e "> 50kg". Todos os pesos em um serviço precisam ter a mesma unidade. Precisa estar preenchido. Precisa ser positivo, exceto -1. Só pode ser definido se todos os outros campos não estiverem definidos.

number_of_items[]

string

Obrigatório. Uma lista de número de limites superiores de itens inclusivos. O último valor pode ser "infinity". Por exemplo, ["10", "50", "infinity"] representa os cabeçalhos "<= 10 itens", "<= 50 itens" e "> 50 itens". Precisa estar preenchido. Só pode 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 códigos postais indicados precisam corresponder ao país de entrega do serviço. Precisa estar preenchido. Só pode ser definido se todos os outros campos não estiverem definidos.

locations[]

LocationIdSet

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

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 esse 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, que é 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, no máximo 50 usuários serão retornados. O valor máximo é 100. Valores acima disso vão ser convertidos 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 por humanos no idioma especificado. O formato é BCP-47, como en-US ou sr-Latn. Se nenhum valor for fornecido, en-US será usado.

time_zone

string

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_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.

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, no máximo 250 contas serão retornadas. O valor máximo é 500. Valores acima disso são convertidos 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. 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[]

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 para listar as políticas de devolução. Formato: accounts/{account}

page_size

int32

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

page_token

string

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

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 todos os programas serão recuperados. 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), um tamanho padrão de 1.000 será usado. 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.

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, no máximo 250 contas serão retornadas. O valor máximo é 500. Valores acima disso são convertidos 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 é 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, no máximo 50 usuários serão retornados. O valor máximo é 100. Valores acima disso vão ser convertidos 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. Precisa estar preenchido. Só pode 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 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_code_set_with_movs[]

StoreCodeSetWithMov

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_codes[]

string

Opcional. Uma lista de códigos de loja exclusivos ou vazia para o catch-all.

value

Price

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

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

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[]

string

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

Policy

A política de devolução.

restocking_fee

RestockingFee

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_methods[]

ReturnMethod

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_conditions[]

ItemCondition

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_shipping_fee

ReturnShippingFee

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_policy_uri

string

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_defective_only

bool

Este campo especifica se o comerciante aceita apenas produtos com defeito para devoluções. Ele é obrigatório.

process_refund_days

int32

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

accept_exchange

bool

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

Type

Tipo de política.

days

int64

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 NUMBER_OF_DAYS_AFTER_DELIVERY.

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 type.

type pode ser apenas de um dos tipos a seguir:

fixed_fee

Price

Taxa de reposição de estoque fixa.

micro_percent

int32

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

Type

Obrigatório. Tipo de taxa de frete de devolução.

fixed_fee

Price

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

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

string

Identificador. O nome do 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 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 001 quando o programa se aplica globalmente.

unmet_requirements[]

Requirement

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

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 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 001 quando o programa se aplica globalmente.

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_shipping_labels[]

string

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[]

Table

Opcional. Uma lista de subtabelas referenciadas por main_table. Só pode ser definido se main_table estiver definido.

carrier_rates[]

CarrierRate

Opcional. Uma lista de tarifas da operadora que pode ser referenciada por main_table ou single_value.

single_value

Value

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

main_table

Table

Uma tabela que define o grupo de tarifas, quando single_value não é expressivo o suficiente. Só pode ser definido se single_value não estiver definido.

name

string

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

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 por área geográfica 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 por área geográfica que define a área da região.

Campos
geotarget_criteria_ids[]

int64

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_code

string

Obrigatório. Código de território CLDR ou o país em que o grupo de CEPs é aplicado.

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 do formulário prefixo* que indica o limite inferior incluído do intervalo que define a área. Exemplos de valores: 94108, 9410*, 9*.

end

string

Opcional. Um código postal ou um padrão do formato prefix* que denota o limite superior inclusivo do intervalo que define a área. Ele precisa ter o mesmo comprimento de postalCodeRangeBegin: se postalCodeRangeBegin for um código postal, postalCodeRangeEnd também precisa ser um código postal; se postalCodeRangeBegin for um padrão, postalCodeRangeEnd precisa ser um padrão com o mesmo comprimento de prefixo. Opcional: se não for definido, a área será definida como todos os códigos postais que correspondem 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. 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

string

Obrigatório. A conta para receber um formato TermsOfServiceAgreementState: accounts/{account}

RetrieveLatestTermsOfServiceRequest

Solicite mensagem para o método RetrieveLatestTermsOfService.

Campos
region_code

string

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

TermsOfServiceKind

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[]

Value

Obrigatório. A lista de células que constituem a linha. Precisa ter o mesmo comprimento de 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. 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.

loyalty_programs[]

LoyaltyProgram

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

service_name

string

Obrigatório. Nome do serviço em formato livre. 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 dos preços nos grupos de tarifas.

delivery_time

DeliveryTime

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

shipment_type

ShipmentType

Tipo de local para onde o serviço envia pedidos.

minimum_order_value

Price

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_order_value_table

MinimumOrderValueTable

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_config

StoreConfig

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_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 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_label

string

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_codes[]

string

Opcional. Uma lista de códigos de lojas que oferecem entrega local. Se estiver vazio, all_stores precisa ser verdadeiro.

store_service_type

StoreServiceType

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

cutoff_config

CutoffConfig

As configurações relacionadas à entrega local são encerradas para o dia.

service_radius

Distance

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_cutoff_time

LocalCutoffTime

Hora em que a entrega local termina no dia.

store_close_offset_hours

int64

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 local_cutoff_time.

no_delivery_post_cutoff

bool

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 true fará com que a taxa do 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 de um dia. Isso é válido apenas para entrega local.

LocalCutoffTime

Hora em que a entrega local termina no dia.

Campos
hour

int64

Os pedidos de entrega local em uma hora precisam ser feitos até esse horário para serem processados no mesmo dia.

minute

int64

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

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 depósitos que podem ser referenciados em services.

etag

string

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:

  1. O campo etag foi definido como uma string vazia para a criação inicial da configuração de frete.

  2. Após a criação inicial, chame o método "get" para receber um ETag e os dados de configuração de envio atuais antes de inserir a chamada.

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

  4. Chame o método de inserção com as informações de configuração de frete desejadas com a ETag obtida na etapa 2.

  5. Se os dados de configuração de frete mudaram entre a etapa 2 e a 4. A solicitação de inserção vai falhar porque o ETag muda sempre que os dados da configuração de frete mudam. O usuário precisa repetir as etapas de 2 a 4 com o novo etag.

Tabela

Uma tabela que define o grupo de tarifas, 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 de 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 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

string

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

region_code

string

Código regional, conforme definido pelo CLDR. É um país em que os TOS se aplicam especificamente a esse país ou 001 quando o mesmo TermsOfService pode ser assinado em qualquer país. No entanto, ao assinar um TOS que se aplica globalmente, ainda esperamos que um país específico seja fornecido (deve ser o país de participação do comerciante ou do programa).

kind

TermsOfServiceKind

O tipo a que esta versão dos 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 acordadas por processos externos, e não diretamente pelo comerciante por meio da interface ou da API.

file_uri

string

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

string

Identificador. O nome do recurso da versão dos Termos de Serviço. Formato: accounts/{account}/termsOfServiceAgreementState/{identifier} O formato do identificador é {TermsOfServiceKind}-{country}. Por exemplo, um identificador pode ser MERCHANT_CENTER-US.

region_code

string

Código regional, conforme definido em https://cldr.unicode.org/. País a que o estado atual se aplica.

terms_of_service_kind

TermsOfServiceKind

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

accepted

Accepted

Os termos de serviço aceitos desse tipo e para o region_code associado

required

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_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 códigos postais 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 corresponde a uma 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 corresponde a uma postal_code_group_names e as colunas (valores) a uma transit_time_labels.

Campos
values[]

TransitTimeValue

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_transit_days

int32

Período mínimo de trânsito em dias úteis. 0 significa entrega no mesmo dia e 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 a ser revertida. 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

Opcional. Lista de campos que estão sendo atualizados.

Os campos a seguir são aceitos (em snake_case e lowerCamelCase):

  • account_name
  • adult_content
  • language_code
  • time_zone

UpdateAutofeedSettingsRequest

Solicite mensagem para o método UpdateAutofeedSettings.

Campos
autofeed_settings

AutofeedSettings

Obrigatório. A nova versão da configuração de alimentação automática.

update_mask

FieldMask

Obrigatório. Lista de campos que estão sendo 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

Opcional. Lista de campos que estão sendo atualizados.

Os campos a seguir são aceitos (em snake_case e lowerCamelCase):

  • black_owned
  • latino_owned
  • promotions_consent
  • small_business
  • veteran_owned
  • women_owned

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

Opcional. Lista de campos que estão sendo atualizados.

Os campos a seguir são aceitos (em snake_case e lowerCamelCase):

  • address
  • customer_service
  • korean_business_registration_number

UpdateEmailPreferencesRequest

Solicita uma mensagem para o método UpdateEmailPreferences.

Campos
email_preferences

EmailPreferences

Obrigatório. As preferências de e-mail serão atualizadas.

update_mask

FieldMask

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

Os campos a seguir são aceitos (em snake_case e lowerCamelCase):

  • news_and_tips

UpdateHomepageRequest

Solicite mensagem para o método UpdateHomepage.

Campos
homepage

Homepage

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

update_mask

FieldMask

Opcional. Lista de campos que estão sendo atualizados.

Os campos a seguir são aceitos (em snake_case e lowerCamelCase):

  • uri

UpdateRegionRequest

Solicite mensagem para o método UpdateRegion.

Campos
region

Region

Obrigatório. A região atualizada.

update_mask

FieldMask

Opcional. A 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.

Use me para se referir ao seu próprio endereço de e-mail, por exemplo, accounts/{account}/users/me.

update_mask

FieldMask

Opcional. Lista de campos que estão sendo atualizados.

Os campos a seguir são aceitos (em snake_case e lowerCamelCase):

  • access_rights

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

string

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

Use me para se referir ao seu próprio endereço de e-mail, por exemplo, accounts/{account}/users/me.

state

State

Apenas saída. O estado do usuário.

access_rights[]

AccessRight

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_shipping

bool

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_rate

Price

Uma taxa fixa. Só pode 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ó pode ser definido se todos os outros campos não estiverem definidos.

carrier_rate

string

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

string

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

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. 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_days

int64

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_day_config

BusinessDayConfig

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

string

Obrigatório. Operadora, como "UPS" ou "Fedex". operadoras compatíveis

carrier_service

string

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

warehouse

string

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

int32

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

int32

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.