Descripción general de la sub-API de Programs

Los programas te permiten controlar la promoción de tus productos y mejorar las funciones de tu cuenta en varias plataformas de Google.

Un ejemplo típico de esto es el programa de fichas de productos gratuitas, que permite que los productos de tu tienda en línea se muestren en Google sin cargo.

La API secundaria de Programs te permite recuperar y actualizar tu participación en todos los programas de compras disponibles.

Para recuperar, habilitar y inhabilitar programas, puedes usar los siguientes métodos:

Crea una lista de todos los programas

Para recuperar todos los programas de la cuenta, usa el accounts.programs.list método.

A continuación, se muestra una solicitud de ejemplo:

HTTP

GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs

cURL

  curl \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs?key={YOUR_API_KEY}' \
  --header 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \
  --header 'Accept: application/json' \
  --compressed

Esta es una respuesta de ejemplo de una solicitud exitosa:

{
  "programs": [
    {
      "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
      "documentationUri": "{URI}",
      "state": "{ACCOUNT_STATE}",
      "unmetRequirements": [
        {
          "title": "{TITLE}",
          "documentationUri": "{URI}",
          "affectedRegionCodes": [
            "{REGION_CODE}"
          ]
        }
      ]
    }
  ]
}

Recupera un solo programa

Para recuperar un programa específico, usa el accounts.programs.get método.

A continuación, se muestra una solicitud de ejemplo:

HTTP

GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listings

cURL

  curl \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listing?key={YOUR_API_KEY}' \
  --header 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \
  --header 'Accept: application/json' \
  --compressed

Esta es una respuesta de ejemplo de una solicitud exitosa:

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}",
  "unmetRequirements": [
    {
      "title": "{TITLE}",
      "documentationUri": "{URI}",
      "affectedRegionCodes": [
        "{REGION_CODE}"
      ]
    }
  ]
}

Habilita un programa

Para habilitar la participación en el programa especificado para la cuenta, usa el accounts.programs.enable método. Debes tener acceso de administrador para ejecutar este permiso.

A continuación, se muestra una solicitud de ejemplo:

HTTP

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listings:enable

cURL

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listing:enable?key={YOUR_API_KEY}' \
  --header 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}' \
  --compressed

Esta es una respuesta de ejemplo de una solicitud exitosa:

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}",
  "unmetRequirements": [
    {
      "title": "{TITLE}",
      "documentationUri": "{URI}",
      "affectedRegionCodes": [
        "{REGION_CODE}"
      ]
    }
  ]
}

Inhabilita un programa

Para inhabilitar la participación en el programa especificado para la cuenta, usa el accounts.programs.disable método. Debes tener acceso de administrador para ejecutar este permiso.

A continuación, se muestra una solicitud de ejemplo:

HTTP

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listings:disable

cURL

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listing:disable?key={YOUR_API_KEY}' \
  --header 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}' \
  --compressed

Esta es una respuesta de ejemplo de una solicitud exitosa:

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}"
}