Présentation de la sous-API Programs

Les programmes vous permettent de contrôler la promotion de vos produits et d'améliorer les fonctionnalités de votre compte sur différentes surfaces Google.

C'est le cas, par exemple, du programme de fiches produit sans frais, qui permet de présenter les produits de votre boutique en ligne sur Google sans frais.

La sous-API Programs vous permet de récupérer et de mettre à jour votre participation à tous les programmes Shopping disponibles.

Pour récupérer, activer et désactiver des programmes, vous pouvez utiliser les méthodes suivantes:

Répertorier tous les programmes

Pour récupérer tous les programmes du compte, utilisez la méthode accounts.programs.list.

Voici un exemple de requête:

HTTP

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

cURL

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

Voici un exemple de réponse à une requête réussie:

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

Récupérer un seul programme

Pour récupérer un programme spécifique, utilisez la méthode accounts.programs.get.

Voici un exemple de requête:

HTTP

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

cURL

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

Voici un exemple de réponse à une requête réussie:

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

Activer un programme

Pour activer la participation au programme spécifié pour le compte, utilisez la méthode accounts.programs.enable. Vous devez disposer d'un accès administrateur pour exécuter cette autorisation.

Voici un exemple de requête:

HTTP

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

cURL

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1beta/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

Voici un exemple de réponse à une requête réussie:

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

Désactiver un programme

Pour désactiver la participation au programme spécifié pour le compte, utilisez la méthode accounts.programs.disable. Vous devez disposer d'un accès administrateur pour exécuter cette autorisation.

Voici un exemple de requête:

HTTP

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

cURL

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1beta/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

Voici un exemple de réponse à une requête réussie:

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