Attention:Vous consultez la documentation de l'interface REST de l'API. La plupart de nos bibliothèques clientes officielles utilisent gRPC. Pour en savoir plus, consultez la présentation de REST.

Cette page a été traduite par l'API Cloud Translation.

AdGroup

Représentation JSON
AdGroupStatus
AdGroupAdRotationMode
AudienceSetting
- Représentation JSON
AdGroupPrimaryStatus
AdGroupPrimaryStatusReason

Un groupe d'annonces.

Représentation JSON

Représentation JSON
{ "resourceName": string, "status": enum (`AdGroupStatus`), "type": enum (`AdGroupType`), "adRotationMode": enum (`AdGroupAdRotationMode`), "urlCustomParameters": [ { object (`CustomParameter`) } ], "optimizedTargetingEnabled": boolean, "displayCustomBidDimension": enum (`TargetingDimension`), "targetingSetting": { object (`TargetingSetting`) }, "audienceSetting": { object (`AudienceSetting`) }, "effectiveTargetCpaSource": enum (`BiddingSource`), "effectiveTargetRoasSource": enum (`BiddingSource`), "labels": [ string ], "excludedParentAssetFieldTypes": [ enum (`AssetFieldType`) ], "excludedParentAssetSetTypes": [ enum (`AssetSetType`) ], "primaryStatus": enum (`AdGroupPrimaryStatus`), "primaryStatusReasons": [ enum (`AdGroupPrimaryStatusReason`) ], "id": string, "name": string, "baseAdGroup": string, "trackingUrlTemplate": string, "campaign": string, "cpcBidMicros": string, "effectiveCpcBidMicros": string, "cpmBidMicros": string, "targetCpaMicros": string, "cpvBidMicros": string, "targetCpmMicros": string, "targetRoas": number, "percentCpcBidMicros": string, "finalUrlSuffix": string, "effectiveTargetCpaMicros": string, "effectiveTargetRoas": number }

{
  "resourceName": string,
  "status": enum (AdGroupStatus),
  "type": enum (AdGroupType),
  "adRotationMode": enum (AdGroupAdRotationMode),
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "optimizedTargetingEnabled": boolean,
  "displayCustomBidDimension": enum (TargetingDimension),
  "targetingSetting": {
    object (TargetingSetting)
  },
  "audienceSetting": {
    object (AudienceSetting)
  },
  "effectiveTargetCpaSource": enum (BiddingSource),
  "effectiveTargetRoasSource": enum (BiddingSource),
  "labels": [
    string
  ],
  "excludedParentAssetFieldTypes": [
    enum (AssetFieldType)
  ],
  "excludedParentAssetSetTypes": [
    enum (AssetSetType)
  ],
  "primaryStatus": enum (AdGroupPrimaryStatus),
  "primaryStatusReasons": [
    enum (AdGroupPrimaryStatusReason)
  ],
  "id": string,
  "name": string,
  "baseAdGroup": string,
  "trackingUrlTemplate": string,
  "campaign": string,
  "cpcBidMicros": string,
  "effectiveCpcBidMicros": string,
  "cpmBidMicros": string,
  "targetCpaMicros": string,
  "cpvBidMicros": string,
  "targetCpmMicros": string,
  "targetRoas": number,
  "percentCpcBidMicros": string,
  "finalUrlSuffix": string,
  "effectiveTargetCpaMicros": string,
  "effectiveTargetRoas": number
}

