Package google.shopping.merchant.accounts.v1beta

Índice

AccountIssueService

Servicio compatible con la API de AccountIssueService.

ListAccountIssues

rpc ListAccountIssues(ListAccountIssuesRequest) returns (ListAccountIssuesResponse)

Muestra una lista de todos los problemas de una cuenta de Merchant Center.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

AccountTaxService

Administra los datos de la configuración de impuestos a nivel de la cuenta.

Esta API define el siguiente modelo de recursos:

  • AccountTax
GetAccountTax

rpc GetAccountTax(GetAccountTaxRequest) returns (AccountTax)

Devuelve las reglas fiscales que coinciden con las condiciones de GetAccountTaxRequest

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
ListAccountTax

rpc ListAccountTax(ListAccountTaxRequest) returns (ListAccountTaxResponse)

Indica la configuración fiscal de las cuentas secundarias solo en tu cuenta de Merchant Center. Este método solo se puede llamar en una cuenta de varios clientes; de lo contrario, mostrará un error.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
UpdateAccountTax

rpc UpdateAccountTax(UpdateAccountTaxRequest) returns (AccountTax)

Actualiza la configuración fiscal de la cuenta.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

AccountsService

Servicio compatible con la API de Accounts.

CreateAndConfigureAccount

rpc CreateAndConfigureAccount(CreateAndConfigureAccountRequest) returns (Account)

Crea una cuenta independiente de Merchant Center con configuración adicional. Agrega al usuario que realiza la solicitud como administrador de la cuenta nueva.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

Borra la cuenta especificada independientemente de su tipo: independiente, MCA o cuenta secundaria. Si borras una MCA, se borrarán todas sus cuentas secundarias. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Recupera una cuenta de Merchant Center. Después de insertar, actualizar o borrar una cuenta, es posible que los cambios tarden varios minutos en aplicarse.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Muestra una lista de las cuentas a las que puede acceder el usuario que emite la llamada y que coinciden con las restricciones de la solicitud, como el tamaño de la página o los filtros. Esto no es solo enumerar las cuentas secundarias de una MCA, sino que todas las cuentas a las que el usuario que realiza la llamada tiene acceso, incluidas otras MCA, cuentas vinculadas, cuentas independientes, etcétera.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
ListSubAccounts

rpc ListSubAccounts(ListSubAccountsRequest) returns (ListSubAccountsResponse)

Obtén una lista de todas las cuentas secundarias de una cuenta de varios clientes determinada. Es un wrapper práctico para el método ListAccounts, que es más potente. Este método producirá los mismos resultados que llamar a ListsAccounts con el siguiente filtro: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Actualiza una cuenta independientemente de su tipo: independiente, MCA o cuenta secundaria. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

BusinessIdentityService

Servicio compatible con la API de Business Identity

GetBusinessIdentity

rpc GetBusinessIdentity(GetBusinessIdentityRequest) returns (BusinessIdentity)

Recupera la identidad de empresa de una cuenta.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
UpdateBusinessIdentity

rpc UpdateBusinessIdentity(UpdateBusinessIdentityRequest) returns (BusinessIdentity)

Actualiza la identidad de la empresa de una cuenta. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

BusinessInfoService

Servicio compatible con la API de Business Info.

GetBusinessInfo

rpc GetBusinessInfo(GetBusinessInfoRequest) returns (BusinessInfo)

Recupera la información de la empresa de una cuenta.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
UpdateBusinessInfo

rpc UpdateBusinessInfo(UpdateBusinessInfoRequest) returns (BusinessInfo)

Actualiza la información de la empresa de una cuenta. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

EmailPreferencesService

Servicio compatible con la API de EmailPreferences.

Este servicio solo permite recuperar y actualizar las preferencias de correo electrónico del usuario autenticado.

GetEmailPreferences

rpc GetEmailPreferences(GetEmailPreferencesRequest) returns (EmailPreferences)

Muestra las preferencias de correo electrónico de un usuario de la cuenta de Merchant Center.

Usa el alias name=accounts/*/users/me/emailPreferences para obtener las preferencias del usuario autenticado.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
UpdateEmailPreferences

rpc UpdateEmailPreferences(UpdateEmailPreferencesRequest) returns (EmailPreferences)

Actualiza las preferencias de correo electrónico de un usuario de la cuenta de Merchant Center. Los usuarios de la MCA deben especificar la cuenta de la MCA en lugar de una cuenta secundaria.

No se actualizarán las preferencias que no se seleccionen explícitamente en la máscara de actualización.

No es válido para que las actualizaciones especifiquen un valor de estado de habilitación NO CONFIRMADO.

Usa el alias name=accounts/*/users/me/emailPreferences para actualizar las preferencias del usuario autenticado.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

HomepageService

Servicio compatible con una API para la página principal de una tienda.

ClaimHomepage

rpc ClaimHomepage(ClaimHomepageRequest) returns (Homepage)

Reclama la página principal de una tienda. Ejecutar este método requiere acceso de administrador.

Si ya se reclamó la página principal, se volverá a verificar la verificación (a menos que el comercio esté exento de reclamos, lo cual también exime a este tipo de verificación) y se devolverá una respuesta exitosa. Si ya no se puede verificar la propiedad, se mostrará un error, pero no se borrará el reclamo. En caso de que se produzca un error, se mostrará un mensaje de error canónico: * PERMISSION_DENIED: el usuario no tiene los permisos necesarios en esta cuenta de MC; * FAILED_PRECONDITION: - La cuenta no es de Merchant Center; - La cuenta de MC no tiene una página principal; - el reclamo falló (en este caso, el mensaje de error contendrá más detalles).

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
GetHomepage

rpc GetHomepage(GetHomepageRequest) returns (Homepage)

Recupera la página principal de una tienda.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
UnclaimHomepage

rpc UnclaimHomepage(UnclaimHomepageRequest) returns (Homepage)

Anula el reclamo de la página principal de una tienda. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
UpdateHomepage

rpc UpdateHomepage(UpdateHomepageRequest) returns (Homepage)

Actualiza la página principal de una tienda. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

OnlineReturnPolicyService

El servicio facilita la administración de la configuración de la política de devoluciones por arrepentimiento del comercio, lo que incluye las políticas de devoluciones de los anuncios y las fichas gratuitas.

programas. Esta API define el siguiente modelo de recursos:

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

GetOnlineReturnPolicy

rpc GetOnlineReturnPolicy(GetOnlineReturnPolicyRequest) returns (OnlineReturnPolicy)

Obtiene una política de devoluciones existente.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
ListOnlineReturnPolicies

rpc ListOnlineReturnPolicies(ListOnlineReturnPoliciesRequest) returns (ListOnlineReturnPoliciesResponse)

Enumera todas las políticas de devoluciones existentes.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

ProgramsService

Servicio de gestión de programas.

Los programas ofrecen un mecanismo para agregar funciones a las cuentas de comerciante. Un ejemplo típico de esto es el programa Fichas de producto gratuitas, que permite que los productos de la tienda de un comercio se muestren en Google de forma gratuita.

Este servicio ofrece métodos para recuperar la participación de un comerciante en todos los programas disponibles, además de métodos para habilitar o inhabilitar explícitamente la participación en cada programa.

DisableProgram

rpc DisableProgram(DisableProgramRequest) returns (Program)

Inhabilitar la participación en el programa especificado para la cuenta. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
EnableProgram

rpc EnableProgram(EnableProgramRequest) returns (Program)

Habilitar la participación en el programa especificado para la cuenta. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
GetProgram

rpc GetProgram(GetProgramRequest) returns (Program)

Recupera el programa especificado para la cuenta.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
ListPrograms

rpc ListPrograms(ListProgramsRequest) returns (ListProgramsResponse)

Recupera todos los programas de la cuenta.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

RegionsService

Administra la configuración de las regiones.

Esta API define el siguiente modelo de recursos:

  • Region
CreateRegion

rpc CreateRegion(CreateRegionRequest) returns (Region)

Crea una definición de región en tu cuenta de Merchant Center. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
DeleteRegion

rpc DeleteRegion(DeleteRegionRequest) returns (Empty)

Borra una definición de región de tu cuenta de Merchant Center. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
GetRegion

rpc GetRegion(GetRegionRequest) returns (Region)

Recupera una región definida en su cuenta de Merchant Center.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
ListRegions

rpc ListRegions(ListRegionsRequest) returns (ListRegionsResponse)

Muestra una lista de las regiones en tu cuenta de Merchant Center.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
UpdateRegion

rpc UpdateRegion(UpdateRegionRequest) returns (Region)

Actualiza una definición de región en tu cuenta de Merchant Center. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

ShippingSettingsService

Servicio para obtener información de la configuración de envío de llamadas de método por método de la API de Merchant Center.

GetShippingSettings

rpc GetShippingSettings(GetShippingSettingsRequest) returns (ShippingSettings)

Recupera la información de configuración de envío.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
InsertShippingSettings

rpc InsertShippingSettings(InsertShippingSettingsRequest) returns (ShippingSettings)

Reemplaza la configuración de envío de un comercio con la configuración de envío de la solicitud. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

TermsOfServiceAgreementStateService

Servicio compatible con la API de TermsOfServiceAgreementState.

GetTermsOfServiceAgreementState

rpc GetTermsOfServiceAgreementState(GetTermsOfServiceAgreementStateRequest) returns (TermsOfServiceAgreementState)

Muestra el estado del acuerdo de las Condiciones del Servicio.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
RetrieveForApplicationTermsOfServiceAgreementState

rpc RetrieveForApplicationTermsOfServiceAgreementState(RetrieveForApplicationTermsOfServiceAgreementStateRequest) returns (TermsOfServiceAgreementState)

Recupera el estado del acuerdo de las condiciones del servicio de la aplicación.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

