Google Campaign Manager Campaign Manager Cities API

openapi: 3.2.0
info:
  title: Campaign Manager 360 Cities API
  version: v5
  description: Generated from Google's published Discovery document for Campaign Manager 360 API (dfareporting v5, revision 20261107). 1 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://dfareporting.googleapis.com
tags:
- name: Cities
paths:
  /dfareporting/v5/userprofiles/{userprofilesId}/cities:
    get:
      operationId: dfareporting.cities.list
      summary: List cities
      description: Retrieves a list of cities, possibly filtered.
      parameters:
      - name: userprofilesId
        in: path
        required: true
        description: Resource name segment (userprofilesId).
        schema:
          type: string
      - name: countryDartIds
        in: query
        required: false
        description: Select only cities from these countries.
        schema:
          type: array
          items:
            type: string
            format: int64
      - name: dartIds
        in: query
        required: false
        description: Select only cities with these DART IDs.
        schema:
          type: array
          items:
            type: string
            format: int64
      - name: namePrefix
        in: query
        required: false
        description: Select only cities with names starting with this prefix.
        schema:
          type: string
      - name: regionDartIds
        in: query
        required: false
        description: Select only cities from these regions.
        schema:
          type: array
          items:
            format: int64
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CitiesListResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/dfatrafficking
      - apiKey: []
      tags:
      - Cities
components:
  schemas:
    City:
      description: Contains information about a city that can be targeted by ads.
      type: object
      properties:
        regionCode:
          type: string
          description: Region code of the region to which this city belongs.
        countryDartId:
          format: int64
          description: DART ID of the country to which this city belongs.
          type: string
        metroDmaId:
          type: string
          format: int64
          description: ID of the metro region (DMA) to which this city belongs.
        regionDartId:
          description: DART ID of the region to which this city belongs.
          format: int64
          type: string
        metroCode:
          type: string
          description: Metro region code of the metro region (DMA) to which this city belongs.
        dartId:
          type: string
          format: int64
          description: DART ID of this city. This is the ID used for targeting and generating reports.
        countryCode:
          type: string
          description: Country code of the country to which this city belongs.
        name:
          type: string
          description: Name of this city.
        kind:
          description: 'Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".'
          type: string
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    CitiesListResponse:
      description: City List Response
      type: object
      properties:
        kind:
          type: string
          description: 'Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".'
        cities:
          items:
            $ref: '#/components/schemas/City'
          type: array
          description: City collection.
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/ddmconversions: Manage DoubleClick Digital Marketing conversions
            https://www.googleapis.com/auth/dfatrafficking: View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
            https://www.googleapis.com/auth/dfareporting: View and manage DoubleClick for Advertisers reports
externalDocs:
  url: https://developers.google.com/doubleclick-advertisers/
x-provenance:
  method: harvested
  publisher: Google
  source: https://dfareporting.googleapis.com/$discovery/rest?version=v5
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261107)