Champs
`resourceName`	`string` Immuable. Nom de ressource du groupe d'annonces. Les noms de ressources d'un groupe d'annonces se présentent comme suit: `customers/{customerId}/adGroups/{adGroupId}`
`status`	`enum (AdGroupStatus)` État du groupe d'annonces.
`type`	`enum (AdGroupType)` Immuable. Type de groupe d'annonces.
`adRotationMode`	`enum (AdGroupAdRotationMode)` Mode de rotation des annonces du groupe d'annonces.
`urlCustomParameters[]`	`object (CustomParameter)` Liste des mappages utilisés pour remplacer les balises de paramètres personnalisés dans `trackingUrlTemplate`, `finalUrls` ou `mobile_final_urls`.
`optimizedTargetingEnabled`	`boolean` "True" si le ciblage optimisé est activé. Le ciblage optimisé remplace l'élargissement de l'audience.
`displayCustomBidDimension`	`enum (TargetingDimension)` Permet aux annonceurs de spécifier une dimension de ciblage sur laquelle placer des enchères absolues. Ceci n'est valable que pour les campagnes qui ne ciblent que le Réseau Display, et non le Réseau de Recherche.
`targetingSetting`	`object (TargetingSetting)` Paramètre de ciblage des fonctionnalités associées.
`audienceSetting`	`object (AudienceSetting)` Immuable. Paramètre des fonctionnalités liées à l'audience.
`effectiveTargetCpaSource`	`enum (BiddingSource)` Uniquement en sortie. Source du CPA cible effectif. Ce champ est en lecture seule.
`effectiveTargetRoasSource`	`enum (BiddingSource)` Uniquement en sortie. Source du ROAS cible effectif. Ce champ est en lecture seule.
`labels[]`	`string` Uniquement en sortie. Noms de ressource des étiquettes associées à ce groupe d'annonces.
`excludedParentAssetFieldTypes[]`	`enum (AssetFieldType)` Types de champs de composants à exclure de ce groupe d'annonces. Ce groupe d'annonces n'héritera pas des liens d'assets utilisant ces types de champs à partir des niveaux supérieurs.
`excludedParentAssetSetTypes[]`	`enum (AssetSetType)` Types d'ensembles de composants à exclure de ce groupe d'annonces. Ce groupe d'annonces n'héritera pas des liens vers les ensembles de composants de ces types à partir des niveaux supérieurs. Les types de groupes d'établissements (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP et STATIC_LOCATION_GROUP) sont des types enfants de LOCATION_SYNC. Par conséquent, si LOCATION_SYNC est défini pour ce champ, vous n'êtes pas autorisé à associer tous les ensembles de composants d'un groupe de zones géographiques à ce groupe d'annonces, et l'ensemble des extensions de lieu et de lieu affilié (ALE) ne seront pas diffusées dans ce groupe d'annonces. Seul LOCATION_SYNC est actuellement pris en charge.
`primaryStatus`	`enum (AdGroupPrimaryStatus)` Uniquement en sortie. Fournit une vue agrégée des raisons pour lesquelles un groupe d'annonces n'est pas diffusé ou n'est pas diffusé de manière optimale.
`primaryStatusReasons[]`	`enum (AdGroupPrimaryStatusReason)` Uniquement en sortie. Fournit les raisons pour lesquelles un groupe d'annonces n'est pas diffusé ou n'est pas diffusé de manière optimale.
`id`	`string (int64 format)` Uniquement en sortie. Identifiant du groupe d'annonces.
`name`	`string` Nom du groupe d'annonces. Ce champ est obligatoire. Il ne doit pas être vide lors de la création de groupes d'annonces. Il doit contenir moins de 255 caractères UTF-8 en pleine largeur. Il ne doit contenir aucun caractère nul (point de code 0x0), de saut de ligne NL (point de code 0xA) ni de retour chariot (point de code 0xD).
`baseAdGroup`	`string` Uniquement en sortie. Pour les groupes d'annonces brouillons ou tests, ce champ correspond au nom de ressource du groupe d'annonces de base à partir duquel ce groupe d'annonces a été créé. Si un groupe d'annonces brouillon ou test ne comporte pas de groupe d'annonces de base, ce champ est vide. Pour les groupes d'annonces de base, ce champ correspond au nom de ressource du groupe d'annonces. Ce champ est en lecture seule.
`trackingUrlTemplate`	`string` Modèle d'URL permettant de créer une URL de suivi.
`campaign`	`string` Immuable. Campagne à laquelle appartient le groupe d'annonces.
`cpcBidMicros`	`string (int64 format)` Enchère au CPC (coût par clic) maximal.
`effectiveCpcBidMicros`	`string (int64 format)` Uniquement en sortie. La valeur est identique à celle de l'enchère au CPC (coût par clic) lorsque la stratégie d'enchères correspond à une stratégie d'enchères au CPC manuel, au CPC optimisé, à la première page promue ou au taux de surclassement cible. Sinon, la valeur est nulle.
`cpmBidMicros`	`string (int64 format)` Enchère au CPM (coût pour mille impressions visibles) maximale.
`targetCpaMicros`	`string (int64 format)` Le CPA (coût par acquisition) cible. Si la stratégie d'enchères du groupe d'annonces est "TargetCpa" ou "Maximiser les conversions" (avec le champ "targetCpa" défini), ce champ remplace le CPA cible spécifié dans la stratégie d'enchères de la campagne. Sinon, cette valeur est ignorée.
`cpvBidMicros`	`string (int64 format)` Il s'agit de l'enchère au CPV (coût par vue).
`targetCpmMicros`	`string (int64 format)` Montant moyen (en micros) que l'annonceur est prêt à payer pour mille diffusions de son annonce.
`targetRoas`	`number` Remplacement du ROAS (retour sur les dépenses publicitaires) cible. Si la stratégie d'enchères de la campagne du groupe d'annonces est "TargetRoas" ou "MaximiserConversionValue" (avec le champ "targetRoas" défini), ce champ remplace le ROAS cible spécifié dans la stratégie d'enchères de la campagne. Sinon, cette valeur est ignorée.
`percentCpcBidMicros`	`string (int64 format)` Montant de l'enchère au CPC (en %), exprimé en tant que fraction du prix annoncé pour un bien ou un service. La plage valide pour la fraction est [0,1) et la valeur stockée ici est 1 000 000 * [fraction].
`finalUrlSuffix`	`string` Modèle d'URL permettant d'ajouter des paramètres à l'URL finale
`effectiveTargetCpaMicros`	`string (int64 format)` Uniquement en sortie. Il s'agit du CPA (coût par acquisition) cible effectif. Ce champ est en lecture seule.
`effectiveTargetRoas`	`number` Uniquement en sortie. ROAS (retour sur les dépenses publicitaires) cible effectif. Ce champ est en lecture seule.