TermsOfServiceService

Servicio compatible con la API de TermsOfService.

AcceptTermsOfService

rpc AcceptTermsOfService(AcceptTermsOfServiceRequest) returns (Empty)

Acepta un TermsOfService. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
GetTermsOfService

rpc GetTermsOfService(GetTermsOfServiceRequest) returns (TermsOfService)

Recupera el TermsOfService asociado con la versión proporcionada.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
RetrieveLatestTermsOfService

rpc RetrieveLatestTermsOfService(RetrieveLatestTermsOfServiceRequest) returns (TermsOfService)

Recupera la versión más reciente del TermsOfService de un kind y un region_code determinados.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

UserService

Servicio compatible con la API de usuario.

CreateUser

rpc CreateUser(CreateUserRequest) returns (User)

Crea un usuario de cuenta de Merchant Center. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
DeleteUser

rpc DeleteUser(DeleteUserRequest) returns (Empty)

Borra un usuario de la cuenta de Merchant Center. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
GetUser

rpc GetUser(GetUserRequest) returns (User)

Recupera un usuario de cuenta de Merchant Center.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
ListUsers

rpc ListUsers(ListUsersRequest) returns (ListUsersResponse)

Muestra una lista de todos los usuarios de una cuenta de Merchant Center.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
UpdateUser

rpc UpdateUser(UpdateUserRequest) returns (User)

Actualiza a un usuario de la cuenta de Merchant Center. Ejecutar este método requiere acceso de administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

AcceptTermsOfServiceRequest

Mensaje de la solicitud para el método AcceptTermsOfService.

Campos
name

string

Obligatorio. El nombre del recurso de la versión de las Condiciones del Servicio. Formato: termsOfService/{version}
account

string

Obligatorio. Es la cuenta en la que se deben aceptar las Condiciones del Servicio.
region_code

string

Obligatorio. Código regional como lo define CLDR. Esto puede ser un país en el que las Condiciones del Servicio se aplican específicamente a ese país o el 001, cuando se aplican a nivel mundial.

Aceptado

Describe las Condiciones del Servicio aceptadas.

Campos
terms_of_service

string

Las termsOfService aceptadas.
accepted_by

string

La cuenta donde se registró la aceptación. Puede ser la propia cuenta o, en el caso de las cuentas secundarias, la cuenta de la MCA.
valid_until

Date

Cuando se establece, indica que las TermsOfService aceptadas solo son válidas hasta el final de esta fecha (en UTC). Debes aceptar uno nuevo antes de esa fecha. La información de las TermsOfService obligatorias se encuentra en el mensaje Obligatorio.

AccessRight

El derecho de acceso.

Enumeradores
ACCESS_RIGHT_UNSPECIFIED Valor predeterminado Este valor no se usa.
STANDARD Derechos de acceso estándar.
ADMIN Derechos de acceso de administrador
PERFORMANCE_REPORTING Los usuarios que tienen este derecho tienen acceso al rendimiento y las estadísticas.

Cuenta

Una cuenta

Campos
name

string

Identificador. El nombre del recurso de la cuenta. Formato: accounts/{account}
account_id

int64

Solo salida. Es el ID de la cuenta.
account_name

string

Obligatorio. Es un nombre de la cuenta legible por humanos. Consulta el nombre de la tienda y el nombre de la empresa para obtener más información.
adult_content

bool

Si esta cuenta incluye contenido para adultos
test_account

bool

Solo salida. Si se trata de una cuenta de prueba
time_zone

TimeZone

Obligatorio. Es la zona horaria de la cuenta.

En las operaciones de escritura, time_zone establece reporting_time_zone y display_time_zone.

Para las lecturas, time_zone siempre muestra display_time_zone. Si display_time_zone no existe para tu cuenta, el campo time_zone estará vacío.
language_code

string

Obligatorio. El código de idioma BCP-47 de la cuenta, como en-US o sr-Latn.

AccountIssue

Un objeto AccountIssue

Campos
name

string

Identificador. El nombre del recurso del problema de la cuenta. Formato: accounts/{account}/issues/{id}
title

string

Es el título localizado del problema.
severity

Severity

La gravedad general del problema.
impacted_destinations[]

ImpactedDestination

El impacto que este problema tiene en varios destinos.
detail

string

Detalles localizados adicionales sobre el problema
documentation_uri

string

Vínculo al Centro de ayuda de Merchant Center para proporcionar más información sobre el problema y cómo solucionarlo.

ImpactedDestination

Indica el impacto del problema en un destino.

Campos
impacts[]

Impact

El impacto (negativo) de varias regiones en el destino determinado.
reporting_context

ReportingContextEnum

El contexto de los informes afectados.

Impacto

El impacto del problema en una región.

Campos
region_code

string

Es el código regional de CLDR donde se aplica este problema.
severity

Severity

Indica la gravedad del problema en el destino y la región.

Gravedad

Toda la gravedad posible del problema.

Enumeradores
SEVERITY_UNSPECIFIED La gravedad es desconocida.
CRITICAL El problema hace que las ofertas no se publiquen.
ERROR Es posible que el problema afecte a las ofertas (en el futuro) o sea un indicador de problemas con ellas.
SUGGESTION El problema es una sugerencia de mejora.

AccountTax

Es la configuración de impuestos de una cuenta de comerciante. Todos los métodos requieren el rol de administrador.

Campos
name

string

Identificador. Es el nombre de la configuración de impuestos. Formato: “{account_tax.name=accounts/{account}}"
account

int64

Solo salida. Es el ID de la cuenta a la que pertenece esta configuración de impuestos de la cuenta.
tax_rules[]

TaxRule

Reglas fiscales "Define las reglas fiscales en cada región. Si una región no tiene ninguna regla, no se presentarán impuestos”.

Dirección

Dirección de envío del almacén.

Campos
street_address

string

Parte de la dirección a nivel de la calle Por ejemplo: 111w 31st Street.
city

string

Obligatorio. Ciudad, pueblo o comuna. También puede incluir localidades o sublocalidades dependientes (por ejemplo, vecindarios o suburbios).
administrative_area

string

Obligatorio. Subdivisión administrativa de nivel superior del país. Por ejemplo, puede ser un estado como California ("CA") o una provincia como Quebec ("QC").
postal_code

string

Obligatorio. Es el código postal (por ejemplo, “94043”).
region_code

string

Obligatorio. Código de país de CLDR (por ejemplo, “US”).

BusinessDayConfig

Días hábiles del depósito

Campos
business_days[]

Weekday

Obligatorio. Días hábiles normales. No puede estar vacío.

Día de la semana

Enumeradores
WEEKDAY_UNSPECIFIED
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY

BusinessIdentity

Recopilación de información relacionada con la identidad de una empresa.

Campos
name

string

Identificador. El nombre del recurso de la identidad de la empresa. Formato: accounts/{account}/businessIdentity
black_owned

IdentityAttribute

Opcional. Especifica si la empresa se identifica como de negros. Este campo opcional solo estará disponible para los comercios cuyo país de la empresa se haya establecido en US. Tampoco se aplica a los mercados ni a los vendedores de estos.
women_owned

IdentityAttribute

Opcional. Especifica si la empresa se identifica como una empresa de mujeres. Este campo opcional solo estará disponible para los comercios cuyo país de la empresa se haya establecido en US. Tampoco se aplica a los mercados ni a los vendedores de estos.
veteran_owned

IdentityAttribute

Opcional. Especifica si la empresa se identifica como empresa propiedad de los veteranos. Este campo opcional solo estará disponible para los comercios cuyo país de la empresa se haya establecido en US. Tampoco se aplica a los mercados ni a los vendedores de estos.
latino_owned

IdentityAttribute

Opcional. Especifica si la empresa se identifica como propietaria de una comunidad latina. Este campo opcional solo estará disponible para los comercios cuyo país de la empresa se haya establecido en US. Tampoco se aplica a los mercados ni a los vendedores de estos.
small_business

IdentityAttribute

Opcional. Especifica si la empresa se identifica como pequeña. Este campo opcional solo estará disponible para los comercios cuyo país de la empresa se haya establecido en US. Tampoco se aplica a los mercados.

IdentityAttribute

Toda la información relacionada con un atributo de identidad.

Campos
identity_declaration

IdentityDeclaration

Obligatorio. La declaración de identidad de este atributo.

IdentityDeclaration

Todos los parámetros de configuración posibles relacionados con la declaración de una identidad.

Enumeradores
IDENTITY_DECLARATION_UNSPECIFIED Valor predeterminado que indica que no se realizó ninguna selección.
SELF_IDENTIFIES_AS Indica que la cuenta se identifica con el atributo.
DOES_NOT_SELF_IDENTIFY_AS Indica que la cuenta no se identifica con el atributo.

PromotionsConsent

Todos los parámetros de configuración posibles relacionados con las promociones relacionadas con la identidad de la empresa.

Enumeradores

BusinessInfo

Recopilación de información relacionada con una empresa.

Campos
name

string

Identificador. El nombre del recurso de la información de la empresa. Formato: accounts/{account}/businessInfo
address

PostalAddress

Opcional. Es la dirección de la empresa.
phone

PhoneNumber

Opcional. Es el número de teléfono de la empresa.
phone_verification_state

PhoneVerificationState

Solo salida. Es el estado de la verificación telefónica de la empresa.
customer_service

CustomerService

Opcional. Es la atención al cliente de la empresa.

CarrierRate

Una lista de tarifas de empresas de transporte a las que se puede hacer referencia mediante main_table o single_value.

Campos
name

string

Obligatorio. Indica el nombre de la tarifa de la empresa de transporte. Debe ser único por grupo de tarifas.
carrier

string

