Package google.ads.drx.video.v1

Indice

AdBreakNotificationService

Un servizio API che consente ai publisher di creare interruzioni pubblicitarie durante un live streaming.

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

per creare un'interruzione pubblicitaria nel live streaming.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

ListAdBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

API per elencare le interruzioni pubblicitarie nel live streaming.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

VideoContentIngestionService

Servizio API per l'importazione di contenuti che consente di creare o aggiornare contenuti video e i metadati associati in Google Ad Manager.

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API per creare nuovi contenuti o aggiornare i relativi metadati se i contenuti esistono già in Ad Manager. Restituisce i contenuti in caso di esito positivo o google.rpc.Code in caso di esito negativo.

Un esempio di richiesta è il seguente:

{
   "status": "ACTIVE",
   "title": "Best video ever",
   "updateTime": "2019-01-24T01:30:15.01Z",
   "duration": "230s",
   "cuePoints": ["55.532s", "192s"],
   "publishTime": "2019-01-24T01:30:15.01Z",
   "thumbnailUrl": "http://www.domain.com/tn.jpg",
   "metadata": {
       "keyValues": {
           "category": "sports",
           "tag": ["soccer", "messi"],
       }
   }
}
Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

AdBreak

Metadati dell'interruzione pubblicitaria utilizzati per decidere quali annunci pubblicare durante un'interruzione pubblicitaria in un evento video dal vivo.

Campi
name

string

Solo output. Il nome della risorsa dell'interruzione pubblicitaria. Il formato di questo campo sarà "networks//assets//adBreaks/".

network_code è il codice di rete in Google Ad Manager a cui appartengono questi contenuti.

asset_key è la chiave dell'evento live streaming in Google Ad Manager in base alla quale è stata creata l'interruzione pubblicitaria.

ad_break_id è la chiave dell'interruzione pubblicitaria. SOLO USCITA.

expected_duration

Duration

Obbligatorio. Durata dell'interruzione prevista.

custom_params

string

Coppie chiave-valore da includere nelle richieste di annunci per questa interruzione per il targeting dei criteri personalizzati in Ad Manager. Esempio: "key1=value&key2=value2,value22"

scte_35_cue_out

string

Dati codificati in base 64 dal cue-out di scte35. Può includere il comando splice_insert() o time_signal(). Esempi: - con time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - con splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="

pod_template_name

string

Nome del modello pod di Google Ad Manager.

break_state

BreakState

Lo stato attuale dell'interruzione pubblicitaria.

BreakState

Lo stato di un'interruzione pubblicitaria.

Enum
BREAK_STATE_UNSPECIFIED Lo stato dell'interruzione pubblicitaria è sconosciuto.
BREAK_STATE_DECISIONED La decisione relativa all'interruzione pubblicitaria è stata avviata, ma non è ancora stata mostrata agli utenti.
BREAK_STATE_COMPLETE L'interruzione pubblicitaria è stata pubblicata per gli utenti.

ClosedCaptionFormat

I formati utilizzabili per i file dei sottotitoli codificati.

Enum
CLOSED_CAPTION_FORMAT_UNSPECIFIED Non è stato specificato il formato dei sottotitoli codificati.
TTML application/ttaf+xml
WEB_VTT text/vtt

ClosedCaptionUrlInfo

Metadati di un file di sottotitoli codificati.

Campi
language_code

string

Il codice lingua IETF BCP-47 che rappresenta la lingua del file dei sottotitoli codificati.

closed_caption_format

ClosedCaptionFormat

Il formato del file dei sottotitoli codificati.

url

string

L'URL del file dei sottotitoli codificati.

CreateAdBreakRequest

Richiesta per AdBreakNotificationService.CreateAdBreak.

Campi
parent

string

Questo campo identifica l'evento LiveStream a cui deve essere associata questa interruzione pubblicitaria utilizzando la chiave dell'asset del live streaming. Deve avere il formato "networks/{network_code}/assets/{asset_code}"

