Package google.ads.dai.v1

Index

• PartnerDiscoveryService (interface)
• CreateCreativeOperationMetadata (message)
• CreateCreativeRequest (message)
• Creative (message)
• DeleteCreativeRequest (message)
• DynamicCreativeInfo (message)
• FailureReason (message)
• FailureReason.Reason (enum)
• GetCreativeRequest (message)
• IngestionStatus (message)
• IngestionStatus.State (enum)
• MediaFile (message)
• MediaFile.Delivery (enum)

PartnerDiscoveryService

Manages DAI ingestion and YouTube upload of creatives.

CreateCreative
rpc CreateCreative(CreateCreativeRequest) returns (Operation) Creates a Creative. Returns a Creative in the response field when it completes successfully, or a google.rpc.Code upon failure. Returns CreateCreativeOperationMetadata including the status of ingestion in the metadata field.

DeleteCreative
rpc DeleteCreative(DeleteCreativeRequest) returns (Empty) Deletes a Creative.

GetCreative
rpc GetCreative(GetCreativeRequest) returns (Creative) Gets a Creative.

CreateCreativeOperationMetadata

Metadata for long running operation returned by CreateCreative. Present as metadata.

Fields
creative_url	string The URL of the creative that was used for ingest. This is the selected mezzanine URL or media rendition URL, which was chosen based on the properties provided in the request.
gv_registry_id	string A unique identifier for the video creative, if ingest is successful. The name of the Creative resource is creatives/gv_registry_id.
create_time	Timestamp Time that ingest request was created.
youtube_status	IngestionStatus Current YouTube ingest status.

CreateCreativeRequest

Request for PartnerDiscoveryService.CreateCreative.

Fields
creative	Creative The creative to be ingested.
dynamic_creative_info	DynamicCreativeInfo Information about the dynamic creative. Required if the creative to be ingested is dynamic.

Creative

A Creative resource. Present as response upon completion of PartnerDiscoveryService.CreateCreative.

Fields
name	string Output only. The unique name (Google Video ID) of the Creative resource, in the format creatives/id.
advertiser	string The name of the advertiser featured in this creative.
ad_system	string Required. The name of ad system generating the ingest request.
ad_title	string The title of the advertisement.
ad_description	string The description of the advertisement.
mezzanines[]	MediaFile The ad's mezzanine file URLs and their properties. At least one of mezannines or media_files is required.
media_files[]	MediaFile The ad's media file URLs and their properties. At least one of mezannines or media_files is required.
network_code	string Optional. The Google Ad Manager network code of the publisher for which the creative is intended. Required if the creative is dynamic and has DynamicCreativeInfo populated in the CreateCreativeRequest.

DeleteCreativeRequest

Request for PartnerDiscoveryService.DeleteCreative.

Fields
name	string The creative Google Video ID to be deleted.

DynamicCreativeInfo

Information necessary for a dynamic creative to perform VCL processing.

Fields
dynamic_group_id	string An ID that represents the core video ad of the creative. All dynamic creatives under the same dynamic group id can be considered to have the same content but with different dynamic aspects to the creative.
active_duration	Duration The duration for which this creative is considered active and in use for. After this time, the creative will be scheduled for deletion in the video creative repository. The duration will be capped at 180 days. If this field is left unspecified, a default duration time of 30 days will be applied.

FailureReason

Reason for creative ingest failure.

Fields
reason	Reason Description of creative ingest failure.
code	int32 HTTP status code of failure if reason is DOWNLOAD_ERROR.

Reason

Possible reasons for creative ingest failure.

Enums
REASON_UNSPECIFIED	Default value.
DOWNLOAD_ERROR	HTTP download failed.
INTERNAL_ERROR	Internal error.
INVALID_MEDIA	Invalid media.

GetCreativeRequest

Request for PartnerDiscoveryService.GetCreative.

Fields
name	string The creative Google Video ID.

IngestionStatus

The ingest status of the Create Creative request.

Fields
state	State The current ingest state of a video creative.
failure_reason	FailureReason The reason the creative failed to be ingested, if ingest fails.
update_time	Timestamp The time the ingest job was last updated.

State

Ingest state.

Enums
STATE_UNSPECIFIED	Default value.
PROCESSING	Video creative is still processing.
SUCCESS	Video creative successfully completed processing.
FAILURE	Video creative failed to be ingested, see FailureReason.

MediaFile

The properties related to a given media file.

Fields
uri	string Required. The unique URL to the creative's media file.
delivery	Delivery Required. The delivery type of the creative.
height	int32 The native height of video file, in pixels.
width	int32 The native width of video file, in pixels.
mime_type	string Required. The MIME type for the file container. Popular MIME types include “video/x-flv” for Flash Video and “video/mp4” for MP4.
min_bitrate	int32 The minimum bitrate of media file. For progressive load video, this value should be the average bitrate.
max_bitrate	int32 The maximum bitrate of media file. For progressive load video, this value should be the average bitrate.

Delivery

Delivery types.

Enums
DELIVERY_UNSPECIFIED	Default delivery value.
DELIVERY_PROGRESSIVE	Progressive video delivery.
DELIVERY_STREAMING	Streaming video delivery.