Obligatorio. Servicio del operador, como "UPS" o "Fedex"
carrier_service

string

Obligatorio. Servicio del operador, como "ground" o "2 days"
origin_postal_code

string

Obligatorio. Origen de envío para esta tarifa de empresa de transporte.
percentage_adjustment

string

Opcional. Modificador de tarifa de envío multiplicativa como un número en notación decimal. Puede ser negativo. Por ejemplo, "5.4" aumenta la tasa en un 5.4%, "-3" disminuye la tasa en un 3%.
flat_adjustment

Price

Opcional. Modificador aditivo de tarifa de envío. Puede ser negativo. Por ejemplo, { "amount_micros": 1, "currency_code" : "USD" } agrega USD 1 a la tarifa y { "amount_micros": -3, "currency_code" : "USD" } quita USD 3 de la tarifa.

ClaimHomepageRequest

Mensaje de la solicitud para el método ClaimHomepage.

Campos
name

string

Obligatorio. El nombre de la página principal que se reclamará. Formato: accounts/{account}/homepage

CreateAndConfigureAccountRequest

Mensaje de la solicitud para el método CreateAndConfigureAccount.

Campos
account

Account

Obligatorio. La cuenta que se creará.
users[]

CreateUserRequest

Opcional. Usuarios que se agregarán a la cuenta.
service[]

AddAccountService

Opcional. Si se especifica, se inicializará un servicio de cuenta entre la cuenta que se creará y la cuenta de proveedor como parte de la creación.
accept_terms_of_service

AcceptTermsOfService

Opcional. Las Condiciones del Servicio se deben aceptar inmediatamente después de crear la cuenta.

AcceptTermsOfService

Referencia a un recurso de las Condiciones del Servicio.

Campos
name

string

Obligatorio. El nombre del recurso de la versión de las Condiciones del Servicio.
region_code

string

Obligatorio. Código regional como lo define CLDR. Esto puede ser un país en el que las Condiciones del Servicio se aplican específicamente a ese país o 001 cuando se aplican a nivel mundial.

AddAccountService

Instrucciones adicionales para agregar servicios de la cuenta durante su creación.

Campos
Campo de unión service_type. Actualmente, solo se admite el tipo de cuenta principal de varios clientes. service_type puede ser solo uno de los siguientes:
account_aggregation

Empty

El proveedor es un agregador de la cuenta.
provider

string

Opcional. Es el proveedor del servicio. Formato: accounts/{account}

CreateRegionRequest

Mensaje de la solicitud para el método CreateRegion.

Campos
parent

string

Obligatorio. La cuenta para la que se crea una región. Formato: accounts/{account}
region_id

string

Obligatorio. El identificador de la región, único para todas las regiones de la misma cuenta.
region

Region

Obligatorio. La región que se creará.

CreateUserRequest

Mensaje de la solicitud para el método CreateUser.

Campos
parent

string

Obligatorio. El nombre del recurso de la cuenta para la que se creará un usuario. Formato: accounts/{account}
user_id

string

Obligatorio. Es la dirección de correo electrónico del usuario (por ejemplo, john.doe@gmail.com).
user

User

Obligatorio. El usuario que se creará.

CustomerService

Información de atención al cliente.

Campos
uri

string

Opcional. El URI en el que se puede encontrar el servicio de atención al cliente.
email

string

Opcional. Es la dirección de correo electrónico a la que se puede contactar con el servicio de atención al cliente.
phone

PhoneNumber

Opcional. El número de teléfono al que se puede llamar el servicio de atención al cliente.

CutoffTime

Definición de la hora límite de los días hábiles.

Campos
hour

int32

Obligatorio. Es la hora límite hasta la que se debe realizar un pedido para que se procese el mismo día.
minute

int32

Obligatorio. Minuto del horario límite hasta el que se debe realizar un pedido para que se procese el mismo día.
time_zone

string

Obligatorio. Identificador de la zona horaria Por ejemplo, "Europa/Zúrich".

DeleteAccountRequest

Mensaje de la solicitud para el método DeleteAccount.

Campos
name

string

Obligatorio. El nombre de la cuenta que se borrará. Formato: accounts/{account}

DeleteRegionRequest

Mensaje de la solicitud para el método DeleteRegion.

Campos
name

string

Obligatorio. Es el nombre de la región que se borrará. Formato: accounts/{account}/regions/{region}

DeleteUserRequest

Mensaje de la solicitud para el método DeleteUser.

Campos
name

string

Obligatorio. El nombre del usuario que se borrará. Formato: accounts/{account}/users/{email}

También es posible borrar el usuario correspondiente al emisor si usas me en lugar de una dirección de correo electrónico, como en accounts/{account}/users/me.

DeliveryTime

Es el tiempo dedicado a varios aspectos, desde el pedido hasta la entrega del producto.

Campos
warehouse_based_delivery_times[]

WarehouseBasedDeliveryTime