AdGroupStatus

États possibles d'un groupe d'annonces.

Enums
`UNSPECIFIED`	L'état n'a pas été spécifié.
`UNKNOWN`	La valeur reçue n'est pas connue dans cette version. Il s'agit d'une valeur de réponse uniquement.
`ENABLED`	Le groupe d'annonces est activé.
`PAUSED`	Le groupe d'annonces est en veille.
`REMOVED`	Le groupe d'annonces est supprimé.

AdGroupAdRotationMode

Modes de rotation des annonces possibles au sein d'un groupe d'annonces.

Enums
`UNSPECIFIED`	Le mode de rotation des annonces n'a pas été spécifié.
`UNKNOWN`	La valeur reçue n'est pas connue dans cette version. Il s'agit d'une valeur de réponse uniquement.
`OPTIMIZE`	Optimisez les annonces d'un groupe d'annonces en fonction des clics ou des conversions.
`ROTATE_FOREVER`	Alterner de manière régulière et indéfiniment.

AudienceSetting

Paramètres du ciblage d'audience.

Représentation JSON
{ "useAudienceGrouped": boolean }

Champs

Champs
`useAudienceGrouped`	`boolean` Immuable. Si la valeur est "true", ce groupe d'annonces utilise une ressource d'audience pour le ciblage d'audience. Si la valeur est "false", ce groupe d'annonces peut utiliser des critères de segment d'audience à la place.

useAudienceGrouped

boolean

Immuable. Si la valeur est "true", ce groupe d'annonces utilise une ressource d'audience pour le ciblage d'audience. Si la valeur est "false", ce groupe d'annonces peut utiliser des critères de segment d'audience à la place.

AdGroupPrimaryStatus

Les différents états possibles d'un groupe d'annonces.

