Search Ads 360 Reporting API . geoTargetConstants

close()

Close httplib2 connections.

suggest(body=None, x__xgafv=None)

Returns GeoTargetConstant suggestions by location name or by resource name. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [GeoTargetConstantSuggestionError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

Args:
  body: object, The request body.
    The object takes the form of:

{ # Request message for GeoTargetConstantService.SuggestGeoTargetConstants.
  "countryCode": "A String", # Returned geo targets are restricted to this country code.
  "geoTargets": { # A list of geo target constant resource names. # The geo target constant resource names to filter by.
    "geoTargetConstants": [ # A list of geo target constant resource names.
      "A String",
    ],
  },
  "locale": "A String", # If possible, returned geo targets are translated using this locale. If not, en is used by default. This is also used as a hint for returned geo targets.
  "locationNames": { # A list of location names. # The location names to search by. At most 25 names can be set.
    "names": [ # A list of location names.
      "A String",
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for GeoTargetConstantService.SuggestGeoTargetConstants.
  "geoTargetConstantSuggestions": [ # Geo target constant suggestions.
    { # A geo target constant suggestion.
      "geoTargetConstant": { # A geo target constant. # The GeoTargetConstant result.
        "canonicalName": "A String", # Output only. The fully qualified English name, consisting of the target's name and that of its parent and country.
        "countryCode": "A String", # Output only. The ISO-3166-1 alpha-2 country code that is associated with the target.
        "id": "A String", # Output only. The ID of the geo target constant.
        "name": "A String", # Output only. Geo target constant English name.
        "parentGeoTarget": "A String", # Output only. The resource name of the parent geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{parent_geo_target_constant_id}`
        "resourceName": "A String", # Output only. The resource name of the geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{geo_target_constant_id}`
        "status": "A String", # Output only. Geo target constant status.
        "targetType": "A String", # Output only. Geo target constant target type.
      },
      "geoTargetConstantParents": [ # The list of parents of the geo target constant.
        { # A geo target constant.
          "canonicalName": "A String", # Output only. The fully qualified English name, consisting of the target's name and that of its parent and country.
          "countryCode": "A String", # Output only. The ISO-3166-1 alpha-2 country code that is associated with the target.
          "id": "A String", # Output only. The ID of the geo target constant.
          "name": "A String", # Output only. Geo target constant English name.
          "parentGeoTarget": "A String", # Output only. The resource name of the parent geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{parent_geo_target_constant_id}`
          "resourceName": "A String", # Output only. The resource name of the geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{geo_target_constant_id}`
          "status": "A String", # Output only. Geo target constant status.
          "targetType": "A String", # Output only. Geo target constant target type.
        },
      ],
      "locale": "A String", # The language this GeoTargetConstantSuggestion is currently translated to. It affects the name of geo target fields. For example, if locale=en, then name=Spain. If locale=es, then name=España. The default locale will be returned if no translation exists for the locale in the request.
      "reach": "A String", # Approximate user population that will be targeted, rounded to the nearest 100.
      "searchTerm": "A String", # If the request searched by location name, this is the location name that matched the geo target.
    },
  ],
}