Experiments: patch

Autorisierung erforderlich

Vorhandenen Test aktualisieren Diese Methode unterstützt die Patch-Semantik. Beispiel ansehen

Bei dieser Methode werden zusätzlich zu den Standardparametern die in der Parametertabelle aufgeführten Parameter unterstützt.

Anfragen

HTTP-Anfrage

PATCH https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId

Parameter

Parametername Wert Beschreibung
Pfadparameter
accountId string Konto-ID des zu aktualisierenden Tests.
experimentId string Test-ID des zu aktualisierenden Tests.
profileId string Datenansichts-ID (Profil) des zu aktualisierenden Tests.
webPropertyId string Web-Property-ID des zu aktualisierenden Tests.

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

Umfang
https://www.googleapis.com/auth/analytics
https://www.googleapis.com/auth/analytics.edit

Anfragetext

Geben Sie im Anfragetext die relevanten Teile einer management.experiment-Ressource gemäß den Regeln der Patch-Semantik mit den folgenden Attributen an:

Property-Name Wert Beschreibung Hinweise
Erforderliche Eigenschaften
id string Test-ID. Erforderlich für Patches und Updates. Kann nicht erstellt werden.
Optionale Attribute
description string Hinweise zu diesem Test. Bearbeitbar
editableInGaUi boolean Ist der Wert „true“, kann der Endnutzer den Test über die Google Analytics-Benutzeroberfläche bearbeiten. Bearbeitbar
equalWeighting boolean Boolescher Wert, der angibt, ob der Traffic gleichmäßig auf alle Variationen verteilt werden soll. Wenn der Wert „Falsch“ ist, wird für Content-Tests die Standardfunktionsweise verwendet, bei der die Zugriffe basierend auf der Leistung der Varianten dynamisch angepasst werden. Optional – der Standardwert ist „False“. Dieses Feld kann für einen Test mit dem Status ENDED (beendet) nicht geändert werden. Bearbeitbar
minimumExperimentLengthInDays integer Eine Ganzzahl in [3, 90]. Gibt die Mindestdauer des Tests an. Kann für einen laufenden Test geändert werden. Dieses Feld kann für einen Test mit dem Status ENDED (beendet) nicht geändert werden. Bearbeitbar
name string Testname. Dieses Feld kann für einen Test mit dem Status ENDED (beendet) nicht geändert werden. Dieses Feld ist beim Erstellen eines Tests erforderlich. Bearbeitbar
objectiveMetric string Der Messwert, der durch den Test optimiert wird. Gültige Werte: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:Bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". Dieses Feld ist erforderlich, wenn der Status "RUNNING" lautet und "asingFramework" entweder "REDIRECT" oder "API" lautet. Bearbeitbar
optimizationType string Gibt an, ob „objectMetric“ minimiert oder maximiert werden soll. Mögliche Werte: "MAXIMUM", "MINDEST". Optional: Der Standardwert ist „MAXIMUM“. Kann nicht ohne „objectMetric“ angegeben werden. Kann nicht geändert werden, wenn der Status „WIRD AUSGEFÜHRT“ oder „BEENDET“ ist. Bearbeitbar
rewriteVariationUrlsAsOriginal boolean Boolescher Wert, der angibt, ob URL-Varianten so umgeschrieben werden, dass sie denen des Originals entsprechen. Dieses Feld kann für einen Test mit dem Status ENDED (beendet) nicht geändert werden. Bearbeitbar
servingFramework string Das Framework, mit dem die Testvarianten bereitgestellt und die Ergebnisse ausgewertet werden. Eine der folgenden Möglichkeiten:
  • WEITERLEITUNG: Google Analytics leitet die Zugriffe auf verschiedene Variantenseiten weiter, meldet die ausgewählte Variante und wertet die Ergebnisse aus.
  • API: Google Analytics wählt die zu schaltende Variante aus und wertet sie aus. Der Aufrufer ist für die Bereitstellung der ausgewählten Variante verantwortlich.
  • EXTERN: Die Varianten werden extern geschaltet und die ausgewählte Variante an Google Analytics gemeldet. Der Aufrufer ist für die Bereitstellung der ausgewählten Variante und die Auswertung der Ergebnisse verantwortlich.
