Risoluzione dei problemi

Video: guarda la discussione sulla gestione degli errori del workshop del 2019

Gli errori possono essere causati da una configurazione errata dell'ambiente, un bug tuo software o input non valido da parte di un utente. Qualunque sia la fonte, risolvere il problema e correggere il codice o aggiungere una logica per gestire l'errore dell'utente. Questa guida illustra alcune best practice per la risoluzione dei problemi gli errori dell'API Google Ads.

Garanzia della connettività

  1. Assicurati di avere accesso all'API Google Ads e di una configurazione corretta. Se le tue di risposta restituisce eventuali errori HTTP, assicurati di gestirli con attenzione e che stai raggiungendo i servizi che intendi usare dal tuo codice.

  2. Le tue credenziali sono incorporate nel tuo request per far sì che per autenticarti. Acquisisci familiarità con la struttura dell'API Google Ads richieste e risposte, soprattutto se gestirai chiamate senza utilizzando le librerie client. Ogni libreria client viene fornita con specifiche istruzioni su come includere le tue credenziali nel file di configurazione (consulta README della libreria client).

  3. Verifica di utilizzare le credenziali corrette. Le nostre Guida rapida ti guiderà nella procedura di acquisizione del l'insieme corretto di cui hai bisogno. Ad esempio, il seguente errore di risposta mostra che l'utente ha inviato credenziali di autenticazione non valide:

    {
      "error": {
        "code": 401,
        "message": "Request had invalid authentication credentials. Expected OAuth 2 access token, login cookie or other valid authentication credential. Visit https://developers.google.com/identity/sign-in/web/devconsole-project.",
        "status": "UNAUTHENTICATED",
        "details": [
          {
            "@type": "type.googleapis.com/google.rpc.DebugInfo",
            "detail": "Authentication error: 2"
          }
        ]
      }
    }
    

Se dopo aver seguito questi passaggi il problema persiste, è il momento di nella risoluzione degli errori dell'API Google Ads.

Determinazione del problema

L'API Google Ads generalmente segnala gli errori come oggetto JSON con errori, contenenti un elenco degli errori nella risposta. Questi oggetti forniscono un codice di errore un messaggio in cui vengono elaborati i motivi per cui è successo. Sono i primi segnali di cosa il problema.

{
  "errors": [
    {
      "errorCode": { "fieldMaskError": "FIELD_NOT_FOUND" },
      "message": "The field mask contained an invalid field: 'keyword/matchtype'.",
      "location": { "operationIndex": "1" }
    }
  ]
}

Tutte le nostre librerie client generano eccezioni. incapsulano gli errori nella risposta. L'acquisizione di queste eccezioni e stampare i messaggi in un registro o la schermata di risoluzione dei problemi è un ottimo modo per iniziare. L'integrazione di queste informazioni con gli altri eventi registrati nel tuo offre una buona panoramica di ciò che potrebbe provocare il problema. Una volta identificato l'errore nei log, dovrai capire quale significa.

Ricerca dell'errore

  1. Consulta la sezione sugli errori comuni. che descrive gli errori riscontrati più di frequente. it descrive il messaggio di errore, i riferimenti API pertinenti e come evitare o a gestire l'errore.

  2. Se la nostra documentazione sugli errori comuni non menziona l'errore in modo specifico, consulta la documentazione di riferimento e cerca la stringa di errore.

  3. Cerca nei nostri canali di assistenza per accedere ad altri che condividono la propria esperienza con l'API. Qualcun altro potrebbe avere hai trovato (e risolto) il tuo problema.

  4. Se si verificano errori non documentati, segnalali al la nostra attenzione nel forum.

  5. Vai al Centro assistenza Google Ads per ricevere assistenza nella risoluzione dei problemi di convalida o relativi ai limiti dell'account, L'API Google Ads eredita le regole e le limitazioni del prodotto Google Ads principale.

  6. Post del blog sarà a volte un buon riferimento per la risoluzione dei problemi della tua applicazione.

Dopo aver esaminato l'errore, è il momento di determinare la causa principale.

Individuare la causa

