Documentation

Overview

Package displayvideo provides access to the Display & Video 360 API.

For product documentation, see: https://developers.google.com/display-video/

Creating a client

Usage example:

import "google.golang.org/api/displayvideo/v1"
...
ctx := context.Background()
displayvideoService, err := displayvideo.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

displayvideoService, err := displayvideo.NewService(ctx, option.WithScopes(displayvideo.DoubleclickbidmanagerScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

displayvideoService, err := displayvideo.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
displayvideoService, err := displayvideo.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// Create, see, edit, and permanently delete your Display & Video 360
	// entities and reports
	DisplayVideoScope = "https://www.googleapis.com/auth/display-video"

	// Create, see, and edit Display & Video 360 Campaign entities and see
	// billing invoices
	DisplayVideoMediaplanningScope = "https://www.googleapis.com/auth/display-video-mediaplanning"

	// New Service:
	// https://www.googleapis.com/auth/display-video-user-management
	DisplayVideoUserManagementScope = "https://www.googleapis.com/auth/display-video-user-management"

	// View and manage your reports in DoubleClick Bid Manager
	DoubleclickbidmanagerScope = "https://www.googleapis.com/auth/doubleclickbidmanager"
)

    OAuth2 scopes used by this API.

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type ActivateManualTriggerRequest

    type ActivateManualTriggerRequest struct {
    }

      ActivateManualTriggerRequest: Request message for ManualTriggerService.ActivateManualTrigger.

      type ActiveViewVideoViewabilityMetricConfig

      type ActiveViewVideoViewabilityMetricConfig struct {
      	// DisplayName: Required. The display name of the custom metric.
      	DisplayName string `json:"displayName,omitempty"`
      
      	// MinimumDuration: The minimum visible video duration required (in
      	// seconds) in order for an impression to be recorded. You must specify
      	// minimum_duration, minimum_quartile or both. If both are specified, an
      	// impression meets the metric criteria if either requirement is met
      	// (whichever happens first).
      	//
      	// Possible values:
      	//   "VIDEO_DURATION_UNSPECIFIED" - Value is not specified or is unknown
      	// in this version.
      	//   "VIDEO_DURATION_SECONDS_NONE" - No duration value.
      	//   "VIDEO_DURATION_SECONDS_0" - 0 seconds.
      	//   "VIDEO_DURATION_SECONDS_1" - 1 second.
      	//   "VIDEO_DURATION_SECONDS_2" - 2 seconds.
      	//   "VIDEO_DURATION_SECONDS_3" - 3 seconds.
      	//   "VIDEO_DURATION_SECONDS_4" - 4 seconds.
      	//   "VIDEO_DURATION_SECONDS_5" - 5 seconds.
      	//   "VIDEO_DURATION_SECONDS_6" - 6 seconds.
      	//   "VIDEO_DURATION_SECONDS_7" - 7 seconds.
      	//   "VIDEO_DURATION_SECONDS_8" - 8 seconds.
      	//   "VIDEO_DURATION_SECONDS_9" - 9 seconds.
      	//   "VIDEO_DURATION_SECONDS_10" - 10 seconds.
      	//   "VIDEO_DURATION_SECONDS_11" - 11 seconds.
      	//   "VIDEO_DURATION_SECONDS_12" - 12 seconds.
      	//   "VIDEO_DURATION_SECONDS_13" - 13 seconds.
      	//   "VIDEO_DURATION_SECONDS_14" - 14 seconds.
      	//   "VIDEO_DURATION_SECONDS_15" - 15 seconds.
      	//   "VIDEO_DURATION_SECONDS_30" - 30 seconds.
      	//   "VIDEO_DURATION_SECONDS_45" - 45 seconds.
      	//   "VIDEO_DURATION_SECONDS_60" - 60 seconds.
      	MinimumDuration string `json:"minimumDuration,omitempty"`
      
      	// MinimumQuartile: The minimum visible video duration required, based
      	// on the video quartiles, in order for an impression to be recorded.
      	// You must specify minimum_duration, minimum_quartile or both. If both
      	// are specified, an impression meets the metric criteria if either
      	// requirement is met (whichever happens first).
      	//
      	// Possible values:
      	//   "VIDEO_DURATION_QUARTILE_UNSPECIFIED" - Value is not specified or
      	// is unknown in this version.
      	//   "VIDEO_DURATION_QUARTILE_NONE" - No quartile value.
      	//   "VIDEO_DURATION_QUARTILE_FIRST" - First quartile.
      	//   "VIDEO_DURATION_QUARTILE_SECOND" - Second quartile (midpoint).
      	//   "VIDEO_DURATION_QUARTILE_THIRD" - Third quartile.
      	//   "VIDEO_DURATION_QUARTILE_FOURTH" - Fourth quartile (completion).
      	MinimumQuartile string `json:"minimumQuartile,omitempty"`
      
      	// MinimumViewability: Required. The minimum percentage of the video
      	// ad's pixels visible on the screen in order for an impression to be
      	// recorded.
      	//
      	// Possible values:
      	//   "VIEWABILITY_PERCENT_UNSPECIFIED" - Value is not specified or is
      	// unknown in this version.
      	//   "VIEWABILITY_PERCENT_0" - 0% viewable.
      	//   "VIEWABILITY_PERCENT_25" - 25% viewable.
      	//   "VIEWABILITY_PERCENT_50" - 50% viewable.
      	//   "VIEWABILITY_PERCENT_75" - 75% viewable.
      	//   "VIEWABILITY_PERCENT_100" - 100% viewable.
      	MinimumViewability string `json:"minimumViewability,omitempty"`
      
      	// MinimumVolume: Required. The minimum percentage of the video ad's
      	// volume required in order for an impression to be recorded.
      	//
      	// Possible values:
      	//   "VIDEO_VOLUME_PERCENT_UNSPECIFIED" - Value is not specified or is
      	// unknown in this version.
      	//   "VIDEO_VOLUME_PERCENT_0" - 0% volume.
      	//   "VIDEO_VOLUME_PERCENT_10" - 10% volume.
      	MinimumVolume string `json:"minimumVolume,omitempty"`
      
      	// ForceSendFields is a list of field names (e.g. "DisplayName") to
      	// unconditionally include in API requests. By default, fields with
      	// empty values are omitted from API requests. However, any non-pointer,
      	// non-interface field appearing in ForceSendFields will be sent to the
      	// server regardless of whether the field is empty or not. This may be
      	// used to include empty fields in Patch requests.
      	ForceSendFields []string `json:"-"`
      
      	// NullFields is a list of field names (e.g. "DisplayName") to include
      	// in API requests with the JSON null value. By default, fields with
      	// empty values are omitted from API requests. However, any field with
      	// an empty value appearing in NullFields will be sent to the server as
      	// null. It is an error if a field in this list has a non-empty value.
      	// This may be used to include null fields in Patch requests.
      	NullFields []string `json:"-"`
      }

        ActiveViewVideoViewabilityMetricConfig: Configuration for custom Active View video viewability metrics.

        func (*ActiveViewVideoViewabilityMetricConfig) MarshalJSON

        func (s *ActiveViewVideoViewabilityMetricConfig) MarshalJSON() ([]byte, error)

        type Adloox

        type Adloox struct {
        	// ExcludedAdlooxCategories: Adloox's brand safety settings.
        	//
        	// Possible values:
        	//   "ADLOOX_UNSPECIFIED" - This enum is only a placeholder and it
        	// doesn't specify any Adloox option.
        	//   "ADULT_CONTENT_HARD" - Adult content (hard).
        	//   "ADULT_CONTENT_SOFT" - Adult content (soft).
        	//   "ILLEGAL_CONTENT" - Illegal content.
        	//   "BORDERLINE_CONTENT" - Borderline content.
        	//   "DISCRIMINATORY_CONTENT" - Discriminatory content.
        	//   "VIOLENT_CONTENT_WEAPONS" - Violent content & weapons.
        	//   "LOW_VIEWABILITY_DOMAINS" - Low viewability domains.
        	//   "FRAUD" - Fraud.
        	ExcludedAdlooxCategories []string `json:"excludedAdlooxCategories,omitempty"`
        
        	// ForceSendFields is a list of field names (e.g.
        	// "ExcludedAdlooxCategories") to unconditionally include in API
        	// requests. By default, fields with empty values are omitted from API
        	// requests. However, any non-pointer, non-interface field appearing in
        	// ForceSendFields will be sent to the server regardless of whether the
        	// field is empty or not. This may be used to include empty fields in
        	// Patch requests.
        	ForceSendFields []string `json:"-"`
        
        	// NullFields is a list of field names (e.g. "ExcludedAdlooxCategories")
        	// to include in API requests with the JSON null value. By default,
        	// fields with empty values are omitted from API requests. However, any
        	// field with an empty value appearing in NullFields will be sent to the
        	// server as null. It is an error if a field in this list has a
        	// non-empty value. This may be used to include null fields in Patch
        	// requests.
        	NullFields []string `json:"-"`
        }

          Adloox: Details of Adloox settings.

          func (*Adloox) MarshalJSON

          func (s *Adloox) MarshalJSON() ([]byte, error)

          type Advertiser

          type Advertiser struct {
          	// AdServerConfig: Required. Immutable. Ad server related settings of
          	// the advertiser.
          	AdServerConfig *AdvertiserAdServerConfig `json:"adServerConfig,omitempty"`
          
          	// AdvertiserId: Output only. The unique ID of the advertiser. Assigned
          	// by the system.
          	AdvertiserId