Bearbeitbar
status string Teststatus. Mögliche Werte: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Tests können im Status „DRAFT“, „READY_TO_RUN“ oder „RUNNING“ erstellt werden. Dieses Feld ist beim Erstellen eines Tests erforderlich. Bearbeitbar
trafficCoverage double Eine Gleitkommazahl zwischen 0 und 1. Gibt den Anteil der Zugriffe an, der am Test teilnimmt. Kann für einen laufenden Test geändert werden. Dieses Feld kann für einen Test mit dem Status ENDED (beendet) nicht geändert werden. Bearbeitbar
variations[] list Array mit Variationen. Die erste Variante im Array ist das Original. Die Anzahl der Varianten ändert sich möglicherweise nicht, wenn ein Test den Status WIRD AUSGEFÜHRT hat. Es sind mindestens zwei Varianten erforderlich, bevor der Status auf RUNNING gesetzt werden kann. Bearbeitbar
variations[].name string Der Name der Variante. Dieses Feld ist beim Erstellen eines Tests erforderlich. Dieses Feld kann für einen Test mit dem Status ENDED (beendet) nicht geändert werden. Bearbeitbar
variations[].status string Status der Variante. Mögliche Werte: "ACTIVE", "INACTIVE". INAKTIVE Varianten werden nicht ausgeliefert. Dieses Feld kann für einen Test mit dem Status ENDED (beendet) nicht geändert werden. Bearbeitbar
variations[].url string Die URL der Variante. Dieses Feld kann für einen Test mit dem Status WIRD AUSGEFÜHRT oder BEENDET nicht geändert werden. Bearbeitbar
winnerConfidenceLevel double Eine Gleitkommazahl zwischen 0 und 1. Gibt das Konfidenzniveau an, das zur Auswahl eines Testsiegers erforderlich ist. Dieses Feld kann für einen Test mit dem Status ENDED (beendet) nicht geändert werden. Bearbeitbar

Antwort

Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine Ressource vom Typ "management.experiment" im Antworttext zurückgegeben.

Beispiele

Hinweis: Bei den für diese Methode verfügbaren Codebeispielen sind nicht alle unterstützten Programmiersprachen vertreten. Eine Liste der unterstützten Sprachen finden Sie auf der Seite für Clientbibliotheken.

Java

Verwendet die Java-Clientbibliothek.

/*
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Experiments Developer Guide for details.
 */

// This example patches an existing experiment with new variations.
Variations variationA = new Variations();
variationA.setName("Home A");
variationA.setUrl("homeA.html");
Variations variationB = new Variations();
variationB.setName("Home B");
variationB.setUrl("homeB.html");
List<Variations> variations = Arrays.asList(variationA, variationB);

try {
  // First get an existing Experiment.
  Experiment body = analytics.management().experiments().get("123456",
      "UA-123456-1", "7654321", "122333444455555").execute();

  // Set the new variations.
  body.setVariations(variations);

  // Call Patch with the updated experiment.
  analytics.management().experiments().patch("123456", "UA-123456-1",
      "7654321", "12233344455555", body).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

PHP

Verwendet die PHP-Clientbibliothek.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Experiments Developer Guide for details.
 */

/**
 * This request patches an existing experiment.
 */

// Construct the first variation.
$variationA = new Google_Service_Analytics_ExperimentVariations();
$variationA->setName('VariationA');
$variationA->setUrl('index.html');

// Construct the second variation.
$variationB = new Google_Service_Analytics_ExperimentVariations();
$variationB->setName('VariationB');
$variationB->setUrl('indexB.html');

try {
  // Get an existing Experiment.
  $experiment = $analytics->management_experiments->get('123456',
      'UA-123456-1', '7654321', '122333444455555');

  // Set the new variations.
  $experiment->setVariations(array($variationA, $variationB));

  // Call the patch method with the updated experiment.
  $analytics->management_experiments->patch('123456', 'UA-123456-1',
      '7654321', '122333444455555', $experiment);
} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}


Python

Verwendet die Python-Clientbibliothek.

# Note: This code assumes you have an authorized Analytics service object.
# See the Experiments Developer Guide for details.

# This request patches an existing experiment with a new name,
# and new variations.
try:
  analytics.management().experiments().patch(
      accountId='123456',
      webPropertyId='UA-123456-1',
      profileId='7654321',
      experimentId='ABCDEFG123456abcdefg',
      body={
          'name': 'Landing Page Test April',
          'variations': [
              {
                  'name': 'First Variation',
                  'url': 'index.html'
              },
              {
                  'name': 'Proposed Change',
                  'url': 'indexB.html'
              }
          ]
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

JavaScript

Verwendet die JavaScript-Clientbibliothek.

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Experiments Developer Guide for details.
 */

/*
 * This request patches an existing experiment.
 */
function patchExperiment() {
  var request = gapi.client.analytics.management.experiments.patch(
    {
      'accountId': '123456',
      'webPropertyId': 'UA-123456-1',
      'profileId': '7654321',
      'experimentId': '122333444455555',
      'resource': {
        'name': 'Landing Page Test',
        'status': 'DRAFT',
        'variations': [
          {
            'name': 'VariationA',
            'url': 'index.html'
          },
          {
            'name': 'VariationB',
            'url': 'indexB.html'
          }
        ]
      }
    });
  request.execute(function (response) { // Handle the response. });
}