Updates an existing account.

Scopes

You will need authorization for the https://www.googleapis.com/auth/dfatrafficking scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/dfatrafficking. You can set the scope for this method like this: dfareporting3 --scope <scope> accounts update ...

Required Scalar Argument

  • <profile-id> (string)
    • User profile ID associated with this request.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Account:
  account-permission-ids: [string]
  account-profile: string
  active: boolean
  active-ads-limit-tier: string
  active-view-opt-out: boolean
  available-permission-ids: [string]
  country-id: string
  currency-id: string
  default-creative-size-id: string
  description: string
  id: string
  kind: string
  locale: string
  maximum-image-size: string
  name: string
  nielsen-ocr-enabled: boolean
  reports-configuration:
    exposure-to-conversion-enabled: boolean
    lookback-configuration:
      click-duration: integer
      post-impression-activities-duration: integer
    report-generation-time-zone-id: string
  share-reports-with-twitter: boolean
  teaser-size-limit: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . account-permission-ids=sed
    • Account permissions assigned to this account.
    • Each invocation of this argument appends the given value to the array.
  • account-profile=diam
    • Profile for this account. This is a read-only field that can be left blank.
  • active=true
    • Whether this account is active.
  • active-ads-limit-tier=et
    • Maximum number of active ads allowed for this account.
  • active-view-opt-out=false
    • Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
  • available-permission-ids=no
    • User role permissions available to the user roles of this account.
    • Each invocation of this argument appends the given value to the array.
  • country-id=et
    • ID of the country associated with this account.
  • currency-id=elitr
    • ID of currency associated with this account. This is a required field. Acceptable values are:
      • "1" for USD
      • "2" for GBP
      • "3" for ESP
      • "4" for SEK
      • "5" for CAD
      • "6" for JPY
      • "7" for DEM
      • "8" for AUD
      • "9" for FRF
      • "10" for ITL
      • "11" for DKK
      • "12" for NOK
      • "13" for FIM
      • "14" for ZAR
      • "15" for IEP
      • "16" for NLG
      • "17" for EUR
      • "18" for KRW
      • "19" for TWD
      • "20" for SGD
      • "21" for CNY
      • "22" for HKD
      • "23" for NZD
      • "24" for MYR
      • "25" for BRL
      • "26" for PTE
      • "27" for MXP
      • "28" for CLP
      • "29" for TRY
      • "30" for ARS
      • "31" for PEN
      • "32" for ILS
      • "33" for CHF
      • "34" for VEF
      • "35" for COP
      • "36" for GTQ
      • "37" for PLN
      • "39" for INR
      • "40" for THB
      • "41" for IDR
      • "42" for CZK
      • "43" for RON
      • "44" for HUF
      • "45" for RUB
      • "46" for AED
      • "47" for BGN
      • "48" for HRK
      • "49" for MXN
      • "50" for NGN
  • default-creative-size-id=sed
    • Default placement dimensions for this account.
  • description=no
    • Description of this account.
  • id=nonumy
    • ID of this account. This is a read-only, auto-generated field.
  • kind=at
    • Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
  • locale=sadipscing
    • Locale of this account. Acceptable values are:
      • "cs" (Czech)
      • "de" (German)
      • "en" (English)
      • "en-GB" (English United Kingdom)
      • "es" (Spanish)
      • "fr" (French)
      • "it" (Italian)
      • "ja" (Japanese)
      • "ko" (Korean)
      • "pl" (Polish)
      • "pt-BR" (Portuguese Brazil)
      • "ru" (Russian)
      • "sv" (Swedish)
      • "tr" (Turkish)
      • "zh-CN" (Chinese Simplified)
      • "zh-TW" (Chinese Traditional)
  • maximum-image-size=aliquyam
    • Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.
  • name=dolores
    • Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
  • nielsen-ocr-enabled=false
    • Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
  • reports-configuration exposure-to-conversion-enabled=false
    • Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
  • lookback-configuration click-duration=54
    • Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.

  • post-impression-activities-duration=44

    • Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.

  • .. report-generation-time-zone-id=et

    • Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are:

      • "1" for "America/New_York"
      • "2" for "Europe/London"
      • "3" for "Europe/Paris"
      • "4" for "Africa/Johannesburg"
      • "5" for "Asia/Jerusalem"
      • "6" for "Asia/Shanghai"
      • "7" for "Asia/Hong_Kong"
      • "8" for "Asia/Tokyo"
      • "9" for "Australia/Sydney"
      • "10" for "Asia/Dubai"
      • "11" for "America/Los_Angeles"
      • "12" for "Pacific/Auckland"
      • "13" for "America/Sao_Paulo"

  • .. share-reports-with-twitter=false

    • Share Path to Conversion reports with Twitter.
  • teaser-size-limit=consetetur
    • File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p alt=string

    • Data format for the response.

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • -p user-ip=string

    • Deprecated. Please use quotaUser instead.