Używanie masek pól

Maski pól umożliwiają wywołującym interfejs API listę pól, które powinny zostać wysłane przez żądanie zwrócić lub zaktualizować aplikację. Za pomocą FieldMask umożliwia interfejsowi API unikanie zbędnej pracy i zwiększa wydajność. Maska pola jest używany zarówno do odczytu, jak i do metod aktualizacji w interfejsie API Prezentacji Google.

Odczyt z maską pola

Prezentacje mogą być duże i często nie potrzebujesz wszystkich części Presentation zasobu zwróconego przez żądanie odczytu. Możesz ograniczyć zakres informacji zwracanych w Odpowiedź interfejsu API Prezentacji wykorzystująca parametr adresu URL fields. Najlepszy wynik skuteczność reklam, wymieniać tylko te pola, których potrzebujesz. w odpowiedzi.

Format parametru pól jest taki sam jak Kodowanie JSON maski FieldMask. Krótko mówiąc: wiele różnych pól jest rozdzielonych przecinkami, a pola podrzędne są są rozdzielane kropkami. Nazwy pól można podawać w formacie camelCase lub separated_by_underscores. Dla wygody kilka pól podrzędnych z tego samego należy podać w nawiasach.

presentations.get: przykład żądania używa maski pola slides.pageElements(objectId,size,transform), aby pobrać tylko identyfikator obiektu, Size oraz Przekształć pageElement obiekt na wszystkich slajdach w prezentacji:

GET https://slides.googleapis.com/v1/presentations/presentationId?fields=slides.pageElements(objectId,size,transform)

Odpowiedź na wywołanie tej metody jest Presentation obiekt zawierającego komponenty żądane w masce pola:

{
  "slides": [
    {
      "pageElements": [
        {
          "objectId": "OBJECT_ID",
          "size": {
            "width": {
              "magnitude": 3000000,
              "unit": "EMU"
            },
            "height": {
              "magnitude": 3000000,
              "unit": "EMU"
            }
          },
          "transform": {
            "scaleX": 1,
            "scaleY": 1
            "translateX": 311708,
            "translateY": 744575,
            "unit": "EMU"
          }
        },
        {
          "objectId": "OBJECT_ID",
          "size": {
            "width": {
              "magnitude": 3000000,
              "unit": "EMU"
            },
            "height": {
              "magnitude": 3000000,
              "unit": "EMU"
            }
          },
          "transform": {
            "scaleX": 1,
            "scaleY": 1
            "translateX": 311700,
            "translateY": 2834125,
            "unit": "EMU"
          }
        }
     ]
    }
  ]
}

Zaktualizuj za pomocą maski pola

Czasami wystarczy zaktualizować tylko niektóre pola obiektu, pozostawiając nie zmieniono innych pól. Żądania aktualizacji w tagu presentations.batchUpdate operacji używają masek pól, aby informować interfejs API, które pola są zmieniane. żądanie aktualizacji ignoruje wszystkie pola, które nie zostały określone w masce pola, pozostawiając w nich obecne wartości.

Możesz też cofnąć ustawienie pola, nie określając go w zaktualizowanej wiadomości. przez dodanie pola do maski. Spowoduje to wyczyszczenie wartości pola poprzednio jakie mieliśmy.

Składnia masek pól aktualizacji jest taka sama jak masek do odczytu.

W poniższym przykładzie użyto parametru UpdateShapePropertiesRequest aby zmienić kolor wypełnienia kształtu na kolor motywu DARK1 i cofnąć ustawienie konspekt:

POST https://slides.googleapis.com/v1/presentations/presentationId:batchUpdate
{
  "requests": [
    {
      "updateShapeProperties": {
        "objectId": OBJECT_ID,
        "shapeProperties": {
          "shapeBackgroundFill": {
            "solidFill": {
              "color": {
                "themeColor": "DARK1"
              }
            }
          }
        },
        "fields": "shapeBackgroundFill.solidFill.color,outline"
      }
    }
  ]
}