Enums
`UNSPECIFIED`	Non spécifié.
`UNKNOWN`	Utilisé pour la valeur renvoyée uniquement. Représente une valeur inconnue dans cette version.
`ELIGIBLE`	Le groupe d'annonces peut être diffusé.
`PAUSED`	Le groupe d'annonces est en veille.
`REMOVED`	Le groupe d'annonces est supprimé.
`PENDING`	Le groupe d'annonces est susceptible d'être diffusé ultérieurement.
`NOT_ELIGIBLE`	Le groupe d'annonces ne peut pas être diffusé.
`LIMITED`	La diffusion de ce groupe d'annonces est limitée.

AdGroupPrimaryStatusReason

Motifs possibles de l'état du groupe d'annonces.

Enums
`UNSPECIFIED`	Non spécifié.
`UNKNOWN`	Utilisé pour la valeur renvoyée uniquement. Représente une valeur inconnue dans cette version.
`CAMPAIGN_REMOVED`	L'état de campagne spécifié par l'utilisateur est supprimé. Contribue à GroupPrimaryStatus.NOT_ELIGIBLE.
`CAMPAIGN_PAUSED`	L'état de la campagne spécifié par l'utilisateur est "Mis en veille". Contribue à GroupPrimaryStatus.NOT_ELIGIBLE.
`CAMPAIGN_PENDING`	La date de début spécifiée par l'utilisateur pour cette campagne est postérieure à la date du jour. Contribue à GroupPrimaryStatus.NOT_ELIGIBLE
`CAMPAIGN_ENDED`	Le délai de fin spécifié par l'utilisateur est écoulé. Contribue à GroupPrimaryStatus.NOT_ELIGIBLE.
`AD_GROUP_PAUSED`	L'état du groupe d'annonces spécifié par l'utilisateur est "Mis en veille". Contribue à GroupePrimaryStatus.PAUSE.
`AD_GROUP_REMOVED`	L'état du groupe d'annonces spécifié par l'utilisateur est supprimé. Contribue à GroupPrimaryStatus.REMOVED.
`AD_GROUP_INCOMPLETE`	La construction de ce groupe d'annonces n'est pas encore terminée. Contribue à GroupPrimaryStatus.NOT_ELIGIBLE.
`KEYWORDS_PAUSED`	Les états des mots clés spécifiés par l'utilisateur dans ce groupe d'annonces ont tous été mis en veille. Contribue à GroupPrimaryStatus.NOT_ELIGIBLE.
`NO_KEYWORDS`	Ce groupe d'annonces ne contient aucun mot clé éligible. Contribue à GroupPrimaryStatus.NOT_ELIGIBLE.
`AD_GROUP_ADS_PAUSED`	Les états des annonces de groupe d'annonces spécifiés par l'utilisateur de ce groupe d'annonces sont tous mis en veille. Contribue à GroupPrimaryStatus.NOT_ELIGIBLE.
`NO_AD_GROUP_ADS`	Ce groupe d'annonces ne contient aucune annonce éligible. Contribue à GroupPrimaryStatus.NOT_ELIGIBLE.
`HAS_ADS_DISAPPROVED`	Motif de l'état de conformité avec les règles lorsqu'au moins une annonce est refusée. Contribue à plusieurs éléments GroupPrimaryStatus.
`HAS_ADS_LIMITED_BY_POLICY`	Motif de l'état de conformité avec les règles lorsqu'au moins une annonce est limitée conformément au règlement. Contribue à plusieurs éléments GroupPrimaryStatus.
`MOST_ADS_UNDER_REVIEW`	Motif de l'état de conformité avec les règles lorsque la plupart des annonces sont en attente d'examen. Contribue à GROUPPrimaryStatus.PENDING.
`CAMPAIGN_DRAFT`	Le groupe d'annonces appartient à une campagne brouillon. Contribue à GroupPrimaryStatus.NOT_ELIGIBLE.
`AD_GROUP_PAUSED_DUE_TO_LOW_ACTIVITY`	Le groupe d'annonces a été mis en veille en raison d'une faible activité prolongée de manière prolongée. Contribue à GroupePrimaryStatus.PAUSE.