custom_parent

string

Questo campo identifica l'evento LiveStream a cui deve essere associata questa interruzione pubblicitaria utilizzando la chiave dell'asset personalizzato. Deve avere il formato "networks/{network_code}/customAssets/{asset_code}"

content

string

Questo è un modo alternativo per identificare LiveStreamEvent, se è associato a un contenuto all'interno di GAM. Deve avere il formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"

ad_break

AdBreak

Obbligatorio. L'interruzione pubblicitaria effettiva.

ad_break_id

string

Si tratta dell'id interruzione pubblicitaria che gli utenti possono fornire tramite la richiesta.

DynamicAdInsertionInfo

Informazioni relative all'inserimento di annunci dinamici.

Campi
video_ingest_url_info

VideoIngestUrlInfo

Un link al file principale m3u8 utilizzato per il condizionamento e la generazione di playlist.

media_update_time

Timestamp

L'ora dell'ultima modifica del file video a cui si fa riferimento in video_ingest_url_info.

closed_caption_url_info[]

ClosedCaptionUrlInfo

L'URL del file dei sottotitoli/sottotitoli codificati.

fw_caid

string

ID asset Freewheel personalizzato utilizzato per il targeting degli annunci.

GracenoteMetadata

I metadati Gracenote per i contenuti.

Campi
gracenote_id

string

Obbligatorio. Fa riferimento all'ID Gracenote per i contenuti. Deve avere uno di questi prefissi validi: 1. "EP": puntata di una serie 2. 'MV' - film 3. "SP" - evento sportivo

gracenote_series_id

string

(Facoltativo) Questo campo si riferisce all'ID della serie Gracenote. Deve essere preceduto dal prefisso "SH".

ListAdBreaksRequest

Richiesta per AdBreakNotificationService.ListAdBreaks.

Campi
parent

string

(Facoltativo) Questo campo identifica il LiveStreamEvent a cui l'interruzione pubblicitaria deve essere associata usando la chiave della risorsa live streaming. Deve essere nel formato "networks/{network_code}/assets/{asset_code}"

custom_parent

string

(Facoltativo) Questo campo identifica il LiveStreamEvent a cui deve essere associata l'interruzione pubblicitaria tramite la chiave asset personalizzata. Deve avere il formato "networks/{network_code}/customAssets/{asset_code}"

content

string

(Facoltativo) Questo è un modo alternativo per identificare LiveStreamEvent, se è associato a un contenuto all'interno di GAM. Deve avere il formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"

page_size

int32

(Facoltativo) Il numero massimo di interruzioni pubblicitarie da restituire. Il servizio potrebbe restituire meno di questo valore. Se non specificato, verranno restituite al massimo 10 interruzioni pubblicitarie. Il valore massimo è 100; i valori superiori a 100 verranno forzati a 100.

page_token

string

(Facoltativo) Un token di pagina ricevuto da una chiamata ListAdBreaks precedente. Forniscilo per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti a ListAdBreaks devono corrispondere alla chiamata che ha fornito il token della pagina.

ListAdBreaksResponse

Risposta per AdBreakNotificationService.ListAdBreaks.

Campi
ad_breaks[]

AdBreak

Solo output. Un elenco di interruzioni pubblicitarie corrispondenti all'evento LiveStreamEvent richiesto.

next_page_token

string

Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Metadati

Metadati personalizzati dei contenuti.

Campi
key_values

map<string, Value>

Identifica i metadati personalizzati dei contenuti come coppia chiave-valore. Per i valori sono accettate solo stringhe o elenchi di stringhe.

SyndicatedVideoContentNames

L'elenco dei nomi di tutti i contenuti sindacati.

Campi
syndicated_video_content[]

string

Campo ripetuto del nome dei contenuti sindacati. Devono avere il formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" e devono appartenere alla stessa rete dei contenuti che includono questo campo.

UpdateVideoContentRequest

Richiesta per [VideoContentIngestionService.UpdateVideoContentRequest][].