Controlla il messaggio di eccezione per determinare la causa dell'errore. Dopo la ricerca in seguito alla risposta, controlla se la richiesta è una possibile causa. Errore dell'API Google Ads i messaggi includono un elemento fieldPathElements nel campo location della GoogleAdsError, che indica dove nella richiesta in cui si è verificato l'errore. Ad esempio:

{
  "errors": [
    {
      "errorCode": {"criterionError": "CANNOT_ADD_CRITERIA_TYPE"},
      "message": "Criteria type can not be targeted.",
      "trigger": { "stringValue": "" },
      "location": {
        "operationIndex": "0",
        "fieldPathElements": [ { "fieldName": "keyword" } ]
      }
    }
  ]
}

Durante la risoluzione di un problema, è possibile che la tua applicazione fornisca le informazioni errate all'API. Ti consigliamo vivamente di utilizzare il ruolo ambiente di sviluppo (IDE), ad esempio Eclipse (un ambiente di sviluppo IDE open source e utilizzato principalmente per sviluppare Java, ma dispone di plug-in per in altre lingue) per facilitare il debug. Ti permette di impostare punti di interruzione e analizzerai il codice riga per riga.

Assicurati che la richiesta corrisponda agli input dell'applicazione (ad ad esempio il nome della campagna potrebbe non corrispondere alla richiesta). Assicurati che invii un maschera del campo che corrispondano agli aggiornamenti che vuoi apportare, l'API Google Ads supporta gli aggiornamenti sparsi. L'omissione di un campo dalla maschera del campo in una richiesta di modifica indica che l'API lasciamo perdere. Se l'applicazione recupera un oggetto, apporta una modifica, e lo restituisce, è possibile che tu stia scrivendo in un campo che non supporta l'aggiornamento. Verifica la descrizione del campo nella sezione Riferimento documentazione per verificare se esistono limitazioni relative a quando e se aggiornare il campo.

Come ricevere assistenza

Non è sempre possibile identificare e risolvere il problema in autonomia. porre domande sul forum espone la tua domanda a migliaia di sviluppatori che potrebbero aver dovuto affrontare problema.

Cerca di includere il maggior numero possibile di informazioni nelle query. Gli elementi consigliati includono:

  • Richiesta e risposta JSON convalidate. Assicurati di rimuovere le informazioni sensibili informazioni come il tuo token sviluppatore o AuthToken.
  • Snippet di codice. Se hai un problema specifico di una lingua o richiedere assistenza per l'utilizzo dell'API, includi uno snippet di codice per a spiegare cosa stai facendo.
  • ID richiesta. Ciò consente ai membri del team Relazioni con gli sviluppatori di Google di individuare se effettuata nell'ambiente di produzione. Me ti consigliamo di registrare nei log il valore requestId incluso come proprietà in le eccezioni che incapsulano gli errori di risposta e ulteriore contesto rispetto al solo requestId.
  • Informazioni aggiuntive, come la versione del runtime/interprete e può essere utile anche per la risoluzione dei problemi.

Risolvere il problema

Ora che hai capito il problema e trovato una soluzione, è il momento per apportare la modifica e testare la correzione con un account di prova (opzione preferita) oppure produzione (se il bug si applica solo ai dati di uno specifico account di produzione).

Valuta la possibilità di condividere

Se hai pubblicato nel forum una domanda relativa a un errore che non è stato visualizzato in precedenza e hai trovato la soluzione, valuta la possibilità di aggiungerla . La prossima volta che uno sviluppatore avrà lo stesso problema, sarà in grado di risolverlo immediatamente.

Passaggi successivi

Ora che hai risolto il problema, hai notato un modo per migliorare il tuo un codice per evitarlo in primo luogo?

La creazione di una buona serie di test delle unità aiuta a migliorare la qualità e l'affidabilità del codice considerevolmente. Inoltre velocizza il processo di test delle nuove modifiche per garantire non hanno interrotto la funzionalità precedente. Un'ottima strategia di gestione degli errori è anche per visualizzare tutti i dati necessari per la risoluzione dei problemi.