Package google.ads.drx.video.v1

Indice

Servizio Notifica annunci

Servizio API che consente ai publisher di creare interruzioni pubblicitarie in un live streaming.

Creazione interruzione pubblicitaria

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

API per creare un'interruzione pubblicitaria durante il 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.

Interruzione dell'elenco annunci

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.

Servizio di importazione di contenuti video

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

Aggiorna contenuti video

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

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

Una richiesta di esempio ha il seguente aspetto:

{
   "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

I metadati delle interruzioni pubblicitarie utilizzati per decidere gli annunci per 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 è "networks//assets//adBreaks/".

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

asset_key è la chiave dell'evento di live streaming in Gestione degli annunci Google con cui è stata creata l'interruzione pubblicitaria.

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

expected_duration

Duration

Obbligatorio. Durata prevista dell'interruzione.

custom_params

string

Le 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+/+c2nALv4AUsz1AAAAAAAKB="

pod_template_name

string

Nome del modello di pod di Google Ad Manager.

break_state

BreakState

Lo stato attuale dell'interruzione pubblicitaria.

Statodiinterruzione

Lo stato di un'interruzione pubblicitaria.

Enum
BREAK_STATE_UNSPECIFIED Lo stato dell'interruzione pubblicitaria è sconosciuto.
BREAK_STATE_DECISIONED La decisione dell'interruzione pubblicitaria è iniziata, ma non è ancora stata mostrata agli utenti.
BREAK_STATE_COMPLETE L'interruzione pubblicitaria è stata mostrata agli utenti.

Formato sottotitoli codificati

I formati dei file di sottotitoli codificati.

Enum
CLOSED_CAPTION_FORMAT_UNSPECIFIED Il formato dei sottotitoli codificati non è stato specificato.
TTML applicazione/ttaf+xml
WEB_VTT testo/vtt

InformazioniUrlUrlChiuso

I metadati per un file di sottotitoli codificati.

Campi
language_code

string

Il codice lingua IETF BCP-47 che rappresenta la lingua in cui si trova il file dei sottotitoli codificati.

closed_caption_format

ClosedCaptionFormat

Il formato del file dei sottotitoli codificati.

url

string

L'URL del file dei sottotitoli codificati.

Crea richiesta di interruzione pubblicitaria

Richiesta di AdBreakNotificationService.CreateAdBreak.

Campi
parent

string

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

custom_parent

string

Questo campo identifica l'evento LiveStreamEvent a cui deve essere associata questa interruzione pubblicitaria utilizzando la chiave asset personalizzata. Deve essere nel formato "networks/{network_code}/customAssets/{asset_code}"

content

string

Si tratta di un modo alternativo per identificare l'evento LiveStreamEvent, se è associato a un contenuto all'interno di GAM. Deve essere nel formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"

ad_break

AdBreak

Obbligatorio. L'effettiva interruzione pubblicitaria.

ad_break_id

string

Si tratta dell'ad_break_id che gli utenti possono fornire tramite la richiesta.

Informazioni su annunci dinamici

Informazioni relative all'inserimento di annunci dinamici.

Campi
video_ingest_url_info

VideoIngestUrlInfo

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

media_update_time

Timestamp

La data e 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.

Metadati di Gracenote

I metadati di Gracenote per i contenuti.

Campi
gracenote_id

string

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

gracenote_series_id

string

Campo facoltativo. Questo campo fa riferimento all'ID della serie Gracenote. Deve essere preceduta da "SH".

Richiesta di interruzione dell'annuncio

Richiesta di AdBreakNotificationService.ListAdBreaks.

Campi
parent

string

Campo facoltativo. Questo campo identifica l'evento LiveStreamEvent a cui deve essere associata questa interruzione pubblicitaria utilizzando la chiave asset live streaming. Deve essere nel formato "networks/{network_code}/assets/{asset_code}"

custom_parent

string

Campo facoltativo. Questo campo identifica l'evento LiveStreamEvent a cui deve essere associata questa interruzione pubblicitaria utilizzando la chiave asset personalizzata. Deve essere nel formato "networks/{network_code}/customAssets/{asset_code}"

content

string

Campo facoltativo. Si tratta di un modo alternativo per identificare l'evento LiveStreamEvent, se è associato a un contenuto all'interno di GAM. Deve essere nel formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"

page_size

int32

Campo facoltativo. Il numero massimo di interruzioni pubblicitarie da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore. Se il valore non è specificato, vengono restituite al massimo 10 interruzioni pubblicitarie. Il valore massimo è 100; i valori superiori a 100 saranno forzati a 100.

page_token

string

Campo 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 di pagina.

Elenco AdBreaksResponse

Risposta per AdBreakNotificationService.ListAdBreaks.

Campi
ad_breaks[]

AdBreak

Solo output. Un elenco di interruzioni pubblicitarie che corrispondono al 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 accettati solo stringhe o un elenco di stringhe.

Nomi contenuti video Syndicated

L'elenco dei nomi di tutti i contenuti distribuiti in syndication.

Campi
syndicated_video_content[]

string

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

Aggiornamento richiesta di contenuti video

Richiesta di [VideoContentIngestionService.UpdateVideoContentRequest][].

Campi
video_content

VideoContent

Obbligatorio. I metadati dei contenuti.

VideoContent

I metadati dei contenuti.

Campi
name

string

Solo output. Il nome della 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 in Google Ad Manager a cui appartengono i contenuti.

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

cms_content_id è l'ID contenuto CMS in Google Ad Manager, formato nell'ambito della richiesta di annuncio per identificare quali annunci Ad Manager può pubblicare in base al video corrispondente. Questo valore può essere un valore numerico o alfanumerico.

status

VideoContentStatus

Lo stato dei contenuti. Se ometti questo valore, 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 è un campo obbligatorio se il video è progettato per essere incluso nelle regole per gli annunci che specificano un'ora di inizio e di fine.

duration

Duration

Durata dei contenuti. La durata è supportata fino al livello in 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 in millisecondi. Questo è un campo obbligatorio, se il video contiene interruzioni pubblicitarie mid-roll.

thumbnail_url

string

URL miniatura del contenuto.

metadata

Metadata

Identifica i metadati personalizzati dei contenuti.

gracenote_metadata

GracenoteMetadata

Metadati relativi ai contenuti di Gracenote dei contenuti.

syndication_metadata

VideoContentSyndicationInfo

Metadati dei contenuti correlati alla syndication.

dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

Metadati correlati all'inserimento di annunci dinamici nei contenuti.

Stato contenuti video

Opzioni di stato per pubblicare o non pubblicare annunci mirati per un contenuto.

Enum
ACTIVE Verranno pubblicati annunci con targeting dei 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 a unità dell'inventario o altri criteri di targeting possono comunque essere pubblicati per questo contenuto. Per bloccare gli annunci, imposta lo stato su BLOCCATO.

Informazioni VideoVideoSyndication

I metadati per specificare le relazioni tra i contenuti canonici e i contenuti distribuiti in syndication.

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 deve appartenere alla stessa rete dei contenuti contenenti questo campo.

syndicated_video_content_names

SyndicatedVideoContentNames

Una raccolta di contenuti distribuiti in syndication

Formato video

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

Enum
VIDEO_FORMAT_UNSPECIFIED Il formato video non è stato specificato.
HLS applicazione/x-mpegURL
DASH applicazione/trattino+xml

Informazioni URL Video Ingest

I metadati che specificano il link al file m3u8 utilizzato per condizionare e generare 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, significa che i segmenti sono già divisi al momento delle interruzioni pubblicitarie.

url

string

Il link al file m3u8.

Videoprecondizionato

Lo stato condizionato dei contenuti video.

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