Campi
video_content

VideoContent

Obbligatorio. I metadati dei contenuti.

VideoContent

I metadati dei contenuti.

Campi
name

string

Solo output. Il nome risorsa dei contenuti video. Il formato di questo campo è: "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"

network_code è il codice di rete di Google Ad Manager a cui appartengono i contenuti.

content_source_id è l'ID origine di contenuto in Google Ad Manager a cui devono appartenere questi contenuti.

cms_content_id è l'ID dei contenuti CMS in Google Ad Manager, formato come parte della richiesta di annuncio per identificare quali annunci Ad Manager può pubblicare in base al corrispettivo video. Questo valore può essere numerico o alfanumerico.

status

VideoContentStatus

Lo stato dei contenuti. Se viene omesso, il valore predefinito sarà attivo.

title

string

Obbligatorio. Il titolo dei contenuti.

update_time

Timestamp

Obbligatorio. L'ora dell'ultima modifica dei contenuti.

publish_time

Timestamp

L'ora di pubblicazione dei contenuti. Questo campo è obbligatorio se il video è progettato per essere incluso in regole annunci che specificano un'ora di inizio e di fine.

duration

Duration

Durata dei contenuti. La durata è supportata fino al livello dei millisecondi.

cue_points[]

Duration

Identifica i cue point. I cue point sono punti temporali specifici in cui è possibile inserire un annuncio nel video. I cue point sono supportati fino al livello dei millisecondi. Questo è un campo obbligatorio se il video contiene interruzioni pubblicitarie mid-roll.

thumbnail_url

string

URL miniatura dei contenuti.

metadata

Metadata

Identifica i metadati personalizzati dei contenuti.

gracenote_metadata

GracenoteMetadata

Metadati dei contenuti correlati a Gracenote.

syndication_metadata

VideoContentSyndicationInfo

Metadati dei contenuti relativi alla syndication.

dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

Metadati dei contenuti correlati all'inserimento di annunci dinamici.

VideoContentStatus

Opzioni di stato per la pubblicazione o meno di annunci mirati per un contenuto.

Enum
ACTIVE Verranno pubblicati annunci con targeting per contenuti.
BLOCKED Se lo stato è BLOCCATO, non verranno pubblicati annunci su questi contenuti.
DELETED I contenuti verranno archiviati in Ad Manager. Se Ad Manager riceve una richiesta di annuncio per un contenuto contrassegnato come ELIMINATO, gli annunci autopromozionali o gli annunci indirizzati alle unità dell'inventario o ad altri criteri di targeting possono continuare a essere pubblicati in base a questi contenuti. Per bloccare gli annunci, imposta lo stato su BLOccato.

VideoContentSyndicationInfo

I metadati per specificare le relazioni tra contenuti canonici e contenuti sindacati.

Campi
Campo unione syndication. VideoContentSyndiationMetadata può contenere solo uno dei seguenti elementi. syndication può essere solo uno dei seguenti:
canonical_video_content

string

Il nome dei contenuti canonici. Deve essere nel formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" e devono appartenere alla stessa rete dei contenuti che includono questo campo.

syndicated_video_content_names

SyndicatedVideoContentNames

Una raccolta di contenuti distribuiti in syndication

VideoFormat

I formati in cui un contenuto video può essere codificato.

Enum
VIDEO_FORMAT_UNSPECIFIED Non è stato specificato il formato video.
HLS application/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

Metadati che specificano il link al file m3u8 utilizzato per il condizionamento e la generazione di playlist.

Campi
video_format

VideoFormat

Il formato del video.

video_preconditioned

VideoPreconditioned

Per indicare se i contenuti sono già condizionati per gli annunci mid-roll, il che significa che i segmenti sono già suddivisi al momento delle interruzioni pubblicitarie.

url

string

Il link al file m3u8.

VideoPreconditioned

Lo stato condizionato dei contenuti video.

Enum
NO Non ancora condizionato.
YES Il video è stato condizionato/diviso.