Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.

Scopes

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

If unset, the scope for this method defaults to https://www.googleapis.com/auth/display-video. You can set the scope for this method like this: displayvideo1 --scope <scope> advertisers targeting-types-assigned-targeting-options-create ...

Required Scalar Arguments

  • <advertiser-id> (string)
    • Required. The ID of the advertiser.
  • <targeting-type> (string)
    • Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_OMID * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION

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:

AssignedTargetingOption:
  age-range-details:
    age-range: string
    targeting-option-id: string
  app-category-details:
    display-name: string
    negative: boolean
    targeting-option-id: string
  app-details:
    app-id: string
    app-platform: string
    display-name: string
    negative: boolean
  assigned-targeting-option-id: string
  audio-content-type-details:
    audio-content-type: string
    targeting-option-id: string
  authorized-seller-status-details:
    authorized-seller-status: string
    targeting-option-id: string
  browser-details:
    display-name: string
    negative: boolean
    targeting-option-id: string
  business-chain-details:
    display-name: string
    proximity-radius-amount: number
    proximity-radius-unit: string
    targeting-option-id: string
  carrier-and-isp-details:
    display-name: string
    negative: boolean
    targeting-option-id: string
  category-details:
    display-name: string
    negative: boolean
    targeting-option-id: string
  channel-details:
    channel-id: string
    negative: boolean
  content-duration-details:
    content-duration: string
    targeting-option-id: string
  content-genre-details:
    display-name: string
    negative: boolean
    targeting-option-id: string
  content-instream-position-details:
    ad-type: string
    content-instream-position: string
    targeting-option-id: string
  content-outstream-position-details:
    ad-type: string
    content-outstream-position: string
    targeting-option-id: string
  content-stream-type-details:
    content-stream-type: string
    targeting-option-id: string
  day-and-time-details:
    day-of-week: string
    end-hour: integer
    start-hour: integer
    time-zone-resolution: string
  device-make-model-details:
    display-name: string
    negative: boolean
    targeting-option-id: string
  device-type-details:
    device-type: string
    targeting-option-id: string
  digital-content-label-exclusion-details:
    content-rating-tier: string
    excluded-targeting-option-id: string
  environment-details:
    environment: string
    targeting-option-id: string
  exchange-details:
    targeting-option-id: string
  gender-details:
    gender: string
    targeting-option-id: string
  geo-region-details:
    display-name: string
    geo-region-type: string
    negative: boolean
    targeting-option-id: string
  household-income-details:
    household-income: string
    targeting-option-id: string
  inheritance: string
  inventory-source-details:
    inventory-source-id: string
  inventory-source-group-details:
    inventory-source-group-id: string
  keyword-details:
    keyword: string
    negative: boolean
  language-details:
    display-name: string
    negative: boolean
    targeting-option-id: string
  name: string
  native-content-position-details:
    content-position: string
    targeting-option-id: string
  negative-keyword-list-details:
    negative-keyword-list-id: string
  omid-details:
    omid: string
    targeting-option-id: string
  on-screen-position-details:
    ad-type: string
    on-screen-position: string
    targeting-option-id: string
  operating-system-details:
    display-name: string
    negative: boolean
    targeting-option-id: string
  parental-status-details:
    parental-status: string
    targeting-option-id: string
  poi-details:
    display-name: string
    latitude: number
    longitude: number
    proximity-radius-amount: number
    proximity-radius-unit: string
    targeting-option-id: string
  proximity-location-list-details:
    proximity-location-list-id: string
    proximity-radius-range: string
  regional-location-list-details:
    negative: boolean
    regional-location-list-id: string
  sensitive-category-exclusion-details:
    excluded-targeting-option-id: string
    sensitive-category: string
  sub-exchange-details:
    targeting-option-id: string
  targeting-type: string
  third-party-verifier-details:
    adloox:
      excluded-adloox-categories: [string]
    double-verify:
      app-star-rating:
        avoid-insufficient-star-rating: boolean
        avoided-star-rating: string
      avoided-age-ratings: [string]
      brand-safety-categories:
        avoid-unknown-brand-safety-category: boolean
        avoided-high-severity-categories: [string]
        avoided-medium-severity-categories: [string]
      custom-segment-id: string
      display-viewability:
        iab: string
        viewable-during: string
      fraud-invalid-traffic:
        avoid-insufficient-option: boolean
        avoided-fraud-option: string
      video-viewability:
        player-impression-rate: string
        video-iab: string
        video-viewable-rate: string
    integral-ad-science:
      custom-segment-id: [string]
      display-viewability: string
      exclude-unrateable: boolean
      excluded-ad-fraud-risk: string
      excluded-adult-risk: string
      excluded-alcohol-risk: string
      excluded-drugs-risk: string
      excluded-gambling-risk: string
      excluded-hate-speech-risk: string
      excluded-illegal-downloads-risk: string
      excluded-offensive-language-risk: string
      excluded-violence-risk: string
      traq-score-option: string
      video-viewability: string
  url-details:
    negative: boolean
    url: string
  user-rewarded-content-details:
    targeting-option-id: string
    user-rewarded-content: string
  video-player-size-details:
    targeting-option-id: string
    video-player-size: string
  viewability-details:
    targeting-option-id: string
    viewability: 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 .age-range-details age-range=sed
    • Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
  • targeting-option-id=no

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_AGE_RANGE.
  • ..app-category-details display-name=sit

    • Output only. The display name of the app category.
  • negative=false
    • Indicates if this option is being negatively targeted.
  • targeting-option-id=et

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_APP_CATEGORY.
  • ..app-details app-id=consetetur

    • Required. The ID of the app. Android's Play store app uses bundle ID, for example com.google.android.gm. Apple's App store app ID uses 9 digit string, for example 422689480.
  • app-platform=at
    • Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
  • display-name=et
    • Output only. The display name of the app.
  • negative=false

    • Indicates if this option is being negatively targeted.
  • .. assigned-targeting-option-id=voluptua.

    • Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
  • audio-content-type-details audio-content-type=kasd
    • Required. The audio content type.
  • targeting-option-id=no

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_AUDIO_CONTENT_TYPE.
  • ..authorized-seller-status-details authorized-seller-status=amet.

    • Output only. The authorized seller status to target.
  • targeting-option-id=aliquyam

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_AUTHORIZED_SELLER_STATUS.
  • ..browser-details display-name=accusam

    • Output only. The display name of the browser.
  • negative=true
    • Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
  • targeting-option-id=duo

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_BROWSER.
  • ..business-chain-details display-name=kasd

    • Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
  • proximity-radius-amount=0.5941507496742189
    • Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is DISTANCE_UNIT_KILOMETERS and 1 to 500 if unit is DISTANCE_UNIT_MILES. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
  • proximity-radius-unit=kasd
    • Required. The unit of distance by which the targeting radius is measured.
  • targeting-option-id=sanctus

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_BUSINESS_CHAIN. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
  • ..carrier-and-isp-details display-name=gubergren

    • Output only. The display name of the carrier or ISP.
  • negative=true
    • Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
  • targeting-option-id=dolor

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_CARRIER_AND_ISP.
  • ..category-details display-name=sanctus

    • Output only. The display name of the category.
  • negative=false
    • Indicates if this option is being negatively targeted.
  • targeting-option-id=amet

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_CATEGORY.
  • ..channel-details channel-id=magna

  • negative=true

    • Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
  • ..content-duration-details content-duration=tempor

    • Output only. The content duration.
  • targeting-option-id=consetetur

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_CONTENT_DURATION.
  • ..content-genre-details display-name=amet

    • Output only. The display name of the content genre.
  • negative=true
    • Indicates if this option is being negatively targeted.
  • targeting-option-id=et

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_CONTENT_GENRE.
  • ..content-instream-position-details ad-type=elitr

    • Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * AD_TYPE_VIDEO, the setting will be inherited by new line item when line_item_type is LINE_ITEM_TYPE_VIDEO_DEFAULT. * AD_TYPE_AUDIO, the setting will be inherited by new line item when line_item_type is LINE_ITEM_TYPE_AUDIO_DEFAULT.
  • content-instream-position=dolor
    • Required. The content instream position for video or audio ads.
  • targeting-option-id=duo

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_CONTENT_INSTREAM_POSITION.
  • ..content-outstream-position-details ad-type=diam

    • Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * AD_TYPE_DISPLAY, the setting will be inherited by new line item when line_item_type is LINE_ITEM_TYPE_DISPLAY_DEFAULT. * AD_TYPE_VIDEO, the setting will be inherited by new line item when line_item_type is LINE_ITEM_TYPE_VIDEO_DEFAULT.
  • content-outstream-position=et
    • Required. The content outstream position.
  • targeting-option-id=lorem

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION.
  • ..content-stream-type-details content-stream-type=no

    • Output only. The content stream type.
  • targeting-option-id=sea

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_CONTENT_STREAM_TYPE.
  • ..day-and-time-details day-of-week=et

    • Required. The day of the week for this day and time targeting setting.
  • end-hour=23
    • Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
  • start-hour=51
    • Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
  • time-zone-resolution=ea

    • Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
  • ..device-make-model-details display-name=ipsum

    • Output only. The display name of the device make and model.
  • negative=true
    • Indicates if this option is being negatively targeted.
  • targeting-option-id=dolores

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_DEVICE_MAKE_MODEL.
  • ..device-type-details device-type=elitr

    • Required. The display name of the device type.
  • targeting-option-id=diam

    • Required. ID of the device type.
  • ..digital-content-label-exclusion-details content-rating-tier=sed

    • Output only. The display name of the digital content label rating tier.
  • excluded-targeting-option-id=lorem

    • Required. ID of the digital content label to be EXCLUDED.
  • ..environment-details environment=magna

    • Required. The serving environment.
  • targeting-option-id=duo

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_ENVIRONMENT (e.g., "508010" for targeting the ENVIRONMENT_WEB_OPTIMIZED option).
  • ..exchange-details targeting-option-id=et

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_EXCHANGE.
  • ..gender-details gender=no

    • Required. The gender of the audience.
  • targeting-option-id=sadipscing

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_GENDER.
  • ..geo-region-details display-name=sit

    • Output only. The display name of the geographic region (e.g., "Ontario, Canada").
  • geo-region-type=duo
    • Output only. The type of geographic region targeting.
  • negative=true
    • Indicates if this option is being negatively targeted.
  • targeting-option-id=diam

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_GEO_REGION.
  • ..household-income-details household-income=accusam

    • Required. The household income of the audience.
  • targeting-option-id=dolore

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_HOUSEHOLD_INCOME.
  • .. inheritance=eirmod

    • Output only. The inheritance status of the assigned targeting option.
  • inventory-source-details inventory-source-id=lorem

    • Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
  • ..inventory-source-group-details inventory-source-group-id=ut

    • Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
  • ..keyword-details keyword=est

    • Required. The keyword, for example car insurance. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
  • negative=false

    • Indicates if this option is being negatively targeted.
  • ..language-details display-name=sit

    • Output only. The display name of the language (e.g., "French").
  • negative=false
    • Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
  • targeting-option-id=amet.

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_LANGUAGE.
  • .. name=et

    • Output only. The resource name for this assigned targeting option.
  • native-content-position-details content-position=ut
    • Required. The content position.
  • targeting-option-id=et

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_NATIVE_CONTENT_POSITION.
  • ..negative-keyword-list-details negative-keyword-list-id=et

    • Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
  • ..omid-details omid=at

    • Required. The type of Open Measurement enabled inventory.
  • targeting-option-id=sed

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_OMID.
  • ..on-screen-position-details ad-type=stet

    • Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * AD_TYPE_DISPLAY, the setting will be inherited by new line item when line_item_type is LINE_ITEM_TYPE_DISPLAY_DEFAULT. * AD_TYPE_VIDEO, the setting will be inherited by new line item when line_item_type is LINE_ITEM_TYPE_VIDEO_DEFAULT.
  • on-screen-position=sadipscing
    • Output only. The on screen position.
  • targeting-option-id=voluptua.

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_ON_SCREEN_POSITION.
  • ..operating-system-details display-name=et

    • Output only. The display name of the operating system.
  • negative=false
    • Indicates if this option is being negatively targeted.
  • targeting-option-id=rebum.

    • Required. The targeting option ID populated in targeting_option_id field when targeting_type is TARGETING_TYPE_OPERATING_SYSTEM.
  • ..parental-status-details parental-status=sanctus

    • Required. The parental status of the audience.
  • targeting-option-id=no

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_PARENTAL_STATUS.
  • ..poi-details display-name=stet

    • Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
  • latitude=0.46122926029538813
    • Output only. Latitude of the POI rounding to 6th decimal place.
  • longitude=0.5971692543729825
    • Output only. Longitude of the POI rounding to 6th decimal place.
  • proximity-radius-amount=0.5800491201559994
    • Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is DISTANCE_UNIT_KILOMETERS and 1 to 500 if unit is DISTANCE_UNIT_MILES.
  • proximity-radius-unit=justo
    • Required. The unit of distance by which the targeting radius is measured.
  • targeting-option-id=justo

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_POI. Accepted POI targeting option IDs can be retrieved using targetingTypes.targetingOptions.search. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". Upon creation, this field value will be updated to append a semicolon and alphanumerical hash value if only latitude/longitude coordinates are provided.
  • ..proximity-location-list-details proximity-location-list-id=eirmod

    • Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is TARGETING_LOCATION_TYPE_PROXIMITY.
  • proximity-radius-range=duo

    • Required. Radius range for proximity location list. This represents the size of the area around a chosen location that will be targeted. All proximity location targeting under a single resource must have the same radius range value. Set this value to match any existing targeting. If updated, this field will change the radius range for all proximity targeting under the resource.
  • ..regional-location-list-details negative=false

    • Indicates if this option is being negatively targeted.
  • regional-location-list-id=eirmod

    • Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is TARGETING_LOCATION_TYPE_REGIONAL.
  • ..sensitive-category-exclusion-details excluded-targeting-option-id=sanctus

    • Required. ID of the sensitive category to be EXCLUDED.
  • sensitive-category=rebum.

    • Output only. An enum for the DV360 Sensitive category content classifier.
  • ..sub-exchange-details targeting-option-id=kasd

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_SUB_EXCHANGE.
  • .. targeting-type=voluptua.

    • Output only. Identifies the type of this assigned targeting option.
  • third-party-verifier-details.adloox excluded-adloox-categories=erat

    • Adloox's brand safety settings.
    • Each invocation of this argument appends the given value to the array.
  • ..double-verify.app-star-rating avoid-insufficient-star-rating=true

    • Avoid bidding on apps with insufficient star ratings.
  • avoided-star-rating=magna

    • Avoid bidding on apps with the star ratings.
  • .. avoided-age-ratings=gubergren

    • Avoid bidding on apps with the age rating.
    • Each invocation of this argument appends the given value to the array.
  • brand-safety-categories avoid-unknown-brand-safety-category=true
    • Unknown or unrateable.
  • avoided-high-severity-categories=aliquyam
    • Brand safety high severity avoidance categories.
    • Each invocation of this argument appends the given value to the array.
  • avoided-medium-severity-categories=diam

    • Brand safety medium severity avoidance categories.
    • Each invocation of this argument appends the given value to the array.
  • .. custom-segment-id=vero

    • The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
  • display-viewability iab=erat
    • Target web and app inventory to maximize IAB viewable rate.
  • viewable-during=dolore

    • Target web and app inventory to maximize 100% viewable duration.
  • ..fraud-invalid-traffic avoid-insufficient-option=true

    • Insufficient Historical Fraud & IVT Stats.
  • avoided-fraud-option=consetetur

    • Avoid Sites and Apps with historical Fraud & IVT.
  • ..video-viewability player-impression-rate=amet

    • Target inventory to maximize impressions with 400x300 or greater player size.
  • video-iab=magna
    • Target web inventory to maximize IAB viewable rate.
  • video-viewable-rate=sanctus

    • Target web inventory to maximize fully viewable rate.
  • ...integral-ad-science custom-segment-id=clita

    • The custom segment ID provided by Integral Ad Science. The ID must be between 1000001 and 1999999, inclusive.
    • Each invocation of this argument appends the given value to the array.
  • display-viewability=invidunt
    • Display Viewability section (applicable to display line items only).
  • exclude-unrateable=true
    • Brand Safety - Unrateable.
  • excluded-ad-fraud-risk=sanctus
    • Ad Fraud settings.
  • excluded-adult-risk=invidunt
    • Brand Safety - Adult content.
  • excluded-alcohol-risk=sit
    • Brand Safety - Alcohol.
  • excluded-drugs-risk=sed
    • Brand Safety - Drugs.
  • excluded-gambling-risk=duo
    • Brand Safety - Gambling.
  • excluded-hate-speech-risk=et
    • Brand Safety - Hate speech.
  • excluded-illegal-downloads-risk=dolor
    • Brand Safety - Illegal downloads.
  • excluded-offensive-language-risk=et
    • Brand Safety - Offensive language.
  • excluded-violence-risk=sed
    • Brand Safety - Violence.
  • traq-score-option=justo
    • True advertising quality (applicable to Display line items only).
  • video-viewability=sadipscing

    • Video Viewability Section (applicable to video line items only).
  • ...url-details negative=false

    • Indicates if this option is being negatively targeted.
  • url=takimata

    • Required. The URL, for example example.com. DV360 supports two levels of subdirectory targeting, for example www.example.com/one-subdirectory-level/second-level, and five levels of subdomain targeting, for example five.four.three.two.one.example.com.
  • ..user-rewarded-content-details targeting-option-id=invidunt

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_USER_REWARDED_CONTENT.
  • user-rewarded-content=invidunt

    • Output only. User rewarded content status for video ads.
  • ..video-player-size-details targeting-option-id=gubergren

    • Required. The targeting_option_id field when targeting_type is TARGETING_TYPE_VIDEO_PLAYER_SIZE.
  • video-player-size=sed

    • Required. The video player size.
  • ..viewability-details targeting-option-id=justo

    • Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_VIEWABILITY (e.g., "509010" for targeting the VIEWABILITY_10_PERCENT_OR_MORE option).
  • viewability=amet
    • Required. The predicted viewability percentage.

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 $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -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

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").