Opcional. Indica que el tiempo de entrega se debe calcular por almacén (ubicación de origen del envío) según la configuración de la empresa de transporte seleccionada. Cuando se configura, no se debe establecer ningún otro campo relacionado con el tiempo en tránsito en [tiempo de entrega][[google.shopping.content.bundles.ShippingSetting.DeliveryTime].
min_transit_days

int32

Es la cantidad mínima de días hábiles en tránsito. 0 significa entrega el mismo día, 1 significa entrega al día siguiente. Se debe configurar min_transit_days, max_transit_days o transit_time_table, pero no ambos.
max_transit_days

int32

Es la cantidad máxima de días hábiles que se pasan en tránsito. 0 significa entrega el mismo día, 1 significa entrega al día siguiente. Debe ser mayor o igual que min_transit_days.
cutoff_time

CutoffTime

Definición de la hora límite de los días hábiles. Si no se configura, se establecerá la hora límite de forma predeterminada a las 8 a.m. PST.
min_handling_days

int32

Indica la cantidad mínima de días hábiles invertidos antes de que se envíe un pedido. 0 significa envío el mismo día, 1 significa envío al día siguiente.
max_handling_days

int32

Es la cantidad máxima de días hábiles invertidos antes de que se envíe un pedido. 0 significa envío el mismo día, 1 significa envío al día siguiente. Debe ser mayor o igual que min_handling_days.
transit_time_table

TransitTable

Tabla de tiempo en tránsito, que corresponde a la cantidad de días hábiles que se pasaron en tránsito según las dimensiones de filas y columnas. Se puede configurar min_transit_days, max_transit_days o transit_time_table, pero no ambos.
handling_business_day_config

BusinessDayConfig

Los días hábiles durante los cuales se pueden procesar los pedidos. Si no se proporciona, se asumirán los días hábiles de lunes a viernes.
transit_business_day_config

BusinessDayConfig

Los días hábiles durante los cuales los pedidos pueden estar en tránsito. Si no se proporciona, se asumirán los días hábiles de lunes a viernes.

DisableProgramRequest

Mensaje de solicitud para el métodoDisableProgram.

Campos
name

string

Obligatorio. Es el nombre del programa para el que se inhabilita la participación para la cuenta determinada. Formato: accounts/{account}/programs/{program}

Distancia

Radio de entrega máximo. Esto solo es obligatorio para el tipo de envío con entrega local.

Campos
value

int64

Valor entero de la distancia.
unit

Unit

La unidad puede variar según el país, se parametriza para incluir millas y kilómetros.

Unidad

La unidad puede variar según el país, se parametriza para incluir millas y kilómetros.

Enumeradores
UNIT_UNSPECIFIED Unidad sin especificar
MILES Unidad en millas
KILOMETERS Unidad en kilómetros

EmailPreferences

Son las categorías de notificaciones que el usuario habilitó o inhabilitó. Las preferencias de correo electrónico no incluyen anuncios obligatorios, ya que los usuarios no pueden inhabilitarlos.

Campos
name

string

Identificador. Es el nombre de EmailPreferences. El extremo solo es compatible con el usuario autenticado.
news_and_tips

OptInState

Opcional. Actualizaciones sobre funciones nuevas, sugerencias y prácticas recomendadas.

OptInState

Habilita el estado de la preferencia de correo electrónico.

Enumeradores
OPT_IN_STATE_UNSPECIFIED No se especificó el estado de la habilitación.
OPTED_OUT El usuario rechazó la recepción de este tipo de correos electrónicos.
OPTED_IN El usuario aceptó recibir este tipo de correo electrónico.
UNCONFIRMED El usuario aceptó recibir este tipo de correo electrónico y el correo electrónico de confirmación se envió, pero aún no ha confirmado la aceptación (solo se aplica a determinados países).

EnableProgramRequest

Mensaje de solicitud para el método EnableProgram.

Campos
name

string

Obligatorio. Es el nombre del programa para el que se habilita la participación para la cuenta determinada. Formato: accounts/{account}/programs/{program}

GetAccountRequest

Mensaje de la solicitud para el método GetAccount.

Campos
name

string

Obligatorio. El nombre de la cuenta que se recuperará. Formato: accounts/{account}

GetAccountTaxRequest

Solicita la configuración de impuestos

Campos
name

string

Obligatorio. El nombre a partir del cual se recuperará la configuración de impuestos

GetBusinessIdentityRequest

Mensaje de la solicitud para el método GetBusinessIdentity.

Campos
name

string

Obligatorio. El nombre del recurso de la identidad de la empresa. Formato: accounts/{account}/businessIdentity

GetBusinessInfoRequest

Mensaje de la solicitud para el método GetBusinessInfo.

Campos
name

string

Obligatorio. El nombre del recurso de la información de la empresa. Formato: accounts/{account}/businessInfo

GetEmailPreferencesRequest

Mensaje de solicitud para el método GetEmailPreferences.

Campos
name

string

Obligatorio. EmailPreferences: el nombre del recurso. Formato: accounts/{account}/users/{email}/emailPreferences

GetHomepageRequest

Mensaje de la solicitud para el método GetHomepage.

Campos
name

string

Obligatorio. El nombre de la página de inicio que se recuperará. Formato: accounts/{account}/homepage

GetOnlineReturnPolicyRequest

Mensaje de la solicitud para el método GetOnlineReturnPolicy.

Campos
name

string

Obligatorio. El nombre de la política de devoluciones que se recuperará. Formato: accounts/{account}/onlineReturnPolicies/{return_policy}

GetProgramRequest

Mensaje de solicitud para el método GetProgram.

Campos
name

string

Obligatorio. Es el nombre del programa que se recuperará. Formato: accounts/{account}/programs/{program}

GetRegionRequest

Mensaje de la solicitud para el método GetRegion.

Campos
name

string

Obligatorio. El nombre de la región que se recuperará. Formato: accounts/{account}/regions/{region}

GetShippingSettingsRequest

Mensaje de la solicitud para el método GetShippingSetting.

Campos
name

string

Obligatorio. Es el nombre de la configuración de envío que se recuperará. Formato: accounts/{account}/shippingsetting

GetTermsOfServiceAgreementStateRequest

Mensaje de la solicitud para el método GetTermsOfServiceAgreementState.

Campos
name

string

Obligatorio. El nombre del recurso de la versión de las Condiciones del Servicio. Formato: accounts/{account}/termsOfServiceAgreementState/{identifier}

GetTermsOfServiceRequest

Mensaje de la solicitud para el método GetTermsOfService.

Campos
name

string

Obligatorio. El nombre del recurso de la versión de las Condiciones del Servicio. Formato: termsOfService/{version}

GetUserRequest

Mensaje de la solicitud para el método GetUser.

Campos
name

string

Obligatorio. El nombre del usuario que se recuperará. Formato: accounts/{account}/users/{email}

También es posible recuperar el usuario correspondiente al emisor si se usa me en lugar de una dirección de correo electrónico, como en accounts/{account}/users/me.

Encabezados

Una lista no vacía de encabezados de filas o columnas de una tabla. Se debe establecer exactamente uno de los siguientes valores: prices, weights, num_items, postal_code_group_names o location.

Campos
prices[]

Price

Obligatorio. Una lista de los límites superiores del precio del pedido inclusivo. Si estableces price amount_micros = -1, el valor del último precio puede ser infinito. Por ejemplo, [{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}] representa los encabezados "<= $10", "<= $500" y "> $500. Todos los precios de un servicio deben tener la misma moneda. No puede estar vacío. Debe ser positivo, excepto -1. Solo se puede establecer si no están configurados todos los demás campos.
weights[]

Weight

Obligatorio. Una lista de los límites superiores del peso de orden inclusivo. El valor del último peso puede ser infinito si estableces price amount_micros = -1. Por ejemplo, [{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}] representa los encabezados “<= 10 kg”, “<= 50 kg” y “50 kg”. Todas las ponderaciones de un servicio deben tener la misma unidad. No puede estar vacío. Debe ser positivo, excepto -1. Solo se puede establecer si no están configurados todos los demás campos.
number_of_items[]

string

Obligatorio. Una lista de los límites superiores de la cantidad inclusiva de elementos. El último valor puede ser "infinity". Por ejemplo, ["10", "50", "infinity"] representa los encabezados "<= 10 elementos", "<= 50 elementos" y "> 50 elementos. No puede estar vacío. Solo se puede establecer si no están configurados todos los demás campos.
postal_code_group_names[]

string

Obligatorio. Es una lista de nombres de grupos postales. El último valor puede ser "all other locations". Ejemplo: ["zone 1", "zone 2", "all other locations"]. Los grupos de códigos postales a los que se hace referencia deben coincidir con el país de entrega del servicio. No puede estar vacío. Solo se puede establecer si no están configurados todos los demás campos.
locations[]

LocationIdSet

Obligatorio. Es una lista de conjuntos de ID de ubicación. No puede estar vacío. Solo se puede establecer si no están configurados todos los demás campos.

Página principal

Es la página principal de una tienda.

Campos
name

string

Identificador. Es el nombre del recurso de la página principal de la tienda. Formato: accounts/{account}/homepage
claimed

bool

Solo salida. Si se reclama la página principal. Consulte https://support.google.com/merchants/answer/176793.
uri

string

Obligatorio. Es el URI (por lo general, una URL) de la página principal de la tienda.

InsertShippingSettingsRequest

Mensaje de la solicitud para el método InsertShippingSetting.

Campos
parent

string

Obligatorio. La cuenta en la que se insertará este producto. Formato: cuentas/{account}
shipping_setting

ShippingSettings

Obligatorio. La nueva versión de la cuenta.

ListAccountIssuesRequest

Mensaje de la solicitud para el método ListAccountIssues.

Campos
parent

string

Obligatorio. La entidad superior, propietaria de esta colección de ediciones. Formato: accounts/{account}
page_size

int32

Opcional. La cantidad máxima de ediciones que se mostrarán. El servicio puede mostrar menos que este valor. Si no se especifica, se mostrarán 50 usuarios como máximo. El valor máximo es 100; los valores superiores a 100 se convertirán en 100
page_token

string

Opcional. Un token de página, recibido desde una llamada ListAccountIssues anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListAccountIssues deben coincidir con la llamada que proporcionó el token de la página.
language_code

string

Opcional. Los problemas de la respuesta tendrán campos legibles por humanos en el idioma determinado. El formato es BCP-47, como en-US o sr-Latn. Si no se proporciona un valor, se usará en-US.
time_zone

TimeZone

Opcional. La zona horaria IANA que se usa para localizar horas en campos legibles por humanos. Por ejemplo, “America/Los_Angeles”. Si no la estableces, se usará “America/Los_Angeles”.

ListAccountIssuesResponse

Mensaje de respuesta para el método ListAccountIssues.

Campos
account_issues[]

AccountIssue

Son los problemas de la cuenta especificada.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListAccountTaxRequest

Solicitud para enumerar toda la configuración de impuestos de las cuentas secundarias solo para el comercio que realiza la solicitud. Este método solo se puede llamar en una cuenta de varios clientes. De lo contrario, se mostrará un error.

Campos
parent

string

Obligatorio. El publicador superior, propietario de esta colección de impuestos de la cuenta. Formato: cuentas/{account}
page_size

int32

La cantidad máxima de configuraciones de impuestos que se mostrarán en la respuesta, que se usa para la paginación.
page_token

string

El token que muestra la solicitud anterior.

ListAccountTaxResponse

Respuesta a la solicitud de lista de impuestos de la cuenta. Este método solo se puede invocar en una cuenta de varios clientes. De lo contrario, se mostrará un error.

Campos
account_taxes[]

AccountTax

Página de la configuración de impuestos de la cuenta
next_page_token

string

El token para recuperar la página siguiente de la configuración de impuestos de la cuenta.

ListAccountsRequest

Mensaje de la solicitud para el método ListAccounts.

Campos
page_size

int32

Opcional. La cantidad máxima de cuentas que se mostrarán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán 250 cuentas como máximo. El valor máximo es 500; los valores superiores a 500 se convertirán en 500.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListAccounts anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListAccounts deben coincidir con la llamada que proporcionó el token de la página.
filter

string

Opcional. Es un filtro opcional para mostrar solo las cuentas que coinciden con el filtro.

Estos son algunos ejemplos de filtros válidos:

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

Los filtros a nivel de la cuenta tienen la siguiente semántica:

  • accountName Hace referencia al campo accountName de la cuenta.
  • relationship(...) Se refiere a una relación que la cuenta tiene con otra cuenta. Dentro de la función, esta relación se puede especificar con mayor detalle.

Los filtros en el nivel de relación tienen la siguiente semántica:

  • providerId: Se refiere al ID numérico de la cuenta que es el otro miembro de la relación. Por ejemplo, si el filtro debe limitarse a las cuentas que tienen una relación con la cuenta accounts/name/123, providerId se debe filtrar como providerId = 123.
  • callerHasAccessToProvider() Esto restringirá las cuentas resultantes a aquellas que tengan una relación con otra cuenta en la que el usuario que realiza la llamada también tenga acceso al otro miembro de la relación (o al proveedor).
  • externalAccountId: Se refiere al ID de la cuenta externo que se configuró para la relación.
  • accountIdAlias: Hace referencia al alias del ID de la cuenta que se configuró para la relación.
  • service(...) Se refiere a un servicio que se proporciona como parte de la relación. Nota: Una relación entre dos cuentas puede incluir varios servicios.

Los filtros en el nivel de servicio tienen la siguiente semántica:

  • handshakeState: Hace referencia al estado del protocolo de enlace del servicio. Cuando se establece un servicio, a veces debe ser aprobado por el otro o ambos miembros de la relación primero. Por lo tanto, un servicio puede tener el estado PENDING o APPROVED.
  • type: Se refiere al tipo de servicio. Estos son los posibles valores:
    • ACCOUNT_MANAGEMENT El proveedor administra la cuenta.
    • ACCOUNT_AGGREGATION El proveedor es un agregador de la cuenta.

El filtro sigue un subconjunto de la especificación del filtro AIP y su gramática formal EBNF. La gramática de este filtro es más restrictiva y específica.

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

Además, se aplica lo siguiente:

  • Cada campo combinado puede aparecer solo una vez (por ejemplo, solo es posible filtrar por accountName a nivel de la cuenta o por providerId una vez en cada nivel de relación).
  • En el caso de los campos de cadena (como accountName o accountIdAlias), es posible expresar un operador CONTAINS si encierras la consulta en *. Por ejemplo, accountName = "*foo*" mostraría todas las cuentas con un elemento accountName que contenga foo. De manera ortogonal, es posible expresar un operador NOT_CONTAINS mediante !=. Por ejemplo, accountName != "*foo*" mostraría todas las cuentas con un accountName que no contiene foo. Nota: Es posible buscar cuentas con una accountName que contenga el carácter de estrella * por medio de ***.
  • Se ignorarán los espacios en blanco adicionales.
  • Todos los valores, excepto los numéricos, deben encerrarse entre comillas dobles.
  • Si se usa una disyunción, las conjunciones de cada lado deben usar paréntesis incluso si la conjunción solo tiene una única expresión. Los paréntesis no se permiten en ningún otro lugar, excepto en invocaciones de funciones (como relationship o service). Esto es para expresar claramente que las conjunciones se vinculan más fuerte que las disyunciones lógicamente.

ListAccountsResponse

Mensaje de respuesta para el método ListAccounts.

Campos
accounts[]

Account

Las cuentas que coinciden con ListAccountsRequest.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListOnlineReturnPoliciesRequest

Mensaje de la solicitud para el método ListOnlineReturnPolicies.

Campos
parent

string

Obligatorio. La cuenta del comerciante para la que se enumeran las políticas de devoluciones. Formato: accounts/{account}
page_size

int32

Opcional. La cantidad máxima de recursos OnlineReturnPolicy que se mostrarán. El servicio muestra una cantidad inferior a este valor si la cantidad de políticas de devoluciones del comercio en cuestión es menor que la de pageSize. El valor predeterminado es 10. El valor máximo es 100. Si se especifica un valor superior al máximo, pageSize se establecerá como el máximo de forma predeterminada.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListOnlineReturnPolicies anterior. Proporciona el token de la página para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListOnlineReturnPolicies deben coincidir con la llamada que proporcionó el token de la página. El token que se muestra como nextPageToken en la respuesta de la solicitud anterior.

ListOnlineReturnPoliciesResponse

Mensaje de respuesta para el método ListOnlineReturnPolicies.

Campos
online_return_policies[]

OnlineReturnPolicy

Las políticas de devoluciones recuperadas.
next_page_token

string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListProgramsRequest

Mensaje de solicitud para el método ListPrograms.

Campos
parent

string

Obligatorio. El nombre de la cuenta para la que se recuperarán todos los programas. Formato: accounts/{account}
page_size

int32

Opcional. La cantidad máxima de programas que se mostrarán en una sola respuesta. Si no se especifica (o es 0), se usa un tamaño predeterminado de 1,000. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000.
page_token

string

Opcional. Un token de continuación, recibido de una llamada ListPrograms anterior. Proporciona esto para recuperar la página siguiente.

ListProgramsResponse

Mensaje de respuesta para el método ListPrograms.

Campos
programs[]

Program

Son los programas de la cuenta determinada.
next_page_token

string

Un token que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListRegionsRequest

Mensaje de la solicitud para el método ListRegions.

Campos
parent

string

Obligatorio. La cuenta para la que se enumeran las regiones. Formato: accounts/{account}
page_size

int32

Opcional. La cantidad máxima de regiones que se mostrarán. El servicio puede mostrar menos que este valor. Si no se especifica, se mostrarán 50 regiones como máximo. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListRegions anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListRegions deben coincidir con la llamada que proporcionó el token de la página.

ListRegionsResponse

Mensaje de respuesta para el método ListRegions.

Campos
regions[]

Region

Son las regiones del comercio especificado.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListSubAccountsRequest

Mensaje de la solicitud para el método ListSubAccounts.

Campos
provider

string

Obligatorio. La cuenta principal Formato: accounts/{account}
page_size

int32

Opcional. La cantidad máxima de cuentas que se mostrarán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán 250 cuentas como máximo. El valor máximo es 500; los valores superiores a 500 se convertirán en 500.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListAccounts anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListAccounts deben coincidir con la llamada que proporcionó el token de la página.

ListSubAccountsResponse

Mensaje de respuesta para el método ListSubAccounts.

Campos
accounts[]

Account

Las cuentas en las que la cuenta principal especificada es un agregador.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListUsersRequest

Mensaje de la solicitud para el método ListUsers.

Campos
parent

string

Obligatorio. El elemento superior, propietario de esta colección de usuarios. Formato: `accounts/{account}
page_size

int32

Opcional. Es la cantidad máxima de usuarios que se mostrarán. El servicio puede mostrar menos que este valor. Si no se especifica, se mostrarán 50 usuarios como máximo. El valor máximo es 100; los valores superiores a 100 se convertirán en 100
page_token

string

Opcional. Un token de página, recibido desde una llamada ListUsers anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListUsers deben coincidir con la llamada que proporcionó el token de la página.

ListUsersResponse

Mensaje de respuesta para el método ListUsers.

Campos
users[]

User

Son los usuarios de la cuenta especificada.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

LocationIdSet

Es una lista de conjuntos de ID de ubicación. No puede estar vacío. Solo se puede establecer si no están configurados todos los demás campos.

Campos
location_ids[]

string

Obligatorio. Una lista no vacía de IDs de ubicación. Todas deben ser del mismo tipo de ubicación (por ejemplo, estado).

MinimumOrderValueTable

Tabla de los valores de pedido mínimos por tienda para el tipo de entrega de retiro.

Campos
store_code_set_with_movs[]

StoreCodeSetWithMov

Obligatorio. Una lista de conjuntos de códigos de tienda que comparten el mismo valor mínimo de pedido (MOV) Se requieren al menos dos conjuntos y el último debe estar vacío, lo que significa "MOV para todas las demás tiendas". Cada código de tienda solo puede aparecer una vez en todos los conjuntos. Todos los precios de un servicio deben tener la misma moneda.

StoreCodeSetWithMov

Una lista de conjuntos de códigos de tienda que comparten el mismo valor mínimo de pedido. Se requieren al menos dos conjuntos y el último debe estar vacío, lo que significa "MOV para todas las demás tiendas". Cada código de tienda solo puede aparecer una vez en todos los conjuntos. Todos los precios de un servicio deben tener la misma moneda.

Campos
store_codes[]

string

Opcional. Una lista de códigos de tienda únicos o vacía para la genérica.
value

Price

Es el valor mínimo de pedido para las tiendas determinadas.

OnlineReturnPolicy

Política de devoluciones en línea. Actualmente, se usa para representar las políticas de devoluciones de anuncios y programas de fichas gratuitas.

Campos
name

string

Identificador. OnlineReturnPolicy: el nombre del recurso. Formato: accounts/{account}/onlineReturnPolicies/{return_policy}
return_policy_id

string

Solo salida. Es el ID de la política de devoluciones que genera Google.
label

string

Este campo representa la etiqueta única definida por el usuario de la política de devoluciones. Es importante tener en cuenta que no se puede usar la misma etiqueta en diferentes políticas de devoluciones para el mismo país. A menos que un producto especifique un atributo de etiqueta específico, las políticas se etiquetarán automáticamente como “predeterminadas”. Para asignar una política de devoluciones personalizada a ciertos grupos de productos, sigue las instrucciones que se indican en la Etiqueta de la política de devoluciones. La etiqueta puede contener hasta 50 caracteres.
countries[]

string

Los países de venta en los que se aplica la política de devoluciones. Los valores deben ser un código ISO 3166 válido de 2 letras.
policy

Policy

Es la política de devoluciones.
restocking_fee

RestockingFee

Es la tarifa de reposición que se aplica a todas las categorías de motivos de devolución. Esto se consideraría una tarifa de reposición gratuita si no se establece el valor.
return_methods[]

ReturnMethod

Son los métodos de devolución que indican los clientes que pueden devolver un artículo. Se requiere que este valor no esté vacío, a menos que el tipo de política de devoluciones sea noReturns.
item_conditions[]

ItemCondition

Las condiciones de los artículos que se aceptan para las devoluciones no deben estar vacías, a menos que el tipo de política de devoluciones sea “noReturns”.
return_shipping_fee

ReturnShippingFee

Es la tarifa de envío por devolución. Se debe configurar solo cuando el cliente necesita descargar e imprimir la etiqueta de devolución.
return_policy_uri

string

Es el URI de la política de devoluciones. Google puede usar esta información para realizar una verificación de estado de la política. Debe ser una URL válida.
accept_defective_only

bool

Este campo es obligatorio y especifica si el comercio solo acepta productos defectuosos para devoluciones.
process_refund_days

int32

Este campo especifica la cantidad de días que tardan los comercios en procesar reembolsos y es opcional.
accept_exchange

bool

Este campo especifica si el comercio permite que los clientes intercambien productos; este campo es obligatorio.

ItemCondition

Son las condiciones disponibles del artículo.

Enumeradores
ITEM_CONDITION_UNSPECIFIED Valor predeterminado Este valor no se usa.
NEW Nueva.
USED Usado.

Política

Las políticas disponibles

Campos
type

Type

Tipo de política.
days

int64

La cantidad de días en los que se pueden devolver los artículos después de la entrega. Un día se define como 24 horas después de la marca de tiempo de la entrega. Obligatorio para las devoluciones de NUMBER_OF_DAYS_AFTER_DELIVERY.

Tipo

Tipos de política de devoluciones.

Enumeradores
TYPE_UNSPECIFIED Valor predeterminado Este valor no se usa.
NUMBER_OF_DAYS_AFTER_DELIVERY Es la cantidad de días en los que una devolución es válida después de la entrega.
NO_RETURNS No ofrece devoluciones.
LIFETIME_RETURNS El tiempo regresa.

RestockingFee

Es la tarifa de reposición. Puede ser una tarifa fija o un microporcentaje.

Campos

Campo de unión type.

type puede ser una de las siguientes opciones:
fixed_fee

Price

Tarifa de reposición fija.
micro_percent

int32

Porcentaje del precio total en micros. 15,000,000 significa que se cobrará el 15% del precio total.

ReturnMethod

Los métodos de devolución disponibles.

Enumeradores
RETURN_METHOD_UNSPECIFIED Valor predeterminado Este valor no se usa.
BY_MAIL Devolución por correo postal.
IN_STORE Devolución en tienda.
AT_A_KIOSK Regresa al kiosco.

ReturnShippingFee

Es la tarifa de envío por devolución. Puede ser una tarifa fija o un valor booleano para indicar que el cliente paga el costo de envío real.

Campos
type

Type

Es el tipo de tarifa de envío por devolución.
fixed_fee

Price

Importe fijo de la tarifa de envío por devolución. Este valor solo es aplicable cuando el tipo es FIXED. Consideraremos la tarifa de envío por devolución como gratuita si el tipo es FIXED y no se establece este valor.

Tipo

Tipos de tarifas de envío por devolución.

Enumeradores
TYPE_UNSPECIFIED Valor predeterminado Este valor no se usa.
FIXED La tarifa de envío por devolución tiene un valor fijo.
CUSTOMER_PAYING_ACTUAL_FEE Los clientes pagarán la tarifa real de envío por devolución.

PhoneVerificationState

El estado de verificación del teléfono.

Enumeradores
PHONE_VERIFICATION_STATE_UNSPECIFIED Valor predeterminado Este valor no se usa.
PHONE_VERIFICATION_STATE_VERIFIED El teléfono está verificado.
PHONE_VERIFICATION_STATE_UNVERIFIED El teléfono no está verificado

Program

Define la participación en un programa determinado para la cuenta especificada.

Los programas ofrecen un mecanismo para agregar funciones a las cuentas de comerciante. Un ejemplo típico de esto es el programa Fichas de producto gratuitas, que permite que los productos de la tienda de un comercio se muestren en Google de forma gratuita.

Campos
name

string

Identificador. Es el nombre del recurso del programa. Formato: accounts/{account}/programs/{program}
documentation_uri

string

Solo salida. Es la URL de una página de ayuda de Merchant Center en la que se describe el programa.
state

State

Solo salida. El estado de participación de la cuenta en el programa.
active_region_codes[]

string

Solo salida. Indica las regiones en las que la cuenta participa de forma activa en el programa. Las regiones activas se definen como aquellas en las que se cumplen todos los requisitos del programa que afectan a las regiones.

CLDR define los códigos regionales. Es un país donde el programa se aplica específicamente a ese país o 001 cuando se aplica a nivel mundial.
unmet_requirements[]

Requirement

Solo salida. Son los requisitos que la cuenta aún no cumple y que afectan la participación en el programa.

Requisito

Define un requisito especificado para participar en el programa.

Campos
title

string

Solo salida. Es el nombre del requisito.
documentation_uri

string

Solo salida. Es la URL de una página de ayuda en la que se describe el requisito.
affected_region_codes[]

string

Solo salida. No se cumplen las regiones que actualmente se ven afectadas por este requisito.

CLDR define los códigos regionales. Es un país donde el programa se aplica específicamente a ese país o 001 cuando se aplica a nivel mundial.

Estado

Estados posibles de participación en el programa de la cuenta.

Enumeradores
STATE_UNSPECIFIED Valor predeterminado Este valor no se usa.
NOT_ELIGIBLE La cuenta no es apta para participar en el programa.
ELIGIBLE La cuenta es apta para participar en el programa.
ENABLED El programa está habilitado para la cuenta.

RateGroup

Definiciones de grupos de tarifas de envío Solo la última puede tener un applicable_shipping_labels vacío, que significa "todo lo demás". Los otros applicable_shipping_labels no deben superponerse.

Campos
applicable_shipping_labels[]

string

Obligatorio. Una lista de etiquetas de envío que definen los productos a los que se aplica este grupo de tarifas. Esta es una disyunción: solo una de las etiquetas debe coincidir para que se aplique el grupo de tarifas. Solo puede estar vacío para el último grupo de tarifas de un servicio.
subtables[]

Table

Opcional. Una lista de tablas secundarias a las que hace referencia main_table. Solo se puede establecer si se establece main_table.
carrier_rates[]

CarrierRate

Opcional. Una lista de tarifas de empresas de transporte a las que se puede hacer referencia mediante main_table o single_value.
single_value

Value

Es el valor del grupo de tarifas (por ejemplo, una tarifa plana de USD 10). Solo se puede establecer si no se configuran main_table ni subtables.
main_table

Table

Una tabla que define el grupo de tarifas, cuando single_value no es lo suficientemente expresivo. Solo se puede establecer si no se establece single_value.
name

string

Opcional. Nombre del grupo de tarifas. Si se configura debe ser único dentro del servicio de envío.

Región

Representa una región geográfica que puedes usar como destino con los servicios RegionalInventory y ShippingSettings. Puedes definir regiones como colecciones de códigos postales o, en algunos países, mediante segmentaciones geográficas predefinidas. Si quieres obtener más detalles, consulta Configura regiones .

Campos
name

string

Identificador. El nombre del recurso de la región. Formato: accounts/{account}/regions/{region}
postal_code_area

PostalCodeArea

Opcional. Es una lista de códigos postales que define el área de la región.
geotarget_area

GeoTargetArea

Opcional. Una lista de orientaciones geográficas que define el área de la región.
regional_inventory_eligible

BoolValue

Solo salida. Indica si la región es apta para usarse en la configuración del inventario regional.
shipping_eligible

BoolValue

Solo salida. Indica si la región es apta para su uso en la configuración de los servicios de envío.
display_name

string

Opcional. El nombre visible de la región.

GeoTargetArea

Una lista de orientaciones geográficas que define el área de la región.

Campos
geotarget_criteria_ids[]

int64

Obligatorio. Una lista no vacía de IDs de ubicación. Todas deben ser del mismo tipo de ubicación (por ejemplo, un estado).

PostalCodeArea

Es una lista de códigos postales que define el área de la región. Nota: Se puede acceder a todas las regiones definidas con códigos postales a través del recurso ShippingSettings.postalCodeGroups de la cuenta.

Campos
region_code

string

Obligatorio. Es el código de territorio de CLDR o el país al que se aplica el grupo de códigos postales.
postal_codes[]

PostalCodeRange

Obligatorio. Un intervalo de códigos postales.

PostalCodeRange

Un intervalo de códigos postales que define el área de la región.

Campos
begin

string

Obligatorio. Un código postal o un patrón con el prefijo de formulario* que denota el límite inferior inclusivo del rango que define el área. Valores de ejemplo: 94108, 9410*, 9*.
end

string

Opcional. Un código postal o un patrón con el formato prefix* que denota el límite superior inclusivo del rango que define el área. Debe tener la misma longitud que postalCodeRangeBegin: si postalCodeRangeBegin es un código postal, entonces postalCodeRangeEnd también debe ser un código postal; si postalCodeRangeBegin es un patrón, entonces postalCodeRangeEnd debe ser un patrón con la misma longitud de prefijo. Opcional: Si no se establece, el área se define como todos los códigos postales que coinciden con postalCodeRangeBegin.

Obligatorio

Describe las Condiciones del Servicio que se deben aceptar.

Campos
terms_of_service

string

Los termsOfService que se deben aceptar.
tos_file_uri

string

URL completa del archivo de las Condiciones del Servicio. Este campo es igual a TermsOfService.file_uri, se agrega aquí solo para mayor comodidad.

RetrieveForApplicationTermsOfServiceAgreementStateRequest

Mensaje de la solicitud para el método RetrieveForApplicationTermsOfServiceAgreementState.

Campos
parent

string

Obligatorio. La cuenta para la que se obtiene el formato de Condiciones del Servicio de Acuerdo: accounts/{account}

RetrieveLatestTermsOfServiceRequest

Mensaje de la solicitud para el método RetrieveLatestTermsOfService.

Campos
region_code

string

Código regional como lo define CLDR. Esto puede ser un país en el que las Condiciones del Servicio se aplican específicamente a ese país o el 001, cuando se aplican a nivel mundial.
kind

TermsOfServiceKind

El tipo al que se aplica esta versión de las Condiciones del Servicio.

Fila

Incluye una lista de celdas.

Campos
cells[]

Value

Obligatorio. Lista de celdas que constituyen la fila. Debe tener la misma longitud que columnHeaders para tablas bidimensionales, una longitud de 1 para tablas unidimensionales.

Servicio

Servicio de envío.

Campos
delivery_countries[]

string

Obligatorio. Es el código de territorio CLDR de los países a los que se aplica el servicio.
rate_groups[]

RateGroup

Opcional. Definiciones de grupos de tarifas de envío Solo la última puede tener un applicable_shipping_labels vacío, que significa "todo lo demás". Los otros applicable_shipping_labels no deben superponerse.
loyalty_programs[]

LoyaltyProgram

Opcional. Programas de lealtad a los que se limita este servicio de envío.
service_name

string

Obligatorio. Es el nombre del servicio en formato libre. Debe ser único en la cuenta de destino.
active

bool

Obligatorio. Es un valor booleano que expone el estado activo del servicio de envío.
currency_code

string

Es el código CLDR de la moneda a la que se aplica este servicio. Debe coincidir con los precios de los grupos de tarifas.
delivery_time

DeliveryTime

Obligatorio. Es el tiempo dedicado a varios aspectos, desde el pedido hasta la entrega del producto.
shipment_type

ShipmentType

Es el tipo de ubicaciones a las que este servicio envía pedidos.
minimum_order_value

Price

Es el valor mínimo de pedido de este servicio. Si se establece, indica que los clientes deberán invertir, al menos, este importe. Todos los precios de un servicio deben tener la misma moneda. No se puede configurar junto conminimum_order_value_table.
minimum_order_value_table

MinimumOrderValueTable

Tabla de los valores de pedido mínimos por tienda para el tipo de entrega de retiro. No se puede configurar junto conminimum_order_value.
store_config

StoreConfig

Es una lista de tiendas en las que se entregan tus productos. Esto solo es válido para el tipo de envío con entrega local.

LoyaltyProgram

Programa de lealtad proporcionado por un comercio.

Campos
loyalty_program_tiers[]

LoyaltyProgramTiers

Opcional. Es el nivel del programa de lealtad de este servicio de envío.
program_label

string

Es la etiqueta del programa de lealtad que se estableció en la configuración de tu programa de lealtad en Merchant Center. Este atributo secundario permite que Google asigne tu programa de lealtad a las ofertas aptas.

LoyaltyProgramTiers

Subconjunto de un programa de lealtad de comercios.

Campos
tier_label

string

El atributo secundario etiqueta de nivel [tier_label] diferencia los beneficios del nivel de oferta entre cada nivel. Este valor también se establece en la configuración del programa en Merchant Center y es obligatorio para realizar cambios en la fuente de datos, incluso si tu programa de lealtad solo tiene 1 nivel.

ShipmentType

Es el tipo de envío del servicio de envío.

Enumeradores
SHIPMENT_TYPE_UNSPECIFIED Este servicio no especificó el tipo de envío.
DELIVERY Este servicio envía los pedidos a una dirección elegida por el cliente.
LOCAL_DELIVERY Este servicio envía los pedidos a una dirección elegida por el cliente. El pedido se envía desde una tienda local cercana.
COLLECTION_POINT Este servicio envía los pedidos a una dirección elegida por el cliente. El pedido se envía desde un punto de recolección.

StoreConfig

Es una lista de tiendas en las que se entregan tus productos. Esto solo es válido para el tipo de envío con entrega local.

Campos
store_codes[]

string

Opcional. Una lista de códigos de tienda que ofrecen entrega local. Si está vacío, all_stores debe ser verdadero.
store_service_type

StoreServiceType

Indica si todas las tiendas o las tiendas seleccionadas que aparecen en este comercio ofrecen entrega local.
cutoff_config

CutoffConfig

Las configuraciones relacionadas con la entrega local finalizan el día.
service_radius

Distance

Radio de entrega máximo. Esto solo es obligatorio para el tipo de envío con entrega local.

CutoffConfig

Las configuraciones relacionadas con la entrega local finalizan el día.

Campos
local_cutoff_time

LocalCutoffTime

Hora a la que finaliza la entrega local ese día.
store_close_offset_hours

int64

Solo es válido con la entrega de entregas locales. Representa el horario límite como la cantidad de horas antes del cierre de la tienda. Este campo y local_cutoff_time son mutuamente excluyentes.
no_delivery_post_cutoff

bool

Los comercios pueden inhabilitar la opción de entrega local n + 1 día si tienen un servicio de envío configurado para la entrega local en n días. Por ejemplo, si el servicio de envío define la entrega el mismo día y ya pasó la hora límite, establecer este campo en true hará que la tarifa calculada del servicio de envío muestre NO_DELIVERY_POST_CUTOFF. En el mismo ejemplo, configurar este campo en false da como resultado que el tiempo de envío calculado sea de un día. Esto es solo para envíos locales.

LocalCutoffTime

Hora a la que finaliza la entrega local ese día.

Campos
hour

int64

Los pedidos con entrega local a la hora deben realizarse hasta el mismo día para que se procesen.
minute

int64

Los pedidos con entrega local de minutos deben hacerse antes para que se procesen el mismo día.

StoreServiceType

Indica si todas las tiendas, o las tiendas seleccionadas, indicadas por el comercio, ofrecen entrega local.

Enumeradores
STORE_SERVICE_TYPE_UNSPECIFIED No se especificó el tipo de servicio de tienda.
ALL_STORES Indica si todas las tiendas, actuales y futuras, de este comercio, ofrecen servicio de entrega local.
SELECTED_STORES Indica que solo las tiendas que aparecen en store_codes son aptas para la entrega local.

ShippingSettings

La [configuración de envío](https://support.google.com/merchants/answer/6069284) de la cuenta del comerciante.

Campos
name

string

Identificador. El nombre del recurso de la configuración de envío. Formato: accounts/{account}/shippingSetting
services[]

Service

Opcional. La lista de servicios de la cuenta de destino.
warehouses[]

Warehouse

Opcional. Una lista de almacenes a los que se puede hacer referencia en services
etag

string

Obligatorio. Este campo se utiliza para evitar problemas asíncronos. Asegúrate de que los datos de la configuración de envío no hayan cambiado entre las llamadas get y insert. El usuario debe seguir estos pasos:

  1. Establece el campo etag como una cadena vacía para crear la configuración de envío inicial.

  2. Después de la creación inicial, llama al método get para obtener una ETag y los datos de la configuración de envío actual antes de la inserción de la llamada.

  3. Modifica para obtener la información de la configuración de envío deseada.

  4. Llama al método de inserción con la información de configuración de envío deseada con la ETag que se obtuvo en el paso 2.

  5. Si los datos de la configuración de envío cambiaron entre los pasos 2 y 4. La solicitud de inserción fallará porque la ETag cambia cada vez que cambian los datos de la configuración de envío. El usuario debe repetir los pasos 2 y 4 con la nueva ETag.

Tabla

Una tabla que define el grupo de tarifas, cuando single_value no es lo suficientemente expresivo.

Campos
rows[]

Row

Obligatorio. Es la lista de filas que constituyen la tabla. Debe tener la misma longitud que row_headers.
name

string

Nombre de la tabla. Obligatorio para las tablas secundarias; se ignora para la tabla principal.
row_headers

Headers

Obligatorio. Encabezados de las filas de la tabla.
column_headers

Headers

Encabezados de las columnas de la tabla. Opcional: Si no se establece, la tabla tiene solo una dimensión.

TaxRule

Convención de tipo principal

porcentaje micro : 100% = 1 000 000 y 1% = 10 000 no pueden ser negativos.

Información sobre nexos fiscales y parámetros relacionados aplicables a los pedidos entregados en el área cubierta por un único administrador fiscal. El nexo se crea cuando un comercio opera en un área administrada por el administrador fiscal (solo se admiten los estados de EE.UU. para la configuración de nexos). Si el comercio tiene nexo fiscal en un estado de EE.UU., debe pagar impuestos a todas las autoridades fiscales asociadas con el destino de envío. Next Id : 8

Campos
region_code

string

Código regional en el que se aplica esta regla
shipping_taxed

bool

Si se establece, se gravará el cargo de envío (con la misma tarifa que el producto) cuando se entregue en el área de este administrador. Solo se puede configurar en estados de EE.UU. sin una categoría.
effective_time_period

Interval

Obligatorio. Período en el que esta regla entró en vigencia. Si falta la duración deeffective_time enumerada, entonces es abierta para el futuro. El inicio de este período es inclusivo y el final es exclusivo.
Campo de unión location. Describe la ubicación mediante un intervalo de códigos postales o un ID de criterios. Las direcciones (location) solo pueden ser una de las siguientes opciones:
location_id

int64

El admin_id oEl_id_criterios de la región en la que se aplica esta regla.
post_code_range

TaxPostalCodeRange

El intervalo de códigos postales al que se aplica esta regla.
Campo de unión rate_calculation. ¿Cómo se calcula la tasa impositiva para las entregas en el área de este administrador? Solo se puede configurar en estados de EE.UU. Las direcciones (rate_calculation) solo pueden ser una de las siguientes opciones:
use_google_rate

bool

Tarifa que depende de la ubicación de entrega: Si el comercio tiene nexo fiscal en el estado correspondiente de EE.UU., se suman las tarifas de las autoridades con jurisdicción sobre el área de entrega.
self_specified_rate_micros

int64

Una tasa fija especificada en micros, donde 100% = 1_000_000. Apto para estados basados en el origen.

TaxPostalCodeRange

Un intervalo de códigos postales que define el área.

Campos
start

string

Obligatorio. Indica el inicio del intervalo de códigos postales, que también es el más pequeño del intervalo.
end

string

Final del intervalo de códigos postales. Será la misma que la de inicio si no se especifica.

TermsOfService

Un objeto TermsOfService.

Campos
name

string

Identificador. El nombre del recurso de la versión de las Condiciones del Servicio. Formato: termsOfService/{version}
region_code

string

Código regional como lo define CLDR. Debe ser un país donde las Condiciones del Servicio se aplican específicamente a ese país o 001 si se puede firmar el mismo TermsOfService en cualquier país. Sin embargo, ten en cuenta que, cuando firmamos las Condiciones del Servicio que se aplican a nivel mundial, esperamos que se proporcione un país específico (debe ser el país de la empresa del comercio o el país de participación del programa).
kind

TermsOfServiceKind

El tipo al que se aplica esta versión de las Condiciones del Servicio.
external

bool

Si esta versión de las Condiciones del Servicio es externa. Solo se pueden aceptar las versiones externas de las Condiciones del Servicio a través de procesos externos y no el comercio directamente a través de la IU o la API.
file_uri

string

El URI del archivo de las Condiciones del Servicio que se debe mostrar a los usuarios que firman.

TermsOfServiceAgreementState

Este recurso representa el estado del acuerdo para una cuenta determinada y un tipo de Condiciones del Servicio. El estado es el siguiente:

  • Si el comercio aceptó las Condiciones del Servicio, el campo Accepted se propagará; de lo contrario, estará vacía
  • Si el comercio debe firmar unas Condiciones del Servicio, el campo required se propagará; de lo contrario, estará vacía.

Ten en cuenta que pueden ser obligatorios y aceptados. En este caso, las condiciones del servicio de accepted tendrán una fecha de vencimiento establecida en el campo valid_until. Se deben aceptar las Condiciones del Servicio de required antes del valid_until para que la cuenta siga teniendo un acuerdo válido. Cuando aceptamos las nuevas condiciones del servicio, esperamos que los terceros muestren el texto asociado con el acuerdo de condiciones del servicio especificado (la URL del archivo que contiene el texto se agrega en el mensaje obligatorio que aparece a continuación como tos_file_uri). La aceptación real de las Condiciones del Servicio se realiza mediante el llamado a aceptar en el recurso TermsOfService.

Campos
name

string

Identificador. El nombre del recurso de la versión de las Condiciones del Servicio. Formato: accounts/{account}/termsOfServiceAgreementState/{identifier}
region_code

string

Código de región definido por https://cldr.unicode.org/. Este es el país al que se aplica el estado actual.
terms_of_service_kind

TermsOfServiceKind

Es el tipo de las Condiciones del Servicio asociado a la versión específica.
accepted

Accepted

Son las Condiciones del Servicio aceptadas de este tipo y para la region_code asociada
required

Required

Las Condiciones del Servicio requeridas

TermsOfServiceKind

Las categorías de Términos de servicio

Enumeradores
TERMS_OF_SERVICE_KIND_UNSPECIFIED Valor predeterminado Este valor no se usa.
MERCHANT_CENTER App de Merchant Center.

TransitTable

Tabla de tiempo en tránsito, que corresponde a la cantidad de días hábiles que se pasaron en tránsito según las dimensiones de filas y columnas. Se puede configurar min_transit_days, max_transit_days o transit_time_table, pero no ambos.

Campos
postal_code_group_names[]

string

Obligatorio. Una lista de nombres de regiones Region.name . El último valor puede ser "all other locations". Ejemplo: ["zone 1", "zone 2", "all other locations"]. Los grupos de códigos postales a los que se hace referencia deben coincidir con el país de entrega del servicio.
transit_time_labels[]

string

Obligatorio. Es una lista de etiquetas de tiempo en tránsito. El último valor puede ser "all other labels". Ejemplo: ["food", "electronics", "all other labels"].
rows[]

TransitTimeRow

Obligatorio. Si solo hay un conjunto de dimensiones de postal_code_group_names o transit_time_labels, hay varias filas, cada una con un valor para esa dimensión. Si hay dos dimensiones, cada fila corresponde a una postal_code_group_names y las columnas (valores) a una transit_time_labels.

TransitTimeRow

Si solo hay un conjunto de dimensiones de postal_code_group_names o transit_time_labels, hay varias filas, cada una con un valor para esa dimensión. Si hay dos dimensiones, cada fila corresponde a una postal_code_group_names y las columnas (valores) a una transit_time_labels.

Campos
values[]

TransitTimeValue

Obligatorio. Es el intervalo de tiempo en tránsito (mín.-máx.) en días hábiles.

TransitTimeValue

Es el intervalo de tiempo en tránsito (mín.-máx.) en días hábiles.

Campos
min_transit_days

int32

Intervalo de tiempo mínimo en tránsito en días hábiles. 0 significa entrega el mismo día, 1 significa entrega al día siguiente.
max_transit_days

int32

Debe ser mayor o igual que min_transit_days.

UnclaimHomepageRequest

Mensaje de la solicitud para el método UnclaimHomepage.

Campos
name

string

Obligatorio. El nombre de la página principal que se debe retirar. Formato: accounts/{account}/homepage

UpdateAccountRequest

Mensaje de la solicitud para el método UpdateAccount.

Campos
account

Account

Obligatorio. La nueva versión de la cuenta.
update_mask

FieldMask

Obligatorio. Lista de campos que se están actualizando.

UpdateAccountTaxRequest

Cómo solicitar la actualización de la configuración fiscal

Campos
account_tax

AccountTax

Obligatorio. La configuración de impuestos que se actualizará
update_mask

FieldMask

La lista de campos que se actualizarán

UpdateBusinessIdentityRequest

Mensaje de la solicitud para el método UpdateBusinessIdentity.

Campos
business_identity

BusinessIdentity

Obligatorio. La versión nueva de la identidad de la empresa.
update_mask

FieldMask

Obligatorio. Lista de campos que se están actualizando.

UpdateBusinessInfoRequest

Mensaje de la solicitud para el método UpdateBusinessInfo.

Campos
business_info

BusinessInfo

Obligatorio. La nueva versión de la información de la empresa.
update_mask

FieldMask

Obligatorio. Lista de campos que se están actualizando.

UpdateEmailPreferencesRequest

Mensaje de solicitud para el método UpdateEmailPreferences.

Campos
email_preferences

EmailPreferences

Obligatorio. Se actualizarán las preferencias de correo electrónico.
update_mask

FieldMask

Obligatorio. Lista de campos que se están actualizando.

UpdateHomepageRequest

Mensaje de la solicitud para el método UpdateHomepage.

Campos
homepage

Homepage

Obligatorio. La nueva versión de la página principal.
update_mask

FieldMask

Obligatorio. Lista de campos que se están actualizando.

UpdateRegionRequest

Mensaje de la solicitud para el método UpdateRegion.

Campos
region

Region

Obligatorio. La región actualizada.
update_mask

FieldMask

Opcional. La máscara de campo separada por comas que indica los campos que se actualizarán. Ejemplo: "displayName,postalCodeArea.regionCode".

UpdateUserRequest

Mensaje de la solicitud para el método UpdateUser.

Campos
user

User

Obligatorio. Es la versión nueva del usuario.

También es posible actualizar el usuario que corresponde al emisor mediante me, en lugar de una dirección de correo electrónico en el campo de nombre, como en accounts/{account}/users/me.
update_mask

FieldMask

Obligatorio. Lista de campos que se están actualizando.

Usuario

Un usuario.

Campos
name

string

Identificador. Es el nombre del recurso del usuario. Formato: accounts/{account}/user/{user}
state

State

Solo salida. El estado del usuario.
access_rights[]

AccessRight

Opcional. Son los derechos de acceso que tiene el usuario.

Estado

Son los posibles estados de un usuario.

Enumeradores
STATE_UNSPECIFIED Valor predeterminado Este valor no se usa.
PENDING La confirmación del usuario está pendiente. En este estado, el usuario primero debe aceptar la invitación antes de realizar otras acciones.
VERIFIED El usuario está verificado.

Valor

El valor único de un grupo de tarifas o el valor de la celda de la tabla de un grupo de tarifas. Se debe establecer exactamente uno de los siguientes valores: no_shipping, flat_rate, price_percentage, carrier_rateName o subtable_name.

Campos
no_shipping

bool

Si es "true", el producto no se puede enviar. Debe ser verdadera cuando se establece; solo se puede establecer si no se establecen todos los demás campos.
flat_rate

Price

Una tarifa plana. Solo se puede establecer si no están configurados todos los demás campos.
price_percentage

string

Un porcentaje del precio representado como un número en notación decimal (por ejemplo, "5.4"). Solo se puede establecer si no se establecen todos los demás campos.
carrier_rate

string

Es el nombre de la tarifa de una empresa de transporte que hace referencia a una tarifa de la empresa de transporte definida en el mismo grupo de tarifas. Solo se puede establecer si no están configurados todos los demás campos.
subtable

string

Es el nombre de una tabla secundaria. Solo se puede establecer en las celdas de la tabla (por ejemplo, no para valores individuales) y solo si no se configuran todos los demás campos.

Almacén

Un almacén de entrega, que almacena y maneja inventario Siguiente etiqueta: 7

Campos
name

string

Obligatorio. El nombre del almacén Debe ser único en la cuenta.
shipping_address

Address

Obligatorio. Dirección de envío del almacén.
cutoff_time

WarehouseCutoffTime

Obligatorio. El último momento del día en que se puede aceptar un pedido y comenzar a procesarse. Los pedidos posteriores se procesarán al día siguiente. La hora se basa en el código postal del almacén.
handling_days

int64

Obligatorio. Es la cantidad de días que tarda este almacén en empacar y enviar un artículo. Esto se encuentra a nivel del almacén, pero se puede anular a nivel de la oferta según los atributos de un artículo.
business_day_config

BusinessDayConfig

Días hábiles del depósito Si no la estableces, será de lunes a viernes de forma predeterminada.

WarehouseBasedDeliveryTime

Indica que el tiempo de entrega se debe calcular por almacén (ubicación de origen del envío) según la configuración de la empresa de transporte seleccionada. Cuando se establece, no se debe establecer ningún otro campo relacionado con el tiempo en tránsito en delivery_time.

Campos
carrier

string

Obligatorio. Proveedor, como "UPS" o "Fedex".
carrier_service

string

Obligatorio. Servicio del operador, como "ground" o "2 days" El nombre del servicio debe estar en la lista eddSupportedServices.
warehouse

string

Obligatorio. Nombre del almacén. Debería coincidir con [warehouse][ShippingSetting.warehouses.name].

WarehouseCutoffTime

El último momento del día en que se puede aceptar un pedido y comenzar a procesarse. Los pedidos posteriores se procesarán al día siguiente. La hora se basa en el código postal del almacén.

Campos
hour

int32

Obligatorio. Es la hora límite hasta la que se debe realizar un pedido para que el almacén lo procese el mismo día. La hora se basa en la zona horaria del almacén.
minute

int32

Obligatorio. Minuto del horario límite hasta el que se debe realizar un pedido para que el almacén lo procese el mismo día. El minuto se basa en la zona horaria del almacén.