REST Resource: googleAdsFields

Ressource: GoogleAdsField

Champ ou ressource (artefact) utilisé par GoogleAdsService.

Représentation JSON
{
  "resourceName": string,
  "category": enum (GoogleAdsFieldCategory),
  "selectableWith": [
    string
  ],
  "attributeResources": [
    string
  ],
  "metrics": [
    string
  ],
  "segments": [
    string
  ],
  "enumValues": [
    string
  ],
  "dataType": enum (GoogleAdsFieldDataType),
  "name": string,
  "selectable": boolean,
  "filterable": boolean,
  "sortable": boolean,
  "typeUrl": string,
  "isRepeated": boolean
}
Champs
resourceName

string

Uniquement en sortie. Nom de ressource de l'artefact. Les noms des ressources d'artefact se présentent sous la forme suivante:

googleAdsFields/{name}

category

enum (GoogleAdsFieldCategory)

Uniquement en sortie. Catégorie de l'artefact.

selectableWith[]

string

Uniquement en sortie. Noms de toutes les ressources, segments et métriques sélectionnables avec l'artefact décrit.

attributeResources[]

string

Uniquement en sortie. Noms de toutes les ressources sélectionnables avec l'artefact décrit. Les champs de ces ressources ne segmentent pas les statistiques lorsqu'ils sont inclus dans des requêtes de recherche.

Ce champ n'est défini que pour les artefacts dont la catégorie est RESOURCE.

metrics[]

string

Uniquement en sortie. Ce champ répertorie les noms de toutes les métriques sélectionnables avec l'artefact décrit lorsqu'il est utilisé dans la clause FROM. Il n'est défini que pour les artefacts dont la catégorie est RESOURCE.

segments[]

string

Uniquement en sortie. Ce champ répertorie les noms de tous les artefacts, qu'il s'agisse d'un segment ou d'une autre ressource, qui segmentent les métriques lorsqu'elles sont incluses dans les requêtes de recherche et lorsque l'artefact décrit est utilisé dans la clause FROM. Il n'est défini que pour les artefacts dont la catégorie est RESOURCE.

enumValues[]

string

Uniquement en sortie. Valeurs que l'artefact peut supposer s'il s'agit d'un champ de type ENUM.

Ce champ n'est défini que pour les artefacts de la catégorie SEGMENT ou ATTRIBUTE.

dataType

enum (GoogleAdsFieldDataType)

Uniquement en sortie. Ce champ détermine les opérateurs pouvant être utilisés avec l'artefact dans les clauses WHERE.

name

string

Uniquement en sortie. Nom de l'artefact.

selectable

boolean

Uniquement en sortie. Indique si l'artefact peut être utilisé dans une clause SELECT dans les requêtes de recherche.

filterable

boolean

Uniquement en sortie. Indique si l'artefact peut être utilisé dans une clause WHERE dans les requêtes de recherche.

sortable

boolean

Uniquement en sortie. Indique si l'artefact peut être utilisé dans une clause ORDER BY dans les requêtes de recherche.

typeUrl

string

Uniquement en sortie. URL du fichier proto décrivant le type de données de l'artefact.

isRepeated

boolean

Uniquement en sortie. Indique si l'artefact de champ est répété.

GoogleAdsFieldCategory

Catégorie de l'artefact.

Enums
UNSPECIFIED Non spécifiée
UNKNOWN Inconnu
RESOURCE L'artefact décrit est une ressource.
ATTRIBUTE L'artefact décrit est un champ et un attribut d'une ressource. L'inclusion d'un champ d'attribut de ressource dans une requête peut segmenter la requête si la ressource à laquelle elle est attribuée segmente la ressource trouvée dans la clause FROM.
SEGMENT L'artefact décrit est un champ et segmente toujours les requêtes de recherche.
METRIC L'artefact décrit est un champ et une métrique. Il ne segmente jamais les requêtes de recherche.

GoogleAdsFieldDataType

Voici les différents types qu'un artefact GoogleAdsService peut prendre.

Enums
UNSPECIFIED Non spécifiée
UNKNOWN Inconnu
BOOLEAN

Correspond à google.protobuf.BoolValue

Opérateurs applicables: =, !=

DATE

Correspond à google.protobuf.StringValue. Cependant, il est possible de le comparer à l'aide de l'ensemble d'opérateurs propres aux dates.

Opérateurs applicables: =, <, >, <=, >=, BETWEEN, DURING et IN

DOUBLE

Correspond à google.protobuf.DoubleValue

Opérateurs applicables: =, !=, <, >, IN, NOT IN

ENUM

Correspond à une énumération. Sa définition spécifique est disponible sur typeUrl.

Opérateurs applicables: =, !=, IN, NOT IN

FLOAT

Correspond à google.protobuf.FloatValue

Opérateurs applicables: =, !=, <, >, IN, NOT IN

INT32

Correspond à google.protobuf.Int32Value

Opérateurs applicables: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN

INT64

Correspond à google.protobuf.Int64Value

Opérateurs applicables: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN

MESSAGE

Correspond à un type de message de tampon de protocole. Les détails du type de données se trouvent dans typeUrl.

Aucun opérateur n'est compatible avec les champs MESSAGE.

RESOURCE_NAME

Correspond à google.protobuf.StringValue. Représente le nom de ressource (identifiant unique) d'une ressource ou de l'une de ses clés étrangères.

Aucun opérateur n'est compatible avec les champs RESOURCE_NAME.

STRING

Correspond à google.protobuf.StringValue.

Opérateurs applicables: =, !=, LIKE, NOT LIKE, IN, NOT IN

UINT64

Correspond à google.protobuf.UInt64Value

Opérateurs applicables: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN

Méthodes

get

Renvoie uniquement le champ demandé.
Renvoie tous les champs correspondant à la requête de recherche.